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

Class UIGridColumn

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

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

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, UIComponentWithCustomVisibility, UIComponentWithHints2, Serializable

public class UIGridColumn
extends com.vaadin.ui.AbstractComponent
implements UIComponent, UIComponentWithHints2, UIComponentWithCustomVisibility

A Java wrapper around the ui::GridColumn record.

Author:

mvy

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

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.data.util.converter.Converter<?,?>	createConverterForRenderer()
com.vaadin.ui.Alignment	getAlignment()
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
Variant<Object>	getContent(Object input) Runs the "content" closure or property on given input and returns the result.
Type	getContentType() Returns the type of the values returned by getContent(Object).
com.vaadin.ui.Field<?>	getEditor() Creates an editor capable of editing the column's value.
Filter.ValueProvider<?>	getFilterValueProvider()
String	getHeader() Returns ui::GridColumn.header
com.vaadin.ui.Alignment	getHeaderAlignment()
com.vaadin.ui.renderers.Renderer<?>	getRenderer()
String	getRendererFormatPattern() Returns the format pattern of the renderer defined for the column.
ISort	getSort(int columnId) Returns the sorting criteria for this column.
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
boolean	isEditable() Checks whether this column is editable.
boolean	isFiltrable()
boolean	isHiddenByUser()
boolean	isPropertyPath() True if the ui::GridColumn.content field is a property path.
boolean	isShown() Returns true if the LSPS UI component represented by this Vaadin component is visible.
boolean	isSortable() Returns true if this column is sortable.
void	refresh() This method is called from LSPS rendering engine.
void	setAlignment(com.vaadin.ui.Alignment alignment)
void	setContent(Variant<Object> row, Object content) Sets the value to the row object.
void	setHeaderAlignment(com.vaadin.ui.Alignment headerAlignment)
void	setHiddenByUser(boolean hiddenByUser)
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.

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, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, 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

Method Detail

isSortable

public boolean isSortable()

Returns true if this column is sortable. Generally, the column is always sortable (albeit closure columns are sortable only in memory), unless user set the "sortable" field to false.

Returns:

true if this column is sortable, false if not.

getContentType

public Type getContentType()

Returns the type of the values returned by getContent(Object).

Returns:

the type, not null.

getContent

public Variant<Object> getContent(Object input)

Runs the "content" closure or property on given input and returns the result. This result will then be filtered and/or sorted upon. The value may be additionally formatted (by Grid Renderer), for display purposes.

Parameters:

input - the grid row object

Returns:

computed value, may be null.

Throws:

UnreachablePropertyPathValueException - if the value of the input cannot be reached using the defined property path

setContent

public void setContent(Variant<Object> row,
                       Object content)

Sets the value to the row object. It is expected the row object to be a record as only columns displaying property values are editable.

Parameters:

row - the row object

content - the content to set

isPropertyPath

public boolean isPropertyPath()

True if the ui::GridColumn.content field is a property path.

Returns:

true if the ui::GridColumn.content field is a property path, false if it is a closure.

isEditable

public boolean isEditable()

Checks whether this column is editable. The column is editable when it uses a property path to obtain a value and if the editable flag is set to true.

Returns:

true if this column is editable.

getHeader

public String getHeader()

Returns ui::GridColumn.header

Returns:

ui::GridColumn.header

toString

public String toString()

Overrides:

toString in class Object

getSort

public ISort getSort(int columnId)

Returns the sorting criteria for this column.

Returns:

the sorting criteria, never null.

Throws:

IllegalStateException - if the column is not sortable.

isFiltrable

public boolean isFiltrable()

getFilterValueProvider

public Filter.ValueProvider<?> getFilterValueProvider()

getRenderer

public com.vaadin.ui.renderers.Renderer<?> getRenderer()

getRendererFormatPattern

public String getRendererFormatPattern()

Returns the format pattern of the renderer defined for the column. Format pattern is defined for the renderers:

• ui::NumberRenderer
• ui::DateRenderer

If the column does not define any renderer or the renderer does not have the format pattern property then this method returns null.

Returns:

the format pattern of the column's renderer if the renderer is defined and the renderer has the format pattern property.

createConverterForRenderer

public com.vaadin.data.util.converter.Converter<?,?> createConverterForRenderer()

getEditor

public com.vaadin.ui.Field<?> getEditor()

Creates an editor capable of editing the column's value.

Returns:

the editor field for this column

isShown

public boolean isShown()

Description copied from interface: UIComponentWithCustomVisibility

Returns true if the LSPS UI component represented by this Vaadin component is visible. Used by UIComponents.isShown(UIComponent).

Specified by:

isShown in interface UIComponentWithCustomVisibility

Returns:

true if component is marked as visible

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.

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.

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

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

getAlignment

public com.vaadin.ui.Alignment getAlignment()

setAlignment

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

getHeaderAlignment

public com.vaadin.ui.Alignment getHeaderAlignment()

setHeaderAlignment

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

isHiddenByUser

public boolean isHiddenByUser()

setHiddenByUser

public void setHiddenByUser(boolean hiddenByUser)