com.whitestein.lsps.vaadin.forms

Class WGrid

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WGrid

All Implemented Interfaces:

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

public class WGrid
extends FormComponent
implements IVaadinContainerDataSourceAdapter.FilterConfigProvider

Represents Vaadin Grid, backed by forms::DataSource.

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WGrid.ColumnResizeListenerImpl A table column resize listener which delegates the resize event to the wrapped closure.
protected class	WGrid.RowStyleGeneratorImpl
static class	WGrid.WRendererClickListener Clickable renderer listener.

Field Summary

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

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.whitestein.lsps.vaadin.forms.datasource.IVaadinContainerDataSourceAdapter.FilterConfigProvider

EMPTY

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

attachMethod

Constructor Summary

Constructors

Constructor and Description
WGrid()

Method Summary

Modifier and Type	Method and Description
void	addColumn(RecordHolder gridColumn) Registers a new column.
void	clearCellErrors() Clears any potential cell errors.
EnumerationImpl	columnGetAlignment(RecordHolder column) Gets the column alignment
Decimal	columnGetExpandRatio(RecordHolder column) Gets the expand ratio of a grid column.
RecordHolder	columnGetFilterConfig(RecordHolder column) Gets the filter configuration of a given column.
String	columnGetHeader(RecordHolder column) Gets the grid column header.
EnumerationImpl	columnGetHeaderAlignment(RecordHolder column) Gets the column header text alignment.
String	columnGetHeaderStyleName(RecordHolder column) Gets the column header style name
boolean	columnGetHidable(RecordHolder column) Gets the column's hidable flag.
String	columnGetHidingToggleCaption(RecordHolder column) Gets the grid column's hiding toggle caption.
Decimal	columnGetMaximumWidth(RecordHolder column) Gets a maximum width of a column.
Decimal	columnGetMinimumWidth(RecordHolder column) Gets the column's minimum width in pixels.
Decimal	columnGetWidth(RecordHolder column) Gets the grid column's width.
boolean	columnIsFiltrable(RecordHolder column) Gets the filterable flag of a grid column.
boolean	columnIsHidden(RecordHolder column) Gets the column's hidden flag.
boolean	columnIsResizable(RecordHolder column) Gets the value of the resizable flag of a grid column.
void	columnRemove(RecordHolder gridColumn) Removes the column from the grid.
void	columnSetAlignment(RecordHolder column, EnumerationImpl alignment) Sets the column alignment.
void	columnSetExpandRatio(RecordHolder column, Decimal expandRatio) Sets expand ratio to a grid column.
void	columnSetFilterConfig(RecordHolder column, RecordHolder filterConfig) Sets a filter configuration to a given column.
void	columnSetFiltrable(RecordHolder column, boolean filtrable) Sets the filterable flag to a grid column.
void	columnSetHeader(RecordHolder column, String header) Sets the grid column header.
void	columnSetHeaderAlignment(RecordHolder column, EnumerationImpl alignment) Sets the column header alignment
void	columnSetHeaderStyleName(RecordHolder column, String styleName)
void	columnSetHidable(RecordHolder column, boolean hidable) Set's the columns hidable flag.
void	columnSetHidden(RecordHolder column, boolean hidden) Sets the column's hidden flag.
void	columnSetHidingToggleCaption(RecordHolder column, String hidingToggleCaption) Sets the gird column's hiding toggle caption
void	columnSetMaximumWidth(RecordHolder column, Decimal pixels) Sets a maximum width to a grid column.
void	columnSetMinimumWidth(RecordHolder column, Decimal pixels) Sets a grid columns minimum width.
void	columnSetResizable(RecordHolder column, boolean resizable) Sets the resizable flag of the grid column.
void	columnSetWidth(RecordHolder column, Decimal pixelWidth) Sets the width of a grid column.
protected com.vaadin.ui.Grid	createWidget() Called once, to create the actual Vaadin component.
ListHolder	getColumns() Gets a list of column definitions of this grid.
RecordHolder	getDataSource() Gets the definition of the currently used data source.
Object	getFilterId(Object propertyId) Returns filter id which will be assigned to filters on this property.
Decimal	getFrozenColumnCount() Gets the number of frozen columns of this grid.
Decimal	getHeightByRows() Gets the amount of rows in the grid body that are shown if the height mode is ROW.
Object	getRowObjectForItemId(Serializable itemId) Returns the row object for given row ID.
ListHolder	getSelection() Gets list of row objects of the selected rows.
ClosureHolder	getSelectionChangeListener() Gets the the current selection change listener.
EnumerationImpl	getSelectionMode()
com.vaadin.ui.Grid	getWidget() Gets the Vaadin representation of this component.
boolean	isSelectable() Indicates if the rows in the grids are selectable.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	refresh() Refreshes the content.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	select(CollectionHolder rowObjects) Changes grid selection.
void	setColumnResizeListener(ClosureHolder listener) Sets a column resize listener to this grid.
void	setDataSource(RecordHolder ds) Sets the data source to this grid.
void	setEditorBuffered(Boolean editorBuffered) Sets the editor buffered support.
void	setEditorEnabled(Boolean enabled) Sets the editor support enabled flag.
void	setFrozenColumnCount(Decimal numberOfColumns) Sets the number of frozen columns of this grid.
void	setHeightByRows(Decimal heightByRows) Sets the amount of rows in teh grid body that are shown.
void	setRowStyleGenerator(ClosureHolder styleGenerator) Sets the style generator that is used for generating styles for rows.
void	setSelectable(boolean selectable) Deprecated.
void	setSelectionChangeListener(ClosureHolder listener) Sets the selection change listener.
void	setSelectionMode(EnumerationImpl selectionMode) Sets selection mode.
List<ConstraintViolation>	showCellErrors(Collection<ConstraintViolation> constraintViolations) Shows cell errors in cells displaying value of a record property equivalent with the constraint violation record property.
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, 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

