Package org.opencms.ui.components
Class CmsExtendedSiteSelector
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- com.vaadin.ui.AbstractListing<T>
-
- com.vaadin.ui.AbstractSingleSelect<T>
-
- com.vaadin.ui.ComboBox<CmsExtendedSiteSelector.SiteSelectorOption>
-
- org.opencms.ui.components.CmsExtendedSiteSelector
-
- All Implemented Interfaces:
com.vaadin.data.HasFilterableDataProvider<CmsExtendedSiteSelector.SiteSelectorOption,java.lang.String>
,com.vaadin.data.HasItems<CmsExtendedSiteSelector.SiteSelectorOption>
,com.vaadin.data.HasValue<CmsExtendedSiteSelector.SiteSelectorOption>
,com.vaadin.event.ContextClickEvent.ContextClickNotifier
,com.vaadin.event.FieldEvents.BlurNotifier
,com.vaadin.event.FieldEvents.FocusNotifier
,com.vaadin.event.MethodEventSource
,com.vaadin.server.ClientConnector
,com.vaadin.server.Sizeable
,com.vaadin.shared.Connector
,com.vaadin.ui.Component
,com.vaadin.ui.Component.Focusable
,com.vaadin.ui.SingleSelect<CmsExtendedSiteSelector.SiteSelectorOption>
,java.io.Serializable
public class CmsExtendedSiteSelector extends com.vaadin.ui.ComboBox<CmsExtendedSiteSelector.SiteSelectorOption>
Site selector widget which also optionally offers subsite options.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsExtendedSiteSelector.SiteSelectorOption
Class representing a single option.-
Nested classes/interfaces inherited from class com.vaadin.ui.ComboBox
com.vaadin.ui.ComboBox.CaptionFilter, com.vaadin.ui.ComboBox.DeclarativeStyleGenerator<T extends java.lang.Object>, com.vaadin.ui.ComboBox.FetchItemsCallback<T extends java.lang.Object>, com.vaadin.ui.ComboBox.NewItemHandler, com.vaadin.ui.ComboBox.NewItemProvider<T extends java.lang.Object>
-
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractListing
com.vaadin.ui.AbstractListing.AbstractListingExtension<T extends java.lang.Object>
-
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
-
-
Field Summary
Fields Modifier and Type Field Description static int
LONG_PAGE_LENGTH
Longer default page length for site selectors.
-
Constructor Summary
Constructors Constructor Description CmsExtendedSiteSelector()
Creates a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.List<CmsExtendedSiteSelector.SiteSelectorOption>
getExplorerSiteSelectorOptions(CmsObject cms, boolean addSubsites)
Builds a list of site selector option that also includes subsites with the 'include in site selector' option enabled in their configuration.void
initOptions(CmsObject cms, boolean addSubsites)
Initializes the select options.void
selectSite(java.lang.String siteRoot)
Selects a specific site.-
Methods inherited from class com.vaadin.ui.ComboBox
addBlurListener, addFocusListener, addValueChangeListener, attach, detach, getDataProvider, getEmptySelectionCaption, getItemCaptionGenerator, getItemIconGenerator, getNewItemHandler, getNewItemProvider, getPageLength, getPlaceholder, getPopupWidth, getState, getState, getStyleGenerator, isEmptySelectionAllowed, isScrollToSelectedItem, isTextInputAllowed, readItem, readItems, setDataProvider, setDataProvider, setDataProvider, setDataProvider, setEmptySelectionAllowed, setEmptySelectionCaption, setItemCaptionGenerator, setItemIconGenerator, setItems, setItems, setItems, setItems, setItems, setNewItemHandler, setNewItemProvider, setPageLength, setPlaceholder, setPopupWidth, setScrollToSelectedItem, setStyleGenerator, setTextInputAllowed, updateSelectedItemState, writeItem
-
Methods inherited from class com.vaadin.ui.AbstractSingleSelect
addSelectionListener, getCustomAttributes, getSelectedItem, getValue, isReadOnly, isRequiredIndicatorVisible, isSelected, keyToItem, setReadOnly, setRequiredIndicatorVisible, setSelectedItem, setSelectedItem, setValue
-
Methods inherited from class com.vaadin.ui.AbstractListing
addDataGenerator, deserializeDeclarativeRepresentation, doReadDesign, doWriteDesign, focus, getDataCommunicator, getTabIndex, internalGetDataProvider, internalSetDataProvider, internalSetDataProvider, readDesign, readItem, removeDataGenerator, serializeDeclarativeRepresentation, setTabIndex, writeDesign, writeItems
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined
-
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, 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, 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
-
-
-
-
Field Detail
-
LONG_PAGE_LENGTH
public static final int LONG_PAGE_LENGTH
Longer default page length for site selectors.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsExtendedSiteSelector
public CmsExtendedSiteSelector()
Creates a new instance.To actually use the widget, the initOptions method has to be called first.
-
-
Method Detail
-
getExplorerSiteSelectorOptions
public static java.util.List<CmsExtendedSiteSelector.SiteSelectorOption> getExplorerSiteSelectorOptions(CmsObject cms, boolean addSubsites)
Builds a list of site selector option that also includes subsites with the 'include in site selector' option enabled in their configuration.- Parameters:
cms
- the current CMS contextaddSubsites
- true if subsite options should be added- Returns:
- the the extended site selecctor options
-
initOptions
public void initOptions(CmsObject cms, boolean addSubsites)
Initializes the select options.- Parameters:
cms
- the CMS contextaddSubsites
- true if subsites should be shown
-
selectSite
public void selectSite(java.lang.String siteRoot)
Selects a specific site.- Parameters:
siteRoot
- the site root
-
-