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

Class UITableColumn

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

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

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, UIComponent, UIRefreshHandler, UIComponentListeningOnRefresh, UIComponentWithCustomVisibility, UIComponentWithHints2, Serializable

public class UITableColumn
extends com.vaadin.ui.AbstractComponent
implements UIComponent, UIComponentWithHints2, UIRefreshHandler, UIComponentWithCustomVisibility, UIComponentListeningOnRefresh

Standard Vaadin component for "ui::TableColumn".

UITableColumn-UITableBase is a very special relationship: UITableColumn is not a component container and thus does not let the framework to refresh its columns - table handles the refresh itself. Also, Vaadin has no component for table columns - column is just a couple of data in the Table component. Therefore, this component is just a "virtual" one - it is never displayed (it is always invisible). Therefore, it must implement UIComponentWithCustomVisibility and return true otherwise UIComponents.isShown(com.whitestein.lsps.vaadin.ui.components.UIComponent) will not work properly and will report false for all UITableColumn descendants.

Author:

mhi

See Also:

Serialized Form

Nested Class Summary

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
Filter.ValueProvider<?>	filterValueProvider A guess of what this column displays and which values are used for filtering.
Variant.ScopedClosureVariant	groupValue The value of the "groupValue" property.
ISort	sort Sort to use when sorting by this column.
protected com.vaadin.ui.CustomTable	table Owner Vaadin table, never null.

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
UITableColumn(com.vaadin.ui.CustomTable table, UIComponentData componentData, String columnId) Constructs a new table column.

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
com.vaadin.ui.Alignment	getAlignment()
String	getColumnId() The column ID.
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
FilterUI	getFilterUI()
Object	getOrdering() Returns the value of the ordering property.
Set<UIComponent>	getRefreshedComponents()
com.vaadin.data.Property	getStringRepresentation(Object itemId) Returns a property which returns text representation of the data displayed in this column, if possible.
protected UITableBase	getUITable() Owner UITableBase, not null.
String	getUnformattedCaption() 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	initChildren(boolean isFirstLoad) Should initialize all visible child components.
boolean	isFiltrable() Checks whether the column supports filtering.
boolean	isPerformanceInline()
boolean	isShown() True if the column is shown (the "shown" property).
boolean	isSortable() Checks if this column is sortable.
void	onChildRefresh(UIComponent child) Invoked when a child UI component is refreshed, or when this method is called on child.
static void	patchCssLayoutToShowErrorMessagesCorrectly(com.vaadin.ui.CssLayout parent, UIComponent component)
void	refresh() This method is called from LSPS rendering engine.
void	refreshChildren(Set<Integer> itemIDsToRefresh) Refreshes/creates child components.
void	refreshColumn(boolean calledFromTable) Performs the column refresh.
void	registerChildren() Should register all child components in the screen.
void	setAlignment(com.vaadin.ui.Alignment alignment)
void	setCaption(String caption)
void	setComponentError(com.vaadin.server.ErrorMessage componentError)
void	setHeaderAlignment(com.vaadin.ui.Alignment alignment)
void	setVisible(boolean visible)
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.

Methods inherited from class com.vaadin.ui.AbstractComponent

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

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

getUI

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Field Detail

sort

public final ISort sort

Sort to use when sorting by this column. May be null if sorting is disabled for this column. See isSortable() for details.

filterValueProvider

public final Filter.ValueProvider<?> filterValueProvider

A guess of what this column displays and which values are used for filtering. May be null if the value provider is not specified and cannot be guessed or determined (or the filter inferring is disabled). Null if DataDataset is used as the data source.

groupValue

public final Variant.ScopedClosureVariant groupValue

The value of the "groupValue" property. Never null, may be absent.

table

protected final com.vaadin.ui.CustomTable table

Owner Vaadin table, never null.

Constructor Detail

UITableColumn

public UITableColumn(com.vaadin.ui.CustomTable table,
                     UIComponentData componentData,
                     String columnId)

