org.opencms.ui.components.fileselect

Class CmsResourceTreeTable

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<java.lang.Object>

com.vaadin.v7.ui.AbstractSelect

com.vaadin.v7.ui.Table

com.vaadin.v7.ui.TreeTable

org.opencms.ui.components.fileselect.CmsResourceTreeTable

All Implemented Interfaces:

com.vaadin.event.Action.Container, com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.dd.DragSource, com.vaadin.event.dd.DropTarget, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasChildMeasurementHint, com.vaadin.ui.HasComponents, com.vaadin.ui.LegacyComponent, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Container, com.vaadin.v7.data.Container.Hierarchical, com.vaadin.v7.data.Container.ItemSetChangeListener, com.vaadin.v7.data.Container.ItemSetChangeNotifier, com.vaadin.v7.data.Container.Ordered, com.vaadin.v7.data.Container.PropertySetChangeListener, com.vaadin.v7.data.Container.PropertySetChangeNotifier, com.vaadin.v7.data.Container.Sortable, com.vaadin.v7.data.Container.Viewer, com.vaadin.v7.data.Property<java.lang.Object>, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.event.ItemClickEvent.ItemClickNotifier, com.vaadin.v7.ui.Field<java.lang.Object>, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener

public class CmsResourceTreeTable
extends com.vaadin.v7.ui.TreeTable

Tree subclass used to display VFS resource trees.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsResourceTreeTable.FileSorter Extends the default sorting to differentiate between files and folder when sorting by name.
class	CmsResourceTreeTable.StyleGenerator The style generator.

Nested classes/interfaces inherited from class com.vaadin.v7.ui.Table

com.vaadin.v7.ui.Table.Align, com.vaadin.v7.ui.Table.CacheUpdateException, com.vaadin.v7.ui.Table.CellStyleGenerator, com.vaadin.v7.ui.Table.ColumnCollapseEvent, com.vaadin.v7.ui.Table.ColumnCollapseListener, com.vaadin.v7.ui.Table.ColumnGenerator, com.vaadin.v7.ui.Table.ColumnHeaderMode, com.vaadin.v7.ui.Table.ColumnReorderEvent, com.vaadin.v7.ui.Table.ColumnReorderListener, com.vaadin.v7.ui.Table.ColumnResizeEvent, com.vaadin.v7.ui.Table.ColumnResizeListener, com.vaadin.v7.ui.Table.FooterClickEvent, com.vaadin.v7.ui.Table.FooterClickListener, com.vaadin.v7.ui.Table.GeneratedRow, com.vaadin.v7.ui.Table.HeaderClickEvent, com.vaadin.v7.ui.Table.HeaderClickListener, com.vaadin.v7.ui.Table.RowGenerator, com.vaadin.v7.ui.Table.RowHeaderMode, com.vaadin.v7.ui.Table.TableContextClickEvent, com.vaadin.v7.ui.Table.TableDragMode, com.vaadin.v7.ui.Table.TableDropCriterion, com.vaadin.v7.ui.Table.TableTransferable

Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractSelect

com.vaadin.v7.ui.AbstractSelect.AbstractSelectTargetDetails, com.vaadin.v7.ui.AbstractSelect.AcceptItem, com.vaadin.v7.ui.AbstractSelect.CaptionChangeListener, com.vaadin.v7.ui.AbstractSelect.DefaultNewItemHandler, com.vaadin.v7.ui.AbstractSelect.Filtering, com.vaadin.v7.ui.AbstractSelect.ItemCaptionMode, com.vaadin.v7.ui.AbstractSelect.ItemDescriptionGenerator, com.vaadin.v7.ui.AbstractSelect.NewItemHandler, com.vaadin.v7.ui.AbstractSelect.TargetItemIs, com.vaadin.v7.ui.AbstractSelect.VerticalLocationIs

Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField

com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Container

com.vaadin.v7.data.Container.Editor, com.vaadin.v7.data.Container.Filter, com.vaadin.v7.data.Container.Filterable, com.vaadin.v7.data.Container.Hierarchical, com.vaadin.v7.data.Container.Indexed, com.vaadin.v7.data.Container.ItemSetChangeEvent, com.vaadin.v7.data.Container.ItemSetChangeListener, com.vaadin.v7.data.Container.ItemSetChangeNotifier, com.vaadin.v7.data.Container.Ordered, com.vaadin.v7.data.Container.PropertySetChangeEvent, com.vaadin.v7.data.Container.PropertySetChangeListener, com.vaadin.v7.data.Container.PropertySetChangeNotifier, com.vaadin.v7.data.Container.SimpleFilterable, com.vaadin.v7.data.Container.Sortable, com.vaadin.v7.data.Container.Viewer