WGrid

public WGrid()

Method Detail

createWidget

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

getDataSource

public RecordHolder getDataSource()

Gets the definition of the currently used data source.

Returns:

the data source definition or null if the currently used data source is not backed by forms::DataSource.

setDataSource

public void setDataSource(RecordHolder ds)

Sets the data source to this grid.

Parameters:

ds - a record of type forms::DataSource representing the data source.

refresh

public void refresh()

Refreshes the content. Ask the data source to refresh its content.

addColumn

public void addColumn(RecordHolder gridColumn)

Registers a new column.

Parameters:

gridColumn - forms::GridColumn

columnRemove

public void columnRemove(RecordHolder gridColumn)

Removes the column from the grid.

Parameters:

gridColumn - the grid to remove

getFilterId

public Object getFilterId(Object propertyId)

Description copied from interface: IVaadinContainerDataSourceAdapter.FilterConfigProvider

Returns filter id which will be assigned to filters on this property.

Specified by:

getFilterId in interface IVaadinContainerDataSourceAdapter.FilterConfigProvider

Returns:

filterId

getRowObjectForItemId

public Object getRowObjectForItemId(Serializable itemId)

Returns the row object for given row ID. Used by renderers, for example to identify which row object has been clicked upon.

Parameters:

itemId - Vaadin itemId.

Returns:

row object, may be null.

getWidget

public com.vaadin.ui.Grid 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.

setFrozenColumnCount

public void setFrozenColumnCount(Decimal numberOfColumns)

Sets the number of frozen columns of this grid.

Parameters:

numberOfColumns -

getFrozenColumnCount

public Decimal getFrozenColumnCount()

Gets the number of frozen columns of this grid.

Returns:

the number of frozen columns.

columnSetFiltrable

public void columnSetFiltrable(RecordHolder column,
                               boolean filtrable)

Sets the filterable flag to a grid column.

Parameters:

column - the column definition which identifies the grid column

filtrable -

columnIsFiltrable

public boolean columnIsFiltrable(RecordHolder column)

Gets the filterable flag of a grid column.

Parameters:

column - the column definition which identifies the grid column

Returns:

the filterable flag value

columnSetFilterConfig

public void columnSetFilterConfig(RecordHolder column,
                                  RecordHolder filterConfig)

Sets a filter configuration to a given column.

Parameters:

column - the column

filterConfig - the filter configuration

columnGetFilterConfig

public RecordHolder columnGetFilterConfig(RecordHolder column)

