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

Class UIPagedTable

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

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, Pager.PagedComponent, UIComponent, UIComponentShowingRecords, UIComponentWithCustomScopes, UIRefreshHandler, UIComponentWithHints2, Serializable, Iterable<com.vaadin.ui.Component>

public class UIPagedTable
extends UITableBase
implements Pager.PagedComponent

Standard Vaadin component for "ui::Table" with type == "paged".

Author:

mhi

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

Modifier and Type	Field and Description
protected com.vaadin.ui.Component	pager Pager component associated with the table

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
UIPagedTable(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
protected void	clearContent() Should remove old data from the data container.
protected com.vaadin.ui.Component	createPager(int pageSize, String componentIdPrefix) Creates pager for the table, which is providing user with capability to navigate through table pages.
protected AbstractDatasetVaadinAdapter	getDatasetAdapter()
protected void	refreshInt()
boolean	refreshPageData(int pageIndex, int pageSize) Will be called when the current page or page size is changed from the pager.
protected void	updatePager(int pageIndex, int dataCount) Refreshes the pager component for this table

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

addDynamicColumn, applyColumnHints, applyHint, attach, clearData, createTableColumn, createTableComponent, generateCell, getColumn, getColumns, getComponentData, getCurrentData, getFilterable, getFilterComponentForColumn, getItemId, getRefreshedComponents, getScope, getShownRecords, getStyle, getTable, 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.whitestein.lsps.vaadin.ui.components.UIComponent

getComponentData, getWidget, refresh

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

pager

protected com.vaadin.ui.Component pager

Pager component associated with the table

Constructor Detail

UIPagedTable

public UIPagedTable(UIComponentData componentData)

Parameters:

componentData -

Method Detail

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

refreshInt

protected void refreshInt()

Overrides:

refreshInt in class UITableBase

refreshPageData

public boolean refreshPageData(int pageIndex,
                               int pageSize)

Description copied from interface: Pager.PagedComponent

Will be called when the current page or page size is changed from the pager. The component should call Pager.update(int, int) within its implementation.

Specified by:

refreshPageData in interface Pager.PagedComponent

Parameters:

pageIndex - the page to display, zero based.

pageSize - number of items to show in the page.

Returns:

false if the change should be ignored

createPager

protected com.vaadin.ui.Component createPager(int pageSize,
                                              String componentIdPrefix)

Creates pager for the table, which is providing user with capability to navigate through table pages.

Parameters:

pageSize -

componentIdPrefix -

Returns:

created pager component

updatePager

protected void updatePager(int pageIndex,
                           int dataCount)

Refreshes the pager component for this table

Parameters:

pageIndex -

dataCount -

getDatasetAdapter

protected AbstractDatasetVaadinAdapter getDatasetAdapter()

Specified by:

getDatasetAdapter in class UITableBase