Nested classes/interfaces inherited from interface com.vaadin.ui.HasChildMeasurementHint

com.vaadin.ui.HasChildMeasurementHint.ChildMeasurementHint

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

Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field

com.vaadin.v7.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered

com.vaadin.v7.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property

com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyException, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.Transactional<T>, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTION_FOLDERS The folder caption column id.

Fields inherited from class com.vaadin.v7.ui.Table

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, alwaysRecalculateColumnWidths, CELL_FIRSTCOL, CELL_GENERATED_ROW, CELL_HEADER, CELL_ICON, CELL_ITEMID, CELL_KEY, COLUMN_HEADER_MODE_EXPLICIT, COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID, COLUMN_HEADER_MODE_HIDDEN, COLUMN_HEADER_MODE_ID, ROW_HEADER_MODE_EXPLICIT, ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID, ROW_HEADER_MODE_HIDDEN, ROW_HEADER_MODE_ICON_ONLY, ROW_HEADER_MODE_ID, ROW_HEADER_MODE_INDEX, ROW_HEADER_MODE_ITEM, ROW_HEADER_MODE_PROPERTY

Fields inherited from class com.vaadin.v7.ui.AbstractSelect

ITEM_CAPTION_MODE_EXPLICIT, ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID, ITEM_CAPTION_MODE_ICON_ONLY, ITEM_CAPTION_MODE_ID, ITEM_CAPTION_MODE_INDEX, ITEM_CAPTION_MODE_ITEM, ITEM_CAPTION_MODE_PROPERTY, itemIdMapper, items

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
CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceFilter filter) Creates a new instance.
CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceTreeContainer container) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler) Adds a resource selection handler.
void	expandItem(CmsUUID itemId) Expands the item with the given id.
CmsResourceTreeContainer	getTreeContainer() Gets the tree container.
void	removeResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler) Removes the given resource selection handler.
void	setSelectionFilter(com.google.common.base.Predicate<com.vaadin.v7.data.Item> selectionFilter) Sets the selection filter, a predicate that, by returning false for an item, can veto a tree entry selection.
void	showSitemapView(boolean showSitemap) Shows the sitemap view.

Methods inherited from class com.vaadin.v7.ui.TreeTable

addCollapseListener, addExpandListener, addListener, addListener, areChildrenAllowed, changeVariables, containerItemSetChange, fireCollapseEvent, fireExpandEvent, getAddedRowCount, getChildren, getContainerDataSource, getFirstAddedItemIndex, getFirstUpdatedItemIndex, getHierarchyColumnId, getIdByIndex, getItemIds, getItemIds, getParent, getState, getUpdatedRowCount, hasChildren, indexOfId, isAnimationsEnabled, isCollapsed, isLastId, isPartialRowUpdate, isRoot, lastItemId, nextItemId, paintContent, paintRowAttributes, paintRowIcon, prevItemId, readBody, readItem, removeCollapseListener, removeExpandListener, removeListener, removeListener, rootItemIds, rowHeadersAreEnabled, setAnimationsEnabled, setChildrenAllowed, setCollapsed, setContainerDataSource, setHierarchyColumn, setParent, shouldHideAddedRows, size, writeItem, writeItems, writeItems

Methods inherited from class com.vaadin.v7.ui.Table

