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

Class UIGroupingTable

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

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

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>

public class UIGroupingTable
extends UITableBase

A special table which can perform in-memory data grouping. Displays a linear dataset in a tree table.

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.ui.components.table.UITableBase

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 inherited from class com.whitestein.lsps.vaadin.ui.components.table.UITableBase

dataDataset

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
UIGroupingTable(UIComponentData componentData, LinkedHashMap<String,GroupingDataset.Group> groupSpec)

Method Summary

Modifier and Type	Method and Description
protected void	clearContent() Should remove old data from the data container.
static LinkedHashMap<String,GroupingDataset.Group>	computeGroupSpec(UIComponentData table) Computes effective grouping specification from the table definition.
protected com.vaadin.ui.CustomTable	createTableComponent() Creates the table instance.
Object	generateCell(com.vaadin.ui.CustomTable source, Object itemId, Object columnId)
protected AbstractDatasetVaadinAdapter	getDatasetAdapter()
com.vaadin.ui.Field<Object>	getFilterComponentForColumn(int col)
Set<RecordHolder>	getShownRecords() Lists record instances currently displayed in the component's selection.
org.tepi.filtertable.FilterTreeTable	getTable() Returns the Vaadin Table component.
protected void	refreshInt()

Methods inherited from class com.whitestein.lsps.vaadin.ui.components.table.UITableBase

addDynamicColumn, applyColumnHints, applyHint, attach, clearData, createTableColumn, getColumn, getColumns, getComponentData, getCurrentData, getFilterable, getItemId, getRefreshedComponents, getScope, getStyle, getUnformattedHeaderCaption, getWidget, headerClick, initChildren, isDataDataset, isInferFilteringDisabled, newDataset, onLoad, onLoad, onResetFilters, onTableSort, refresh, registerChildren, showPerformanceWarnings, toString, unapplyHint, unregisterChildren, updateContextFor

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

Constructor Detail

UIGroupingTable

public UIGroupingTable(UIComponentData componentData,
                       LinkedHashMap<String,GroupingDataset.Group> groupSpec)

Method Detail

computeGroupSpec

public static LinkedHashMap<String,GroupingDataset.Group> computeGroupSpec(UIComponentData table)

Computes effective grouping specification from the table definition.

Parameters:

table - the table, not null.

Returns:

the grouping specification. If null or empty, grouping is disabled and the UIGroupingTable should not be used.

createTableComponent

protected com.vaadin.ui.CustomTable createTableComponent()

Description copied from class: UITableBase

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

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

Overrides:

createTableComponent in class UITableBase

Returns:

the table, must not be null.

getTable

public org.tepi.filtertable.FilterTreeTable getTable()

Description copied from class: UITableBase

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

Overrides:

getTable in class UITableBase

Returns:

the table component, never null.

clearContent

protected void clearContent()

Description copied from class: UITableBase

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

Specified by:

clearContent in class UITableBase

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

Overrides:

getShownRecords in class UITableBase

Returns:

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

refreshInt

protected void refreshInt()

Overrides:

refreshInt in class UITableBase

generateCell

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

Specified by:

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

Overrides:

generateCell in class UITableBase

getFilterComponentForColumn

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

Overrides:

getFilterComponentForColumn in class UITableBase

getDatasetAdapter

protected AbstractDatasetVaadinAdapter getDatasetAdapter()

Specified by:

getDatasetAdapter in class UITableBase