Package org.opencms.ui.apps.lists

Class CmsResultTable

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

org.opencms.ui.components.CmsResourceTable

org.opencms.ui.components.CmsFileTable

org.opencms.ui.apps.lists.CmsResultTable

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, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>

public class CmsResultTable
extends CmsFileTable

Table to display the list manager search results.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ui.components.CmsFileTable

CmsFileTable.FileEditHandler, CmsFileTable.FileFieldFactory, CmsFileTable.FileSorter, CmsFileTable.I_FolderSelectHandler

Nested classes/interfaces inherited from class org.opencms.ui.components.CmsResourceTable

CmsResourceTable.CategoryComparator, CmsResourceTable.CategoryLabel, CmsResourceTable.ColumnBuilder, CmsResourceTable.ColumnEntry, CmsResourceTable.ColumnSettingChangeHandler, CmsResourceTable.DefaultItemDescriptionGenerator, CmsResourceTable.I_ResourcePropertyProvider, CmsResourceTable.ItemContainer

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.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.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.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ID_SEPARATOR	Separator string used in item ids.

Fields inherited from class org.opencms.ui.components.CmsFileTable

DEFAULT_TABLE_PROPERTIES, m_currentResources

Fields inherited from class org.opencms.ui.components.CmsResourceTable

COLLAPSED, INVISIBLE, m_container, m_fileTable, m_propertyProviders

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	Description
CmsResultTable(I_CmsContextProvider contextProvider, Map<CmsResourceTableProperty,Integer> tableColumns)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	fillItem(CmsObject cms, CmsResource resource, Locale locale)	Fills the file item data.
String	getCurrentPageFirstItemId()	Returns the first visible item id.
String	getDateFieldKey()	Returns the date field key.
List<com.vaadin.v7.data.Item>	getSelectedItems()	Returns the currently selected items.
CmsUUID	getUUIDFromItemID(String itemId)	Returns the structure id to the given string item id.
void	setContentLocale(Locale locale)	Sets the content locale.
void	setCurrentPageFirstItemId(String itemId)	Sets the first visible item id.
void	setsetItemDescriptionGenerator(com.vaadin.v7.ui.AbstractSelect.ItemDescriptionGenerator generator)	Set the item description generator which generates tooltips for cells and rows in the Table.
void	update(Collection<CmsUUID> ids, boolean remove)	Updates all items with ids from the given list.

Methods inherited from class org.opencms.ui.components.CmsFileTable

addAdditionalStyleGenerator, applyWorkplaceAppSettings, clearFilters, containsId, filterTable, generateCsv, getContextProvider, getFirstVisibleItemIndex, getSelectedIds, getSelectedResources, getStateStyle, getTableSettings, handleSelection, isEditing, isEditProperty, openContextMenu, removeAdditionalStyleGenerator, restoreFilters, saveFilters, setActionColumnProperty, setContextProvider, setFirstVisibleItemIndex, setFolderSelectHandler, setMenuBuilder, setTableState, startEdit, stopEdit, updateColumnWidths, updateSorting

Methods inherited from class org.opencms.ui.components.CmsResourceTable

addPropertyProvider, clearSelection, fillItemDefault, fillTable, fillTable, fillTable, fillTable, getAllIds, getItemCount, getStateStyle, internalSetColumnCollapsed, isColumnVisible, itemIdsToUUIDs, removePropertyProvider, selectAll, setCollapsedColumns, setColumnSettingChangeHandler, setDragMode, setDropHandler, setValue

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, getState, getState, iterator, setCompositionRoot

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, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, 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, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Details

ID_SEPARATOR

protected static final String ID_SEPARATOR

Separator string used in item ids.

See Also:

• Constant Field Values

Constructor Details

CmsResultTable

public CmsResultTable(I_CmsContextProvider contextProvider,
 Map<CmsResourceTableProperty,Integer> tableColumns)

Constructor.

Parameters:

contextProvider - the context provider

tableColumns - the table columns

Method Details

getCurrentPageFirstItemId

public String getCurrentPageFirstItemId()

Returns the first visible item id.

Returns:

the first visible item id

getDateFieldKey

public String getDateFieldKey()

Returns the date field key.

Returns:

the date field key

getSelectedItems

public List<com.vaadin.v7.data.Item> getSelectedItems()

Returns the currently selected items.

Returns:

the selected items

getUUIDFromItemID

public CmsUUID getUUIDFromItemID(String itemId)

Description copied from class: CmsResourceTable

Returns the structure id to the given string item id.

Overrides:

getUUIDFromItemID in class CmsResourceTable

Parameters:

itemId - the item id

Returns:

the structure id

See Also:

• CmsResourceTable.getUUIDFromItemID(java.lang.String)

setContentLocale

public void setContentLocale(Locale locale)

Sets the content locale.

Parameters:

locale - the content locale

setCurrentPageFirstItemId

public void setCurrentPageFirstItemId(String itemId)

Sets the first visible item id.

Parameters:

itemId - the item id

setsetItemDescriptionGenerator

public void setsetItemDescriptionGenerator(com.vaadin.v7.ui.AbstractSelect.ItemDescriptionGenerator generator)

Set the item description generator which generates tooltips for cells and rows in the Table.

Parameters:

generator - the generator to use

update

public void update(Collection<CmsUUID> ids,
 boolean remove)

Description copied from class: CmsFileTable

Updates all items with ids from the given list.

Overrides:

update in class CmsFileTable

Parameters:

ids - the resource structure ids to update

remove - true if the item should be removed only

See Also:

• CmsFileTable.update(java.util.Collection, boolean)

fillItem

protected void fillItem(CmsObject cms,
 CmsResource resource,
 Locale locale)

Description copied from class: CmsResourceTable

Fills the file item data.

Overrides:

fillItem in class CmsResourceTable

Parameters:

cms - the cms context

resource - the resource

locale - the workplace locale

See Also:

• CmsResourceTable.fillItem(org.opencms.file.CmsObject, org.opencms.file.CmsResource, java.util.Locale)