Gets the filter configuration of a given column.

Parameters:

column - the column

Returns:

a filter configuration of the column or null if the column has no filter configuration

columnSetHeader

public void columnSetHeader(RecordHolder column,
                            String header)

Sets the grid column header.

Parameters:

column - the column definition which identifies the grid column

header -

columnGetHeader

public String columnGetHeader(RecordHolder column)

Gets the grid column header.

Parameters:

column - the column definition which identifies the grid column

Returns:

the column header

columnGetHidingToggleCaption

public String columnGetHidingToggleCaption(RecordHolder column)

Gets the grid column's hiding toggle caption.

Parameters:

column - the column definition which identifies the grid column

Returns:

hiding toggel caption

columnSetHidingToggleCaption

public void columnSetHidingToggleCaption(RecordHolder column,
                                         String hidingToggleCaption)

Sets the gird column's hiding toggle caption

Parameters:

column - the column definition which identifies the grid column

hidingToggleCaption - the caption to set

columnGetWidth

public Decimal columnGetWidth(RecordHolder column)

Gets the grid column's width.

Parameters:

column - the column definition which identifies the grid column

Returns:

the column's width

columnSetWidth

public void columnSetWidth(RecordHolder column,
                           Decimal pixelWidth)

Sets the width of a grid column.

Parameters:

column - the column definition which identifies the grid column

pixelWidth - the width in pixels

columnSetExpandRatio

public void columnSetExpandRatio(RecordHolder column,
                                 Decimal expandRatio)

Sets expand ratio to a grid column.

Parameters:

column - the column definition which identifies the grid column

expandRatio - the expand ratio to set (integral value)

columnGetExpandRatio

public Decimal columnGetExpandRatio(RecordHolder column)

Gets the expand ratio of a grid column.

Parameters:

column - the column definition which identifies the grid column

Returns:

the expand ratio

columnSetMinimumWidth

public void columnSetMinimumWidth(RecordHolder column,
                                  Decimal pixels)

Sets a grid columns minimum width.

Parameters:

column - the column definition which identifies the grid column

pixels - the width in pixels

columnGetMinimumWidth

public Decimal columnGetMinimumWidth(RecordHolder column)

Gets the column's minimum width in pixels.

Parameters:

column - the column definition which identifies the grid column

Returns:

minimum width in pixels

columnSetMaximumWidth

public void columnSetMaximumWidth(RecordHolder column,
                                  Decimal pixels)

Sets a maximum width to a grid column.

Parameters:

column - the column definition which identifies the grid column

pixels - the maximum width in pixels (integral value)

columnGetMaximumWidth

public Decimal columnGetMaximumWidth(RecordHolder column)

Gets a maximum width of a column.

Parameters:

column - the column definition which identifies the grid column@param column

Returns:

the column's maximum width

columnSetHidden

public void columnSetHidden(RecordHolder column,
                            boolean hidden)

Sets the column's hidden flag.

Parameters:

column - the column definition which identifies the grid column

hidden -

columnIsHidden

public boolean columnIsHidden(RecordHolder column)

Gets the column's hidden flag.

Parameters:

column - the column definition which identifies the grid column

Returns:

the hidden flag

columnSetHidable

public void columnSetHidable(RecordHolder column,
                             boolean hidable)

Set's the columns hidable flag.

Parameters:

column - the column definition which identifies the grid column

hidable -

columnGetHidable

public boolean columnGetHidable(RecordHolder column)

Gets the column's hidable flag.

Parameters:

column - the column definition which identifies the grid column

Returns:

the value of the hidable flag

columnSetResizable

public void columnSetResizable(RecordHolder column,
                               boolean resizable)

Sets the resizable flag of the grid column.

Parameters:

column - the column definition which identifies the grid column@param column

resizable -

columnIsResizable

public boolean columnIsResizable(RecordHolder column)

Gets the value of the resizable flag of a grid column.

Parameters:

column - the column definition which identifies the grid column

Returns:

the value of the resizable flag.

getColumns

public ListHolder getColumns()

Gets a list of column definitions of this grid.

Returns:

a list of column definitions

columnGetAlignment

public EnumerationImpl columnGetAlignment(RecordHolder column)

