org.opencms.ui.components

Class CmsFileTable

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

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

Direct Known Subclasses:

CmsProjectFiles

public class CmsFileTable
extends CmsResourceTable

Table for displaying resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CmsFileTable.FileEditHandler File edit handler.
class	CmsFileTable.FileFieldFactory Field factory to enable inline editing of individual file properties.
static class	CmsFileTable.FileSorter Extends the default sorting to differentiate between files and folder when sorting by name.
static interface	CmsFileTable.I_FolderSelectHandler Handles folder selects in the file table.

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

CmsResourceTable.ColumnBuilder, CmsResourceTable.ColumnEntry, CmsResourceTable.ItemContainer

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 java.util.List<CmsResource>	m_currentResources The selected resources.

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

COLLAPSED, INVISIBLE, m_container, m_fileTable

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
CmsFileTable(I_CmsContextProvider contextProvider) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	filterTable(java.lang.String search) Filters the displayed resources.
int	getFirstVisibleItemIndex() Returns the index of the first visible item.
java.util.Set<CmsUUID>	getSelectedIds() Gets the selected structure ids.
java.util.List<CmsResource>	getSelectedResources() Gets the list of selected resources.
static java.lang.String	getStateStyle(com.vaadin.data.Item resourceItem) Returns the resource state specific style name.
CmsFileExplorerSettings	getTableSettings() Returns the current table state.
void	handleSelection(CmsUUID itemId) Handles the item selection.
boolean	isEditing() Returns if a file property is being edited.
boolean	isEditProperty(CmsResourceTableProperty propertyId) Returns if the given property is being edited.
void	openContextMenu(com.vaadin.event.ItemClickEvent event) Opens the context menu.
void	setActionColumnProperty(CmsResourceTableProperty actionColumnProperty) Sets the default action column property.
protected void	setContextProvider(I_CmsContextProvider provider) Sets the dialog context provider.
void	setFirstVisibleItemIndex(int i) Sets the first visible item index.
void	setFolderSelectHandler(CmsFileTable.I_FolderSelectHandler folderSelectHandler) Sets the folder select handler.
void	setMenuBuilder(I_CmsContextMenuBuilder builder) Sets the menu builder.
void	setTableState(CmsFileExplorerSettings state) Sets the table state.
void	startEdit(CmsUUID itemId, CmsResourceTableProperty propertyId, I_CmsFilePropertyEditHandler editHandler) Starts inline editing of the given file property.
void	stopEdit() Stops the current edit process to save the changed property value.
void	update(CmsUUID id, boolean remove) Updates all items with ids from the given list.
void	updateColumnWidths(int estimatedSpace) Updates the column widths.
void	updateSorting() Updates the file table sorting.

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

clearSelection, fillItem, fillItemDefault, fillTable, getAllIds, getItemCount, getStateStyle, isColumnVisible, selectAll, setCollapsedColumns, setDragMode, setDropHandler

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, 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, 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, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

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

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

Field Detail

m_currentResources

protected java.util.List<CmsResource> m_currentResources

The selected resources.

Constructor Detail

CmsFileTable

public CmsFileTable(I_CmsContextProvider contextProvider)

Default constructor.

Parameters:

contextProvider - the dialog context provider

Method Detail

getStateStyle

public static java.lang.String getStateStyle(com.vaadin.data.Item resourceItem)

Returns the resource state specific style name.

Parameters:

resourceItem - the resource item

Returns:

the style name

filterTable

public void filterTable(java.lang.String search)

Filters the displayed resources.

Only resources where either the resource name, the title or the nav-text contains the given substring are shown.

Parameters:

search - the search term

getFirstVisibleItemIndex

public int getFirstVisibleItemIndex()

Returns the index of the first visible item.

Returns:

the first visible item

getSelectedIds

public java.util.Set<CmsUUID> getSelectedIds()

Gets the selected structure ids.

Returns:

the set of selected structure ids

getSelectedResources

public java.util.List<CmsResource> getSelectedResources()

Gets the list of selected resources.

Returns:

the list of selected resources

getTableSettings

public CmsFileExplorerSettings getTableSettings()

Returns the current table state.

Returns:

the table state

handleSelection

public void handleSelection(CmsUUID itemId)

Handles the item selection.

Parameters:

itemId - the selected item id

isEditing

public boolean isEditing()

Returns if a file property is being edited.

Returns:

true if a file property is being edited

isEditProperty

public boolean isEditProperty(CmsResourceTableProperty propertyId)

Returns if the given property is being edited.

Parameters:

propertyId - the property id

Returns:

true if the given property is being edited

openContextMenu

public void openContextMenu(com.vaadin.event.ItemClickEvent event)

Opens the context menu.

Parameters:

event - the click event

setActionColumnProperty

public void setActionColumnProperty(CmsResourceTableProperty actionColumnProperty)

Sets the default action column property.

Parameters:

actionColumnProperty - the default action column property

setFirstVisibleItemIndex

public void setFirstVisibleItemIndex(int i)

Sets the first visible item index.

Parameters:

i - the item index

setFolderSelectHandler

public void setFolderSelectHandler(CmsFileTable.I_FolderSelectHandler folderSelectHandler)

Sets the folder select handler.

Parameters:

folderSelectHandler - the folder select handler

setMenuBuilder

public void setMenuBuilder(I_CmsContextMenuBuilder builder)

Sets the menu builder.

Parameters:

builder - the menu builder

setTableState

public void setTableState(CmsFileExplorerSettings state)

Sets the table state.

Parameters:

state - the table state

startEdit

public void startEdit(CmsUUID itemId,
                      CmsResourceTableProperty propertyId,
                      I_CmsFilePropertyEditHandler editHandler)

Starts inline editing of the given file property.

Parameters:

itemId - the item resource structure id

propertyId - the property to edit

editHandler - the edit handler

stopEdit

public void stopEdit()

Stops the current edit process to save the changed property value.

update

public void update(CmsUUID id,
                   boolean remove)

Updates all items with ids from the given list.

Parameters:

id - the resource structure id to update

remove - true if the item should be removed only

updateColumnWidths

public void updateColumnWidths(int estimatedSpace)

Updates the column widths.

The reason this is needed is that the Vaadin table does not support minimum widths for columns, so expanding columns get squished when most of the horizontal space is used by other columns. So we try to determine whether the expanded columns would have enough space, and if not, give them a fixed width.

Parameters:

estimatedSpace - the estimated horizontal space available for the table.

updateSorting

public void updateSorting()

Updates the file table sorting.

setContextProvider

protected void setContextProvider(I_CmsContextProvider provider)

Sets the dialog context provider.

Parameters:

provider - the dialog context provider