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

Class UIGrid

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractFocusable

com.vaadin.ui.Grid

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

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.ItemClickEvent.ItemClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SelectionEvent.SelectionNotifier, com.vaadin.event.SortEvent.SortNotifier, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.SelectiveRenderer, UIComponent, UIRefreshHandler, UIComponentWithHints2, Serializable, Iterable<com.vaadin.ui.Component>

public class UIGrid
extends com.vaadin.ui.Grid
implements UIComponent, UIComponentWithHints2, UIRefreshHandler

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.Grid

com.vaadin.ui.Grid.AbstractGridExtension, com.vaadin.ui.Grid.AbstractRenderer<T>, com.vaadin.ui.Grid.AbstractSelectionModel, com.vaadin.ui.Grid.CellDescriptionGenerator, com.vaadin.ui.Grid.CellReference, com.vaadin.ui.Grid.CellStyleGenerator, com.vaadin.ui.Grid.Column, com.vaadin.ui.Grid.ColumnReorderEvent, com.vaadin.ui.Grid.ColumnReorderListener, com.vaadin.ui.Grid.ColumnResizeEvent, com.vaadin.ui.Grid.ColumnResizeListener, com.vaadin.ui.Grid.ColumnVisibilityChangeEvent, com.vaadin.ui.Grid.ColumnVisibilityChangeListener, com.vaadin.ui.Grid.CommitErrorEvent, com.vaadin.ui.Grid.DefaultEditorErrorHandler, com.vaadin.ui.Grid.DetailComponentManager, com.vaadin.ui.Grid.DetailsGenerator, com.vaadin.ui.Grid.EditorCloseEvent, com.vaadin.ui.Grid.EditorErrorHandler, com.vaadin.ui.Grid.EditorEvent, com.vaadin.ui.Grid.EditorFieldFactory, com.vaadin.ui.Grid.EditorListener, com.vaadin.ui.Grid.EditorMoveEvent, com.vaadin.ui.Grid.EditorOpenEvent, com.vaadin.ui.Grid.Footer, com.vaadin.ui.Grid.FooterCell, com.vaadin.ui.Grid.FooterRow, com.vaadin.ui.Grid.GridContextClickEvent, com.vaadin.ui.Grid.Header, com.vaadin.ui.Grid.HeaderCell, com.vaadin.ui.Grid.HeaderRow, com.vaadin.ui.Grid.MultiSelectionModel, com.vaadin.ui.Grid.NoSelectionModel, com.vaadin.ui.Grid.RowDescriptionGenerator, com.vaadin.ui.Grid.RowReference, com.vaadin.ui.Grid.RowStyleGenerator, com.vaadin.ui.Grid.SelectionMode, com.vaadin.ui.Grid.SelectionModel, com.vaadin.ui.Grid.SingleSelectionModel, com.vaadin.ui.Grid.StaticSection<ROWTYPE extends com.vaadin.ui.Grid.StaticSection.StaticRow<?>>

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.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
UIGrid(UIComponentData data)

Method Summary

Modifier and Type	Method and Description
protected void	applyColumnHints()
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
void	attach()
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
Set<UIComponent>	getRefreshedComponents()
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.
void	refresh() This method is called from LSPS rendering engine.
void	registerChildren() Should register all child components in the screen.
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.Grid

addColumn, addColumn, addColumnProperty, addColumnReorderListener, addColumnResizeListener, addColumnVisibilityChangeListener, addFooterRowAt, addHeaderRowAt, addItemClickListener, addListener, addRow, addSelectionListener, addSortListener, appendFooterRow, appendHeaderRow, beforeClientResponse, cancelEditor, clearSortOrder, deselect, deselectAll, doCancelEditor, doEditItem, editItem, fireSelectionEvent, getCellDescriptionGenerator, getCellStyleGenerator, getColumn, getColumnResizeMode, getColumns, getContainerDataSource, getCustomAttributes, getDefaultHeaderRow, getDetailsGenerator, getEditedItemId, getEditorCancelCaption, getEditorErrorHandler, getEditorFieldFactory, getEditorFieldGroup, getEditorSaveCaption, getFooter, getFooterRow, getFooterRowCount, getFrozenColumnCount, getHeader, getHeaderRow, getHeaderRowCount, getHeightByRows, getHeightMode, getRowDescriptionGenerator, getRowStyleGenerator, getSelectedRow, getSelectedRows, getSelectionModel, getSortOrder, getState, getState, isColumnReorderingAllowed, isDetailsVisible, isEditorActive, isEditorBuffered, isEditorEnabled, isFooterVisible, isHeaderVisible, isRendered, isSelected, iterator, prependFooterRow, prependHeaderRow, readDesign, recalculateColumnWidths, refreshAllRows, refreshRows, removeAllColumns, removeColumn, removeColumnReorderListener, removeColumnResizeListener, removeColumnVisibilityChangeListener, removeFooterRow, removeFooterRow, removeHeaderRow, removeHeaderRow, removeItemClickListener, removeListener, removeSelectionListener, removeSortListener, saveEditor, scrollTo, scrollTo, scrollToEnd, scrollToStart, select, setCellDescriptionGenerator, setCellStyleGenerator, setColumnOrder, setColumnReorderingAllowed, setColumnResizeMode, setColumns, setContainerDataSource, setDefaultHeaderRow, setDetailsGenerator, setDetailsVisible, setEditorBuffered, setEditorCancelCaption, setEditorEnabled, setEditorErrorHandler, setEditorFieldFactory, setEditorFieldGroup, setEditorSaveCaption, setFooterVisible, setFrozenColumnCount, setHeaderVisible, setHeight, setHeightByRows, setHeightMode, setRowDescriptionGenerator, setRowStyleGenerator, setSelectionMode, setSelectionModel, setSortOrder, sort, sort, sort, writeDesign

Methods inherited from class com.vaadin.ui.AbstractFocusable

addBlurListener, addFocusListener, addListener, addListener, focus, getTabIndex, removeBlurListener, removeFocusListener, removeListener, removeListener, setTabIndex

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, 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, 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.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, 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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

UIGrid

public UIGrid(UIComponentData data)

Method Detail

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

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

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

toString

public String toString()

Overrides:

toString in class Object

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.

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.

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