Constructs a new table column.

Parameters:

table - owner table, not null.

componentData - data definition, not null.

Method Detail

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface com.vaadin.ui.Component

Overrides:

setVisible in class com.vaadin.ui.AbstractComponent

patchCssLayoutToShowErrorMessagesCorrectly

public static void patchCssLayoutToShowErrorMessagesCorrectly(com.vaadin.ui.CssLayout parent,
                                                              UIComponent component)

getUITable

protected final UITableBase getUITable()

Owner UITableBase, not null.

Returns:

getOrdering

public Object getOrdering()

Returns the value of the ordering property. If ordering was null and was auto-detected, a non-null Property or Path is returned.

Returns:

the ordering, may be null.

isFiltrable

public boolean isFiltrable()

Checks whether the column supports filtering. Only string, decimal, date and enum supports filtering. Returns true if filter inferring was performed successfully.

Also returns true for 'data' datasets, when the column has the CustomFilter UI defined.

Returns:

true if this column supports filtering of filterValueProvider values, false if value provider is null or does not return instances of string, decimal, date nor enum.

getFilterUI

public FilterUI getFilterUI()

isSortable

public boolean isSortable()

Checks if this column is sortable.

Returns:

true if sort is not null.

isShown

public boolean isShown()

True if the column is shown (the "shown" property).

Specified by:

isShown in interface UIComponentWithCustomVisibility

Returns:

true if shown, false otherwise.

refresh

public 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

refreshColumn

public void refreshColumn(boolean calledFromTable)

Performs the column refresh. Does not refresh children.

Parameters:

calledFromTable - if true then we are called from a table and we must not call UITableBase.recreateColumns().

refreshChildren

public void refreshChildren(Set<Integer> itemIDsToRefresh)

Refreshes/creates child components.

Parameters:

itemIDsToRefresh - if not null, restricts which rows will be refreshed. If null, all rows will be refreshed.

onChildRefresh

public void onChildRefresh(UIComponent child)

Description copied from interface: UIComponentListeningOnRefresh

Invoked when a child UI component is refreshed, or when this method is called on child.

Specified by:

onChildRefresh in interface UIComponentListeningOnRefresh

setComponentError

public void setComponentError(com.vaadin.server.ErrorMessage componentError)

Overrides:

setComponentError in class com.vaadin.ui.AbstractComponent

setCaption

public void setCaption(String caption)

Specified by:

setCaption in interface com.vaadin.ui.Component

Overrides:

setCaption in class com.vaadin.ui.AbstractComponent

getUnformattedCaption

public String getUnformattedCaption()

Returns the unformatted column header (without any divs or spans).

Returns:

current caption, may be null if not yet set.

getComponentData

public 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).

getColumnId

public String getColumnId()

The column ID. This is also used as a key to the Vaadin table container property map (Container.getContainerPropertyIds()).

Needs to be stable, pass the MODELING_ID here: https://experjira.whitestein.com/browse/LSPS-6977

Returns:

the column ID, never null.

getRefreshedComponents

public Set<UIComponent> getRefreshedComponents()

Specified by:

getRefreshedComponents in interface UIRefreshHandler

Returns:

set of components refreshed during last refresh call

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

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.

setHeaderAlignment

public void setHeaderAlignment(com.vaadin.ui.Alignment alignment)

setAlignment

public void setAlignment(com.vaadin.ui.Alignment alignment)

getAlignment

public com.vaadin.ui.Alignment getAlignment()

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.

toString

public String toString()

Overrides:

toString in class Object

getStringRepresentation

public com.vaadin.data.Property getStringRepresentation(Object itemId)

Returns a property which returns text representation of the data displayed in this column, if possible.

Parameters:

itemId - the item ID as seen in the Container, not null.

Returns:

a property, may be null if there is no known string representation. Always returns null if this column is not visible or if this column is not inlined.

isPerformanceInline

public boolean isPerformanceInline()

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.