com.whitestein.lsps.vaadin.forms

Class WAbstractTable

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WAbstractTable

All Implemented Interfaces:

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

Direct Known Subclasses:

WTable, WTreeTable

public abstract class WAbstractTable
extends FormComponent
implements IVaadinContainerDataSourceAdapter.FilterConfigProvider

Basic groundwork for a table. Basically this class only manages table columns.

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WAbstractTable.Column A table column representation.
protected class	WAbstractTable.ColumnResizeListenerImpl A table column resize listener which delegates the resize event to the wrapped closure.
protected class	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
WAbstractTable()

Method Summary

Modifier and Type	Method and Description
abstract void	addColumn(RecordHolder column) Adds a column to this table.
protected void	addColumn(WAbstractTable.Column column)
EnumerationImpl	columnGetAlignment(RecordHolder column) Gets table column content alignment.
Decimal	columnGetExpandRatio(RecordHolder column) Gets expand ratio of a table column.
String	columnGetHeader(RecordHolder column) Gets the column header.
EnumerationImpl	columnGetHeaderAlignmnet(RecordHolder column) Gets a table column's header alignment.
String	columnGetHeaderStyleName(RecordHolder column) Gets a column's header style name.
Decimal	columnGetWidth(RecordHolder column) Gets table column width.
boolean	columnIsCollapsed(RecordHolder column) Returns the collapsed state of a table column.
boolean	columnIsCollapsible(RecordHolder column) Gets value of the collapsible flag of a table column.
void	columnSetAlignment(RecordHolder column, EnumerationImpl alignment) Sets table column content alignment.
void	columnSetCollapsed(RecordHolder column, boolean collapsed) Sets the collapsed state of a table column.
void	columnSetCollapsible(RecordHolder column, boolean collapsible) Sets the collapsible flag for a table column.
void	columnSetExpandRatio(RecordHolder column, Decimal expandRatio) Sets expand ratio to a table column.
void	columnSetHeader(RecordHolder column, String header) Sets a header caption to the table column.
void	columnSetHeaderAlignment(RecordHolder column, EnumerationImpl alignment) Sets a table column's header alignment
void	columnSetHeaderStyleName(RecordHolder column, String styleName) Sets a column's header style name.
void	columnSetWidth(RecordHolder column, Decimal width) Sets table column width.
protected WAbstractTable.Column	getColumn(RecordHolder gridColumn)
protected WAbstractTable.Column	getColumn(Variant.RecordVariant propertyId) Gets the table column for the given property.
ListHolder	getColumns() Gets a list of table columns.
Decimal	getComponentCount() Returns the number of contained components in this table.
ListHolder	getComponents() Gets a list of components contained by this table.
Object	getFilterId(Object propertyId) Returns filter id which will be assigned to filters on this column.
Type	getFilterValueType(Object propertyId) Returns the expected value type which will be present to the filter.
IHasChildren	getHasChildrenAdapter() Provides an adapter of this component which allows easily invoke methods on the forms::HasChildren interface.
Decimal	getPageLength() Gets the current page length.
abstract Object	getSelection() Gets the current selection.
protected Collection<WAbstractTable.Column>	getTableColumns()
protected List<com.whitestein.lsps.vaadin.forms.TableColumnState>	getTableColumnStates()
Type	getValueType(Object propertyId) Returns the expected value type which will be present in this column.
com.vaadin.ui.CustomTable	getWidget() Gets the Vaadin representation of this component.
boolean	isColumnCollapsingAllowed() Checks if column collapsing is allowed.
boolean	isColumnReorderingAllowed() Checks if column reordering is allowed.
boolean	isFilteringEnabled() Checks whether the filtering is enabled on this table.
protected boolean	isSafeToSetDefaultFilterValues(com.vaadin.ui.CustomTable table)
boolean	isSelectable() Getter for property selectable.
protected void	onResetFilters(com.vaadin.ui.CustomTable table)
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
abstract void	refresh() Refreshes the content.
protected void	resetFilters()
protected void	restoreColumnState(RecordHolder column, com.whitestein.lsps.vaadin.forms.TableColumnState state) Restores column state.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
abstract void	select(Object rowObject) Selects the given row.
void	setColumnCollapsingAllowed(boolean collapsingAllowed) Sets whether column collapsing is allowed or not.
void	setColumnReorderingAllowed(boolean columnReorderingAllowed) Sets whether column reordering is allowed or not.
void	setColumnResizeListener(ClosureHolder listener) Sets a column resize listener to this table.
void	setFilteringEnabled(boolean enabled) Enables/disables the filtering functionality of the table.
void	setPageLength(Decimal pageLength) Sets the current page length.
void	setSelectable(boolean selectable) Setter for property selectable.
void	setSelectionChangeListener(ClosureHolder onChange) Sets a listener for the seletion changes.
protected void	setWidgetPageLength(com.vaadin.ui.CustomTable table, int pageLength) Sets the table page length.
protected void	updateFilterFieldVisibilities() resetFilters() clears the filter field visibility...
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, createWidget, 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