addActionHandler, addColumnCollapseListener, addColumnReorderListener, addColumnResizeListener, addContainerProperty, addContainerProperty, addFooterClickListener, addGeneratedColumn, addHeaderClickListener, addItem, addItemAfter, addItemAfter, addItemClickListener, addListener, addListener, addListener, addListener, addListener, attach, beforeClientResponse, bindPropertyToField, containerPropertySetChange, detach, disableContentRefreshing, enableContentRefreshing, firstItemId, formatPropertyValue, getCacheRate, getCellStyleGenerator, getChildMeasurementHint, getCollapseMenuContent, getColumnAlignment, getColumnAlignments, getColumnExpandRatio, getColumnFooter, getColumnGenerator, getColumnHeader, getColumnHeaderMode, getColumnHeaders, getColumnIcon, getColumnIcons, getColumnWidth, getComponentIterator, getConverter, getCurrentPageFirstItemId, getCurrentPageFirstItemIndex, getCustomAttributes, getDragMode, getDropHandler, getItemDescriptionGenerator, getMultiSelectMode, getPageLength, getPropertyValue, getRowGenerator, getRowHeaderMode, getSortableContainerPropertyIds, getSortContainerPropertyId, getState, getTableFieldFactory, getTransferable, getVisibleColumns, getVisibleItemIds, hasConverter, isColumnCollapsed, isColumnCollapsible, isColumnCollapsingAllowed, isColumnReorderingAllowed, isEditable, isFirstId, isFooterVisible, isRowCacheInvalidated, isSelectable, isSortAscending, isSortDisabled, isSortEnabled, iterator, markAsDirty, markAsDirtyRecursive, paintRowHeader, readDesign, readItems, refreshRenderedCells, refreshRowCache, registerComponent, removeActionHandler, removeAllActionHandlers, removeAllItems, removeColumnCollapseListener, removeColumnReorderListener, removeColumnResizeListener, removeContainerProperty, removeFooterClickListener, removeGeneratedColumn, removeHeaderClickListener, removeItem, removeItemClickListener, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, resetPageBuffer, setCacheRate, setCellStyleGenerator, setChildMeasurementHint, setCollapseMenuContent, setColumnAlignment, setColumnAlignments, setColumnCollapsed, setColumnCollapsible, setColumnCollapsingAllowed, setColumnExpandRatio, setColumnFooter, setColumnHeader, setColumnHeaderMode, setColumnHeaders, setColumnIcon, setColumnIcons, setColumnReorderingAllowed, setColumnWidth, setContainerDataSource, setConverter, setCurrentPageFirstItemId, setCurrentPageFirstItemIndex, setDragMode, setDropHandler, setEditable, setEnabled, setFooterVisible, setItemDescriptionGenerator, setMultiSelectMode, setNewItemsAllowed, setPageLength, setRowGenerator, setRowHeaderMode, setSelectable, setSortAscending, setSortContainerPropertyId, setSortDisabled, setSortEnabled, setTableFieldFactory, setVisible, setVisibleColumns, sort, sort, translateDropTargetDetails, unregisterComponent, valueChange, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractSelect

addItem, addItem, addItems, addItems, addItemSetChangeListener, addListener, addListener, addPropertySetChangeListener, containsId, fireItemSetChange, firePropertySetChange, getCaptionChangeListener, getContainerProperty, getContainerPropertyIds, getItem, getItemCaption, getItemCaptionMode, getItemCaptionPropertyId, getItemIcon, getItemIconPropertyId, getListeners, getNewItemHandler, getNullSelectionItemId, getType, getType, getValue, isEmpty, isMultiSelect, isNewItemsAllowed, isNullSelectionAllowed, isSelected, paintItem, removeItemSetChangeListener, removeListener, removeListener, removePropertySetChangeListener, sanitizeSelection, select, setItemCaption, setItemCaptionMode, setItemCaptionPropertyId, setItemIcon, setItemIconPropertyId, setMultiSelect, setNewItemHandler, setNullSelectionAllowed, setNullSelectionItemId, setValue, setValue, unselect

Methods inherited from class com.vaadin.v7.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, clear, commit, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, shouldHideErrors, validate, validate

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setHeight, setHeight, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, 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, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, 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.v7.data.Container.Hierarchical

removeItem

Methods inherited from interface com.vaadin.v7.data.Container

addContainerProperty, addItem, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getType, removeAllItems, removeContainerProperty

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, removeAttachListener, removeDetachListener, removeExtension, 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.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Field Detail

CAPTION_FOLDERS

public static final java.lang.String CAPTION_FOLDERS

The folder caption column id.

See Also:

Constant Field Values

Constructor Detail

CmsResourceTreeTable

public CmsResourceTreeTable(CmsObject cms,
                            CmsResource root,
                            CmsResourceFilter filter)

Creates a new instance.

Parameters:

cms - the CMS context

root - the root resource

filter - the resource filter

CmsResourceTreeTable

public CmsResourceTreeTable(CmsObject cms,
                            CmsResource root,
                            CmsResourceTreeContainer container)

Creates a new instance.

Parameters:

cms - the CMS context

root - the root resource

container - the data container for the tree

Method Detail

addResourceSelectionHandler

public void addResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler)

Adds a resource selection handler.

Parameters:

handler - the resource selection handler

expandItem

public void expandItem(CmsUUID itemId)

Expands the item with the given id.

Parameters:

itemId - the item id

getTreeContainer

public CmsResourceTreeContainer getTreeContainer()

Gets the tree container.

Returns:

the tree container

removeResourceSelectionHandler

public void removeResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler)

Removes the given resource selection handler.

Parameters:

handler - the resource selection handler

setSelectionFilter

public void setSelectionFilter(com.google.common.base.Predicate<com.vaadin.v7.data.Item> selectionFilter)

Sets the selection filter, a predicate that, by returning false for an item, can veto a tree entry selection.

Parameters:

selectionFilter - the selection filter

showSitemapView

public void showSitemapView(boolean showSitemap)

Shows the sitemap view.

Parameters:

showSitemap - true to show the sitemap view