com.whitestein.lsps.vaadin.forms

Class WAbstractSplitPanel

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WAbstractSplitPanel

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

Direct Known Subclasses:

WHorizontalSplitPanel, WVerticalSplitPanel

public abstract class WAbstractSplitPanel
extends FormComponent

Author:

mna

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WAbstractSplitPanel()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeListener	createSplitPositionListener()
protected abstract com.vaadin.ui.AbstractSplitPanel	createWidget() Called once, to create the actual Vaadin component.
ListHolder	getComponents() Gets all components from this component group.
RecordHolder	getFirstComponent() See corresponding lsps api.
Decimal	getMaxSplitPosition() Currently used only in test.
EnumerationImpl	getMaxSplitPositionUnit() Currently used only in test.
Decimal	getMinSplitPosition() Currently used only in test.
EnumerationImpl	getMinSplitPositionUnit() Currently used only in test.
RecordHolder	getSecondComponent() See corresponding lsps api.
Decimal	getSplitPosition() Currently used only in test.
EnumerationImpl	getSplitPositionUnit() Currently used only in test.
com.vaadin.ui.AbstractSplitPanel	getWidget() Gets the Vaadin representation of this component.
boolean	isLocked() See corresponding lsps api.
boolean	isSplitPositionReversed() See corresponding lsps api.
protected void	onSplitPositionChanged(float splitPosition, com.vaadin.server.Sizeable.Unit splitPositionUnit, boolean isReversed)
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setFirstComponent(RecordHolder child) See corresponding lsps api.
void	setLocked(boolean locked) See corresponding lsps api.
void	setMaxSplitPosition(Decimal position, EnumerationImpl unit) See corresponding lsps api.
void	setMinSplitPosition(Decimal position, EnumerationImpl unit) See corresponding lsps api.
void	setSecondComponent(RecordHolder child) See corresponding lsps api.
void	setSplitPosition(Decimal position, EnumerationImpl unit) See corresponding lsps api.
void	setSplitPosition(Decimal position, EnumerationImpl unit, boolean reverse) See corresponding lsps api.
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, preventGC, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WAbstractSplitPanel

public WAbstractSplitPanel()

Method Detail

createWidget

protected abstract com.vaadin.ui.AbstractSplitPanel createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public com.vaadin.ui.AbstractSplitPanel getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

getFirstComponent

public RecordHolder getFirstComponent()

See corresponding lsps api.

setFirstComponent

public void setFirstComponent(RecordHolder child)

See corresponding lsps api.

getSecondComponent

public RecordHolder getSecondComponent()

See corresponding lsps api.

setSecondComponent

public void setSecondComponent(RecordHolder child)

See corresponding lsps api.

isLocked

public boolean isLocked()

See corresponding lsps api.

setLocked

public void setLocked(boolean locked)

See corresponding lsps api.

setSplitPosition

public void setSplitPosition(Decimal position,
                             EnumerationImpl unit)

See corresponding lsps api.

setSplitPosition

public void setSplitPosition(Decimal position,
                             EnumerationImpl unit,
                             boolean reverse)

See corresponding lsps api.

getSplitPosition

public Decimal getSplitPosition()

Currently used only in test.

getSplitPositionUnit

public EnumerationImpl getSplitPositionUnit()

Currently used only in test.

setMinSplitPosition

public void setMinSplitPosition(Decimal position,
                                EnumerationImpl unit)

See corresponding lsps api.

getMinSplitPosition

public Decimal getMinSplitPosition()

Currently used only in test.

getMinSplitPositionUnit

public EnumerationImpl getMinSplitPositionUnit()

Currently used only in test.

setMaxSplitPosition

public void setMaxSplitPosition(Decimal position,
                                EnumerationImpl unit)

See corresponding lsps api.

getMaxSplitPosition

public Decimal getMaxSplitPosition()

Currently used only in test.

getMaxSplitPositionUnit

public EnumerationImpl getMaxSplitPositionUnit()

Currently used only in test.

isSplitPositionReversed

public boolean isSplitPositionReversed()

See corresponding lsps api.

getComponents

public ListHolder getComponents()

Gets all components from this component group.

Returns:

a list of components

createSplitPositionListener

protected com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeListener createSplitPositionListener()

onSplitPositionChanged

protected void onSplitPositionChanged(float splitPosition,
                                      com.vaadin.server.Sizeable.Unit splitPositionUnit,
                                      boolean isReversed)

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class FormComponent

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)