Package org.opencms.ui.favorites
Class CmsFavoriteDialog
- 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
-
- org.opencms.ui.components.CmsBasicDialog
-
- org.opencms.ui.favorites.CmsFavoriteDialog
-
- 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.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
,java.io.Serializable
,java.lang.Iterable<com.vaadin.ui.Component>
,CmsEditableGroup.I_RowBuilder
public class CmsFavoriteDialog extends CmsBasicDialog implements CmsEditableGroup.I_RowBuilder
Dialog which shows the list of favorites for the current user and allows them to jump to individual favorites, edit the list, or add the current location to the favorite list.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
CmsFavoriteDialog.SaveAfterChangeActionHandler
Action handler that saves favorites after every change.-
Nested classes/interfaces inherited from class org.opencms.ui.components.CmsBasicDialog
CmsBasicDialog.DialogWidth
-
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
-
-
Constructor Summary
Constructors Constructor Description CmsFavoriteDialog(I_CmsFavoriteContext context, CmsFavoriteDAO favDao)
Creates a new dialog instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsFavInfo
buildRow(CmsEditableGroup group, com.vaadin.ui.Component component)
Builds a row for the given group by wrapping the given component.protected void
doSave()
Saves the list of currently displayed favorites.protected void
enableMaxHeight()
Adds the max height extension to the dialog panel.protected void
initEntries(java.util.List<CmsFavoriteEntry> entries)
Initializes the bookmark widgets.-
Methods inherited from class org.opencms.ui.components.CmsBasicDialog
addButton, addButton, createButtonCancel, createButtonClose, createButtonOK, createResourceListPanel, createResourceListPanelDirectly, displayResourceInfo, displayResourceInfo, displayResourceInfo, displayResourceInfoDirectly, getInfoResources, initActionHandler, prepareWindow, prepareWindow, readDesign, setAbove, setActionHandler, setBelow, setContent, setContentMinHeight, setContentVisibility, setWindowMinFullHeight
-
Methods inherited from class com.vaadin.ui.VerticalLayout
addComponentsAndExpand, getState, getState
-
Methods inherited from class com.vaadin.ui.AbstractOrderedLayout
addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign
-
Methods inherited from class com.vaadin.ui.AbstractComponentContainer
addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, 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, 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, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
-
Methods inherited from interface com.vaadin.ui.ComponentContainer
addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents
-
-
-
-
Constructor Detail
-
CmsFavoriteDialog
public CmsFavoriteDialog(I_CmsFavoriteContext context, CmsFavoriteDAO favDao) throws CmsException
Creates a new dialog instance.- Parameters:
context
- the favorite contextfavDao
- the favorite load/save handler- Throws:
CmsException
- if something goes wrong
-
-
Method Detail
-
buildRow
public CmsFavInfo buildRow(CmsEditableGroup group, com.vaadin.ui.Component component)
Description copied from interface:CmsEditableGroup.I_RowBuilder
Builds a row for the given group by wrapping the given component.- Specified by:
buildRow
in interfaceCmsEditableGroup.I_RowBuilder
- Parameters:
group
- the groupcomponent
- the component- Returns:
- the new row
- See Also:
CmsEditableGroup.I_RowBuilder.buildRow(org.opencms.ui.components.editablegroup.CmsEditableGroup, com.vaadin.ui.Component)
-
doSave
protected void doSave()
Saves the list of currently displayed favorites.
-
enableMaxHeight
protected void enableMaxHeight()
Description copied from class:CmsBasicDialog
Adds the max height extension to the dialog panel.- Overrides:
enableMaxHeight
in classCmsBasicDialog
- See Also:
CmsBasicDialog.enableMaxHeight()
-
initEntries
protected void initEntries(java.util.List<CmsFavoriteEntry> entries)
Initializes the bookmark widgets.- Parameters:
entries
- the list of bookmark entries
-
-