WAbstractTable

public WAbstractTable()

Method Detail

getTableColumns

protected final Collection<WAbstractTable.Column> getTableColumns()

getValueType

public Type getValueType(Object propertyId)

Returns the expected value type which will be present in this column.

Parameters:

propertyId - the column id, not null.

Returns:

the type, never null.

getFilterId

public Object getFilterId(Object propertyId)

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

Specified by:

getFilterId in interface IVaadinContainerDataSourceAdapter.FilterConfigProvider

Returns:

filterId

getFilterValueType

public Type getFilterValueType(Object propertyId)

Returns the expected value type which will be present to the filter.

Parameters:

propertyId - the column id, not null.

Returns:

the type, never null.

getColumn

protected final WAbstractTable.Column getColumn(RecordHolder gridColumn)

getColumn

protected final WAbstractTable.Column getColumn(Variant.RecordVariant propertyId)

Gets the table column for the given property. The property must be present in the table.

Parameters:

propertyId - the property identifier

Returns:

the table column

addColumn

public abstract void addColumn(RecordHolder column)

Adds a column to this table. You can call this before or after the data source has been set.

Parameters:

column - the column to add, not null.

addColumn

protected final void addColumn(WAbstractTable.Column column)

getWidget

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

getColumns

public ListHolder getColumns()

Gets a list of table columns.

Returns:

a list of table columns

columnSetHeader

public void columnSetHeader(RecordHolder column,
                            String header)

Sets a header caption to the table column.

Parameters:

column - the column definition which identifies the table column

header - the caption to set

columnGetHeader

public String columnGetHeader(RecordHolder column)

Gets the column header.

Parameters:

column - the column definition which identifies the table column

Returns:

the column's header

columnSetHeaderAlignment

public void columnSetHeaderAlignment(RecordHolder column,
                                     EnumerationImpl alignment)

Sets a table column's header alignment

Parameters:

column - the column definition which identifies the table column

alignment -

columnGetHeaderAlignmnet

public EnumerationImpl columnGetHeaderAlignmnet(RecordHolder column)

Gets a table column's header alignment.

Parameters:

column - the column definition which identifies the table column

Returns:

the column header alignment

columnSetAlignment

public void columnSetAlignment(RecordHolder column,
                               EnumerationImpl alignment)

Sets table column content alignment.

Parameters:

column - the column definition which identifies the table column

alignment -

columnGetAlignment

public EnumerationImpl columnGetAlignment(RecordHolder column)

Gets table column content alignment.

Parameters:

column - the column definition which identifies the table column

Returns:

the column's content alignment

columnSetHeaderStyleName

public void columnSetHeaderStyleName(RecordHolder column,
                                     String styleName)

Sets a column's header style name.

Parameters:

column - the column definition which identifies the table column

styleName -

columnGetHeaderStyleName

public String columnGetHeaderStyleName(RecordHolder column)

Gets a column's header style name.

Parameters:

column - the column definition which identifies the table column

Returns:

style name

columnSetCollapsed

public void columnSetCollapsed(RecordHolder column,
                               boolean collapsed)

Sets the collapsed state of a table column.

Parameters:

column - the column definition which identifies the table column

collapsed -

columnIsCollapsed

public boolean columnIsCollapsed(RecordHolder column)

Returns the collapsed state of a table column.

Parameters:

column - the column definition which identifies the table column

Returns:

state of the collapsed flag.

columnSetCollapsible

public void columnSetCollapsible(RecordHolder column,
                                 boolean collapsible)

Sets the collapsible flag for a table column.

Parameters:

column - the column definition which identifies the table column

collapsible -

columnIsCollapsible

public boolean columnIsCollapsible(RecordHolder column)

Gets value of the collapsible flag of a table column.

Parameters:

