com.whitestein.lsps.vaadin.forms

Class WTable

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WAbstractTable

com.whitestein.lsps.vaadin.forms.WTable

All Implemented Interfaces:

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

public class WTable
extends WAbstractTable

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.forms.WAbstractTable

WAbstractTable.Column, WAbstractTable.ColumnResizeListenerImpl, WAbstractTable.ValueChangeListenerImpl

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

Method Summary

Modifier and Type	Method and Description
void	addColumn(RecordHolder gridColumn) Registers a new column.
protected com.vaadin.ui.CustomTable	createWidget() Called once, to create the actual Vaadin component.
RecordHolder	getDataSource() Gets the definition of the currently used data source.
String	getNoDataMessage()
Object	getSelection() Gets the current selection.
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(Object rowObject) Sets the selected row in the table.
void	setDataSource(RecordHolder ds) Sets the data source to this table.
void	setNoDataMessage(String noDataMessage) Sets message displayed when no data are available.
void	setRowStyleGenerator(ClosureHolder styleGenerator) Sets the style generator that is used for generating styles for rows.
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.WAbstractTable

addColumn, columnGetAlignment, columnGetExpandRatio, columnGetHeader, columnGetHeaderAlignmnet, columnGetHeaderStyleName, columnGetWidth, columnIsCollapsed, columnIsCollapsible, columnSetAlignment, columnSetCollapsed, columnSetCollapsible, columnSetExpandRatio, columnSetHeader, columnSetHeaderAlignment, columnSetHeaderStyleName, columnSetWidth, getColumn, getColumn, getColumns, getComponentCount, getComponents, getFilterId, getFilterValueType, getHasChildrenAdapter, getPageLength, getTableColumns, getTableColumnStates, getValueType, getWidget, isColumnCollapsingAllowed, isColumnReorderingAllowed, isFilteringEnabled, isSafeToSetDefaultFilterValues, isSelectable, onResetFilters, resetFilters, restoreColumnState, setColumnCollapsingAllowed, setColumnReorderingAllowed, setColumnResizeListener, setFilteringEnabled, setPageLength, setSelectable, setSelectionChangeListener, setWidgetPageLength, updateFilterFieldVisibilities

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, 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

WTable

public WTable()

Method Detail

createWidget

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

setNoDataMessage

public void setNoDataMessage(String noDataMessage)

Sets message displayed when no data are available. Styling: the message is located inside a div with l-table-no-data class.

Parameters:

noDataMessage -

getNoDataMessage

public String getNoDataMessage()

Returns:

message displayed when no data are available

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 table.

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.

Specified by:

refresh in class WAbstractTable

addColumn

public void addColumn(RecordHolder gridColumn)

Registers a new column.

Specified by:

addColumn in class WAbstractTable

Parameters:

gridColumn - forms::GridColumn

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 WAbstractTable

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.

select

public void select(Object rowObject)

Sets the selected row in the table.

Specified by:

select in class WAbstractTable

Parameters:

rowObject - the row object identifying the row to select

getSelection

public Object getSelection()

Description copied from class: WAbstractTable

Gets the current selection.

Specified by:

getSelection in class WAbstractTable

Returns:

current selection or null if there is no selection.

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 style name. The CSS class name that will be added to the row is v-table-row-[style name].

Parameters:

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

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 WAbstractTable

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 WAbstractTable

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)