com.whitestein.lsps.vaadin.forms

Class WGridLayout

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WComponentGroup

com.whitestein.lsps.vaadin.forms.WGridLayout

All Implemented Interfaces:

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

public class WGridLayout
extends WComponentGroup

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

Method Summary

Modifier and Type	Method and Description
void	addComponentToGrid(RecordHolder child, Decimal column, Decimal row, Decimal columnSpan, Decimal rowSpan) Adds a component to the grid.
protected com.vaadin.ui.AbstractComponentContainer	createWidget() Called once, to create the actual Vaadin component.
Decimal	getColumnExpandRatio(Decimal columnIndex) Gets expand ratio of a given column
Decimal	getColumns() Gets the number of columns in the grid layout.
RecordHolder	getComponent(Decimal column, Decimal row) Gets a component which occupies the given position in the grid.
Decimal	getRowExpandRatio(Decimal rowIndex) Gets expand ratio of a given row.
Decimal	getRows() Gets the number of rows in the grid.
com.vaadin.ui.GridLayout	getWidget() Gets the Vaadin representation of this component.
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	setColumnExpandRatio(Decimal columnIndex, Decimal ratio) Sets expand ratio of a given column.
void	setColumns(Decimal columns) Sets the number of columns of the grid.
void	setRowExpandRatio(Decimal rowIndex, Decimal ratio) Sets expand ratio of a given row.
void	setRows(Decimal rows) Sets the number of rows of the grid.
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.WComponentGroup

addComponent, addComponentInt, getChildren, getComponentAt, getComponentCount, getComponents, getExpandRatio, getHasChildrenAdapter, isMargin, isSpacing, removeAllComponents, removeComponent, setExpandRatio, setMargin, setSpacing

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

WGridLayout

public WGridLayout()

Method Detail

createWidget

protected com.vaadin.ui.AbstractComponentContainer createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WComponentGroup

Returns:

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

addComponentToGrid

public void addComponentToGrid(RecordHolder child,
                               Decimal column,
                               Decimal row,
                               Decimal columnSpan,
                               Decimal rowSpan)

Adds a component to the grid.

Parameters:

child - the component to add

column - the column index

row - the row index

columnSpan - column span

rowSpan - row span

getWidget

public com.vaadin.ui.GridLayout getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WComponentGroup

Returns:

the Vaadin representation of this form component.

getColumns

public Decimal getColumns()

Gets the number of columns in the grid layout.

Returns:

number of columns

setColumns

public void setColumns(Decimal columns)

Sets the number of columns of the grid.

Parameters:

columns -

getRows

public Decimal getRows()

Gets the number of rows in the grid.

Returns:

the number of rows

setRows

public void setRows(Decimal rows)

Sets the number of rows of the grid.

Parameters:

rows -

setColumnExpandRatio

public void setColumnExpandRatio(Decimal columnIndex,
                                 Decimal ratio)

Sets expand ratio of a given column.

Parameters:

columnIndex - the column index

ratio - the ratio

getColumnExpandRatio

public Decimal getColumnExpandRatio(Decimal columnIndex)

Gets expand ratio of a given column

Parameters:

columnIndex - the column index

Returns:

the expand ratio

setRowExpandRatio

public void setRowExpandRatio(Decimal rowIndex,
                              Decimal ratio)

Sets expand ratio of a given row.

Parameters:

rowIndex - the row index

ratio - the expand ratio

getRowExpandRatio

public Decimal getRowExpandRatio(Decimal rowIndex)

Gets expand ratio of a given row.

Parameters:

rowIndex -

Returns:

the expand ratio of the given row

getComponent

public RecordHolder getComponent(Decimal column,
                                 Decimal row)

Gets a component which occupies the given position in the grid.

Parameters:

column - the column index

row - the row index

Returns:

a component

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 WComponentGroup

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 WComponentGroup

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

writeChildComponents

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

Description copied from class: WComponentGroup

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 WComponentGroup.writeInternalState(Map).

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

Overrides:

writeChildComponents in class WComponentGroup

Parameters:

state - the map where to store the state

restoreChildComponents

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

Description copied from class: WComponentGroup

Restores the child components from the internal state.

Overrides:

restoreChildComponents in class WComponentGroup

Parameters:

state - the internal UI state

See Also:

WComponentGroup.writeChildComponents(Map)