com.whitestein.lsps.vaadin.ui.components.table

Class UITableBase

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.VerticalLayout

com.whitestein.lsps.vaadin.ui.components.table.UITableBase

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.CustomTable.CellStyleGenerator, com.vaadin.ui.CustomTable.ColumnGenerator, com.vaadin.ui.CustomTable.HeaderClickListener, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, UIComponent, UIComponentShowingRecords, UIComponentWithCustomScopes, UIRefreshHandler, UIComponentWithHints2, Serializable, Iterable<com.vaadin.ui.Component>

Direct Known Subclasses:

UIGroupingTable, UILazyTable, UIPagedTable, UISimpleTable, UITreeTable2

public abstract class UITableBase
extends com.vaadin.ui.VerticalLayout
implements UIComponentWithCustomScopes, UIComponentWithHints2, com.vaadin.ui.CustomTable.HeaderClickListener, com.vaadin.ui.CustomTable.ColumnGenerator, UIComponentShowingRecords, com.vaadin.ui.CustomTable.CellStyleGenerator

Base component for UIComponents based on Table.

Crazy: table is not UIComponentContainer yet it contains columns. However, beware - if you let table implement UIComponentContainer, it could break several things, for example column hints would be applied two times.

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UITableBase.ComponentTuple

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
boolean	dataDataset True if the table is fed from a data dataset (or "Paged Collection" dataset), false if from a generic, query or type dataset.

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
UITableBase(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
UITableColumn	addDynamicColumn(Variant.RecordVariant column) INTERNAL API, DO NOT USE.
protected void	applyColumnHints()
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
void	attach()
protected abstract void	clearContent() Should remove old data from the data container.
protected void	clearData() Removes all data and scopes.
protected UITableColumn	createTableColumn(com.vaadin.ui.CustomTable vaadinTable, UIComponentData componentData, String columnId) Creates new column component instance.
protected com.vaadin.ui.CustomTable	createTableComponent() Creates the table instance.
Object	generateCell(com.vaadin.ui.CustomTable source, Object itemId, Object columnId)
UITableColumn	getColumn(String columnId)
com.google.common.collect.ImmutableList<UITableColumn>	getColumns() Returns a list of columns, ordered as defined in the table.
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
Map<Integer,Serializable>	getCurrentData() Returns map of all known data, mapping Item ID to the wrapped business data instance.
protected abstract AbstractDatasetVaadinAdapter	getDatasetAdapter()
com.vaadin.data.Container.Filterable	getFilterable()
com.vaadin.ui.Field<Object>	getFilterComponentForColumn(int col)
Integer	getItemId(UIComponentScope scope)
Set<UIComponent>	getRefreshedComponents()
UIComponentScope	getScope(Integer itemId)
Set<RecordHolder>	getShownRecords() Lists record instances currently displayed in the component's selection.
String	getStyle(com.vaadin.ui.CustomTable source, Object itemId, Object propertyId)
com.vaadin.ui.CustomTable	getTable() Returns the Vaadin Table component.
String	getUnformattedHeaderCaption(String columnId) Returns the unformatted column header (without any divs or spans).
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
void	headerClick(com.vaadin.ui.CustomTable.HeaderClickEvent event)
void	initChildren(boolean isFirstLoad) Should initialize all visible child components.
protected boolean	isDataDataset()
protected boolean	isInferFilteringDisabled()
IDataset	newDataset() Creates new dataset based on the value of the DATA property.
void	onLoad(Collection<Object> data, int startIndex) Should be called when new data is loaded to the table datasource.
protected void	onLoad(Collection<Object> data, int startIndex, boolean triggerEventProcessing) Should be called when new data is loaded to the table datasource.
protected void	onResetFilters(com.vaadin.ui.CustomTable table)
protected void	onTableSort(Object[] propertyId, boolean[] ascending) Simply call this when someone calls the sort method on a Vaadin table.
void	refresh() This method is called from LSPS rendering engine.
protected void	refreshInt()
void	registerChildren() Should register all child components in the screen.
boolean	showPerformanceWarnings() Checks if performance warnings are to be shown.
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
void	unregisterChildren() Should unregister all child components in the screen.
void	updateContextFor(UIComponentScope scope) Updates context with all necessary values for the given scope.

Methods inherited from class com.vaadin.ui.VerticalLayout

getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, addListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, getState, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, removeListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

dataDataset

public final boolean dataDataset

True if the table is fed from a data dataset (or "Paged Collection" dataset), false if from a generic, query or type dataset.

Constructor Detail

UITableBase

public UITableBase(UIComponentData componentData)

Parameters:

componentData -

Method Detail

addDynamicColumn

public final UITableColumn addDynamicColumn(Variant.RecordVariant column)

INTERNAL API, DO NOT USE.

Parameters:

column - the ui::TableColumn

Returns:

the column

getScope

public UIComponentScope getScope(Integer itemId)

getItemId

public Integer getItemId(UIComponentScope scope)

getColumns

public com.google.common.collect.ImmutableList<UITableColumn> getColumns()

Returns a list of columns, ordered as defined in the table. Includes all columns, including hidden (UIFieldNames.SHOWN columns.

Returns:

a list of columns, not null, may be empty. Does not contain nulls.

getTable

public com.vaadin.ui.CustomTable getTable()

Returns the Vaadin Table component. Useful for example for performing CSV/Excel export (via the Excel export extension).

Returns:

the table component, never null.

createTableComponent

protected com.vaadin.ui.CustomTable createTableComponent()

Creates the table instance. Called in constructor - take care when overriding.

When overriding, please override sort(), setRefreshingEnabled() and resetFilters()

Returns:

the table, must not be null.

onTableSort

protected final void onTableSort(Object[] propertyId,
                                 boolean[] ascending)

Simply call this when someone calls the sort method on a Vaadin table.

Parameters:

propertyId - sort by these property IDs, not null.

ascending - true if ascending, false if descending. Not null.

onResetFilters

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

isDataDataset

protected boolean isDataDataset()

createTableColumn

protected UITableColumn createTableColumn(com.vaadin.ui.CustomTable vaadinTable,
                                          UIComponentData componentData,
                                          String columnId)

Creates new column component instance.

Warning: invoked in table constructor.

Parameters:

vaadinTable - the Vaadin Table component, not null.

componentData - the column component data, not null.

columnId - the column ID, assigned to the column. Unique, modelingId is used whenever possible.

Returns:

the table column instance, must not be null.

applyColumnHints

protected void applyColumnHints()

attach

public void attach()

Specified by:

attach in interface com.vaadin.server.ClientConnector

Specified by:

attach in interface com.vaadin.ui.Component

Overrides:

attach in class com.vaadin.ui.AbstractComponent

clearData

protected void clearData()

Removes all data and scopes. Invoked before clearContent().

clearContent

protected abstract void clearContent()

Should remove old data from the data container. Invoked at the beginning of refresh() method. Scopes for rows are already removed.

registerChildren

public void registerChildren()

Description copied from interface: UIRefreshHandler

Should register all child components in the screen. See UIScreen.registerUIComponent(UIComponent).

Specified by:

registerChildren in interface UIRefreshHandler

unregisterChildren

public void unregisterChildren()

Description copied from interface: UIRefreshHandler

Should unregister all child components in the screen. See UIScreen.unregisterUIComponent(UIComponent).

Specified by:

unregisterChildren in interface UIRefreshHandler

initChildren

public void initChildren(boolean isFirstLoad)

Description copied from interface: UIRefreshHandler

Should initialize all visible child components. See UIComponents.initChildren(java.util.List, boolean).

Specified by:

initChildren in interface UIRefreshHandler

Parameters:

isFirstLoad - value of field UIFieldNames.IS_FIRST_LOAD of the created init event

refresh

public final void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

refreshInt

protected void refreshInt()

newDataset

public IDataset newDataset()

Creates new dataset based on the value of the DATA property. The dataset is not yet sorted nor filtered.

Returns:

the data provider, never null.

getCurrentData

public Map<Integer,Serializable> getCurrentData()

Returns map of all known data, mapping Item ID to the wrapped business data instance.

Returns:

wrapped values, never null, may be empty.

getShownRecords

public Set<RecordHolder> getShownRecords()

Description copied from interface: UIComponentShowingRecords

Lists record instances currently displayed in the component's selection.

Used for validation purposes, to match record-level validation errors to components. E.g. the validation error may be displayed on a Table if the table is currently displaying given record.

Some rules for the method:

• The table component should return only records which are currently displayed. For example, the paging table should return only records currently being shown on the current table page.
• Repeater should return all records (there is no paging)
• Calendar should only return records which are displayed in the current date range.
• Combobox should not return anything. Theoretically it could return currently selected record, but this record is accessible via the BINDING field, therefore it is not necessary to return this information through this method.
• Generally, the method should return data for Tables, Tree tables, Repeaters and Calendars only.

Specified by:

getShownRecords in interface UIComponentShowingRecords

Returns:

record instances currently displayed in the component's selection. May return null or empty list. The list may be immutable.

onLoad

public void onLoad(Collection<Object> data,
                   int startIndex)

Should be called when new data is loaded to the table datasource.

Parameters:

data - the data, not null. May contain nulls.

startIndex -

onLoad

protected void onLoad(Collection<Object> data,
                      int startIndex,
                      boolean triggerEventProcessing)

Should be called when new data is loaded to the table datasource.

Parameters:

data - the data, not null. May contain nulls.

startIndex -

generateCell

public Object generateCell(com.vaadin.ui.CustomTable source,
                           Object itemId,
                           Object columnId)

Specified by:

generateCell in interface com.vaadin.ui.CustomTable.ColumnGenerator

updateContextFor

public void updateContextFor(UIComponentScope scope)

Description copied from interface: UIComponentWithCustomScopes

Updates context with all necessary values for the given scope.

Specified by:

updateContextFor in interface UIComponentWithCustomScopes

getComponentData

public final UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

headerClick

public void headerClick(com.vaadin.ui.CustomTable.HeaderClickEvent event)

Specified by:

headerClick in interface com.vaadin.ui.CustomTable.HeaderClickListener

getUnformattedHeaderCaption

public String getUnformattedHeaderCaption(String columnId)

Returns the unformatted column header (without any divs or spans). Column headers retrieved from Vaadin table (e.g. by Table.getColumnHeaders()) may contain html elements such as divs or spans, with custom CSS styles. Use this method to retrieve the original header caption as retrieved from the model.

Parameters:

columnId - the column ID, not null. You can obtain the column ID for example by calling Table.getVisibleColumns(). Note that column ID is always an instance of String - you may cast the result of getVisibleColumns() safely.

Returns:

current caption, may be null if not yet set.

getColumn

public final UITableColumn getColumn(String columnId)

getRefreshedComponents

public Set<UIComponent> getRefreshedComponents()

Specified by:

getRefreshedComponents in interface UIRefreshHandler

Returns:

set of components refreshed during last refresh call

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

getFilterable

public com.vaadin.data.Container.Filterable getFilterable()

getFilterComponentForColumn

public com.vaadin.ui.Field<Object> getFilterComponentForColumn(int col)

showPerformanceWarnings

public boolean showPerformanceWarnings()

Checks if performance warnings are to be shown.

Returns:

true if performance warnings are to be shown, false if not.

isInferFilteringDisabled

protected boolean isInferFilteringDisabled()

getStyle

public String getStyle(com.vaadin.ui.CustomTable source,
                       Object itemId,
                       Object propertyId)

Specified by:

getStyle in interface com.vaadin.ui.CustomTable.CellStyleGenerator

toString

public String toString()

Overrides:

toString in class Object

getDatasetAdapter

protected abstract AbstractDatasetVaadinAdapter getDatasetAdapter()

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.