column - the column definition which identifies the table column

Returns:

the value of the collapsible flag.

columnSetWidth

public void columnSetWidth(RecordHolder column,
                           Decimal width)

Sets table column width.

Parameters:

column - the column definition which identifies the table column

width -

columnGetWidth

public Decimal columnGetWidth(RecordHolder column)

Gets table column width.

Parameters:

column - the column definition which identifies the table column

Returns:

table column width

columnSetExpandRatio

public void columnSetExpandRatio(RecordHolder column,
                                 Decimal expandRatio)

Sets expand ratio to a table column.

Parameters:

column - the column definition which identifies the table column

expandRatio -

columnGetExpandRatio

public Decimal columnGetExpandRatio(RecordHolder column)

Gets expand ratio of a table column.

Parameters:

column - the column definition which identifies the table column

Returns:

table column's expand ratio

getSelection

public abstract Object getSelection()

Gets the current selection.

Returns:

current selection or null if there is no selection.

setSelectionChangeListener

public void setSelectionChangeListener(ClosureHolder onChange)

Sets a listener for the seletion changes.

Parameters:

onChange -

getPageLength

public Decimal getPageLength()

Gets the current page length.

Returns:

the page length

setPageLength

public void setPageLength(Decimal pageLength)

Sets the current page length. Setting 0 disables paging.

Parameters:

pageLength -

setWidgetPageLength

protected void setWidgetPageLength(com.vaadin.ui.CustomTable table,
                                   int pageLength)

Sets the table page length. Setting 0 disables paging.

Parameters:

table - - widget to be modified

pageLength - - page length

resetFilters

protected void resetFilters()

updateFilterFieldVisibilities

protected void updateFilterFieldVisibilities()

resetFilters() clears the filter field visibility... update

setFilteringEnabled

public void setFilteringEnabled(boolean enabled)

Enables/disables the filtering functionality of the table. Disabling the filtering clears also any filter.

Parameters:

enabled -

isFilteringEnabled

public boolean isFilteringEnabled()

Checks whether the filtering is enabled on this table.

Returns:

true if the filtering is enabled.

isSafeToSetDefaultFilterValues

protected boolean isSafeToSetDefaultFilterValues(com.vaadin.ui.CustomTable table)

onResetFilters

protected void onResetFilters(com.vaadin.ui.CustomTable table)

Parameters:

table -

setColumnResizeListener

public void setColumnResizeListener(ClosureHolder listener)

Sets a column resize listener to this table.

Parameters:

listener -

getComponentCount

public Decimal getComponentCount()

Returns the number of contained components in this table.

Returns:

the number of contained components; never null

getComponents

public ListHolder getComponents()

Gets a list of components contained by this table. The order of components in the list is unspecified.

Returns:

a list of contained components.

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.

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.

getTableColumnStates

protected List<com.whitestein.lsps.vaadin.forms.TableColumnState> getTableColumnStates()

restoreColumnState

protected void restoreColumnState(RecordHolder column,
                                  com.whitestein.lsps.vaadin.forms.TableColumnState state)

Restores column state.

Parameters:

column - forms::TableColumn

state - the state to be restored

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)

isColumnCollapsingAllowed

public boolean isColumnCollapsingAllowed()

Checks if column collapsing is allowed.

Returns:

true if columns can be collapsed; false otherwise.

setColumnCollapsingAllowed

public void setColumnCollapsingAllowed(boolean collapsingAllowed)

Sets whether column collapsing is allowed or not.

Parameters:

collapsingAllowed - specifies whether column collapsing is allowed.

isColumnReorderingAllowed

public boolean isColumnReorderingAllowed()

Checks if column reordering is allowed.

Returns:

true if columns can be reordered; false otherwise.

setColumnReorderingAllowed

public void setColumnReorderingAllowed(boolean columnReorderingAllowed)

Sets whether column reordering is allowed or not.

Parameters:

columnReorderingAllowed - specifies whether column reordering is allowed.

isSelectable

public boolean isSelectable()

Getter for property selectable.

The table is not selectable by default.

Returns:

the Value of property selectable.

setSelectable

public void setSelectable(boolean selectable)

Setter for property selectable.

The table is not selectable by default.

Parameters:

selectable - the New value of property selectable.

refresh

public abstract void refresh()

Refreshes the content.

select

public abstract void select(Object rowObject)

Selects the given row.

Parameters:

rowObject - the row object which identifies the table row