Gets the column alignment

Parameters:

column - the column definition which identifies the grid column

Returns:

the column alignment

columnSetAlignment

public void columnSetAlignment(RecordHolder column,
                               EnumerationImpl alignment)

Sets the column alignment.

Parameters:

column - the column definition which identifies the grid column

alignment -

columnGetHeaderAlignment

public EnumerationImpl columnGetHeaderAlignment(RecordHolder column)

Gets the column header text alignment.

Parameters:

column - the column definition which identifies the grid column

Returns:

header alignment

columnSetHeaderAlignment

public void columnSetHeaderAlignment(RecordHolder column,
                                     EnumerationImpl alignment)

Sets the column header alignment

Parameters:

column - the column definition which identifies the grid column

alignment - the alignment

columnGetHeaderStyleName

public String columnGetHeaderStyleName(RecordHolder column)

Gets the column header style name

Parameters:

column - the column definition which identifies the grid column

Returns:

the column header style name

columnSetHeaderStyleName

public void columnSetHeaderStyleName(RecordHolder column,
                                     String styleName)

Parameters:

column - the column definition which identifies the grid column

styleName -

setEditorEnabled

public void setEditorEnabled(Boolean enabled)

Sets the editor support enabled flag.

Parameters:

enabled - true to enable the grid editor support

setEditorBuffered

public void setEditorBuffered(Boolean editorBuffered)

Sets the editor buffered support.

Parameters:

editorBuffered -

setSelectable

@Deprecated
public void setSelectable(boolean selectable)

Deprecated.

If true, sets the selection mode to SINGLE. Otherwise sets it to NONE.

Parameters:

selectable -

setSelectionMode

public void setSelectionMode(EnumerationImpl selectionMode)

Sets selection mode.

Parameters:

selectionMode - to be set

getSelectionMode

public EnumerationImpl getSelectionMode()

Returns:

current selection mode.

isSelectable

public boolean isSelectable()

Indicates if the rows in the grids are selectable.

Returns:

true if the grid's row are selectable.

select

public void select(CollectionHolder rowObjects)

Changes grid selection. Previous selection is cleared and new set of rows is selected. Exact behavior depends on selection mode:

• NONE - call fails.
• SINGLE - previous selection is cleared. If the rowObjects argument is non-empty, only one row is selected.
• SINGLE - previous selection is cleared. If the rowObjects argument is non-empty, all objects in it are selected.

All row objects must have been provided by the DataSource.

Parameters:

rowObjects - new selection

getSelection

public ListHolder getSelection()

Gets list of row objects of the selected rows. In case of a single select, returns list with one element.

Returns:

list of the selected row objects.

setSelectionChangeListener

public void setSelectionChangeListener(ClosureHolder listener)

Sets the selection change listener. The listener is notified on the selection changes.

Parameters:

listener - the listener to set

getSelectionChangeListener

public ClosureHolder getSelectionChangeListener()

Gets the the current selection change listener.

Returns:

the current selection change listener or null if none is installed.

getHeightByRows

public Decimal getHeightByRows()

Gets the amount of rows in the grid body that are shown if the height mode is ROW.

Returns:

the amount of rows or 0 if the grid is not in the ROW height mode.

setHeightByRows

public void setHeightByRows(Decimal heightByRows)

Sets the amount of rows in teh grid body that are shown. Zero means to switch the table height mode to CSS.

Parameters:

heightByRows -

showCellErrors

public List<ConstraintViolation> showCellErrors(Collection<ConstraintViolation> constraintViolations)

Shows cell errors in cells displaying value of a record property equivalent with the constraint violation record property.

Parameters:

constraintViolations -

Returns:

a list of shown constraint violations

clearCellErrors

public void clearCellErrors()

Clears any potential cell errors.

setColumnResizeListener

public void setColumnResizeListener(ClosureHolder listener)

Sets a column resize listener to this grid.

Parameters:

listener -

setRowStyleGenerator

public void setRowStyleGenerator(ClosureHolder styleGenerator)

Sets the style generator that is used for generating styles for rows. The generator obtains a row objects and returns css class that should be added to that row div.

Parameters:

styleGenerator - the row style generator to set, or null to remove a previously set generator

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

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)