com.whitestein.lsps.vaadin.forms

Class WComponentGroup

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WComponentGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

WCssLayout, WGridLayout, WOrderedComponentGroup, WTabSheet

public abstract class WComponentGroup
extends FormComponent

Author:

mvy

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
WComponentGroup()

Method Summary

Modifier and Type	Method and Description
void	addComponent(RecordHolder child) Adds a component to this component group.
protected FormComponent	addComponentInt(RecordHolder child) Internally registers the component but does not call getWidget().addComponent().
protected abstract com.vaadin.ui.AbstractComponentContainer	createWidget() Called once, to create the actual Vaadin component.
protected List<FormComponent>	getChildren()
RecordHolder	getComponentAt(Decimal index) Gets a child component at the specified index.
Decimal	getComponentCount() Gets the count of child components contained in this component group.
ListHolder	getComponents() Gets all components from this component group.
Decimal	getExpandRatio(RecordHolder child) Gets the expand ratio of the child component.
IHasChildren	getHasChildrenAdapter() Provides an adapter of this component which allows easily invoke methods on the forms::HasChildren interface.
com.vaadin.ui.AbstractComponentContainer	getWidget() Gets the Vaadin representation of this component.
boolean	isMargin() Checks the value of the margin flag.
boolean	isSpacing() Checks the value of the spacing flag.
void	removeAllComponents() Removes all components from this component group.
void	removeComponent(RecordHolder child) Removes the child component from this component group.
protected void	restoreChildComponents(Map<String,Object> state) Restores the child components from the internal state.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setExpandRatio(RecordHolder child, Decimal ratio) Sets the expand ration of the component.
void	setMargin(boolean margin) Sets the margin flag to the component groups.
void	setSpacing(boolean spacing) Sets a spacing flag to this component group.
protected void	writeChildComponents(Map<String,Object> state) Stores the child components to the internal state.
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, 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

WComponentGroup

public WComponentGroup()

Method Detail

getChildren

protected List<FormComponent> getChildren()

createWidget

protected abstract com.vaadin.ui.AbstractComponentContainer 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.AbstractComponentContainer 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.

addComponentInt

protected FormComponent addComponentInt(RecordHolder child)

Internally registers the component but does not call getWidget().addComponent(). Use when the component have to be added in a special way.

Parameters:

child - the child, not null.

Returns:

created component, not null.

addComponent

public void addComponent(RecordHolder child)

Adds a component to this component group.

Parameters:

child - the child component to add

getComponentAt

public RecordHolder getComponentAt(Decimal index)

Gets a child component at the specified index.

Parameters:

index - the index of the component to get.

Returns:

a child component at the given index.

getComponentCount

public Decimal getComponentCount()

Gets the count of child components contained in this component group.

Returns:

a child component count

removeComponent

public void removeComponent(RecordHolder child)

Removes the child component from this component group.

Parameters:

child - the component to remove

removeAllComponents

public void removeAllComponents()

Removes all components from this component group.

getComponents

public ListHolder getComponents()

Gets all components from this component group.

Returns:

a list of components

setSpacing

public void setSpacing(boolean spacing)

Sets a spacing flag to this component group. Calling this method has no effect if the widget representation of this component group does not implement Layout.SpacingHandler interface.

Parameters:

spacing - the value of the flag to set

isSpacing

public boolean isSpacing()

Checks the value of the spacing flag.

Returns:

true if the widget is a Layout.SpacingHandler and has the spacing flag set.

setMargin

public void setMargin(boolean margin)

Sets the margin flag to the component groups. Calling this method has no effect if the widget representation of this component group does not implement Layout.MarginHandler interface.

Parameters:

margin -

isMargin

public boolean isMargin()

Checks the value of the margin flag.

Returns:

true if the widget is a Layout.MarginHandler and has the margin flag set.

setExpandRatio

public void setExpandRatio(RecordHolder child,
                           Decimal ratio)

Sets the expand ration of the component.

Parameters:

child -

ratio -

getExpandRatio

public Decimal getExpandRatio(RecordHolder child)

Gets the expand ratio of the child component.

Parameters:

child -

Returns:

the expand ratio of the child component.

getHasChildrenAdapter

public IHasChildren getHasChildrenAdapter()

Description copied from class: FormComponent

Provides an adapter of this component which allows easily invoke methods on the forms::HasChildren interface. If this component does not implement the interface then and adapter returning no children is returned.

Overrides:

getHasChildrenAdapter in class FormComponent

Returns:

adapter of this component which implements the IHasChildren interface, never null.

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)

writeChildComponents

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

Stores the child components to the internal state. Subclasses which represent more complex layout should override this method and along with the component to store any layout related information as well. The same value type restrictions apply as for the writeInternalState(Map).

Subclasses overriding this method should also override restoreChildComponents(Map).

Parameters:

state - the map where to store the state

restoreChildComponents

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

Restores the child components from the internal state.

Parameters:

state - the internal UI state

See Also:

writeChildComponents(Map)