Package org.opencms.ui.components
Class CmsAppViewLayout
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- com.vaadin.ui.AbstractComponentContainer
-
- com.vaadin.ui.AbstractLayout
-
- com.vaadin.ui.CssLayout
-
- org.opencms.ui.components.CmsAppViewLayout
-
- All Implemented Interfaces:
com.vaadin.event.ContextClickEvent.ContextClickNotifier
,com.vaadin.event.LayoutEvents.LayoutClickNotifier
,com.vaadin.event.MethodEventSource
,com.vaadin.event.SerializableEventListener
,com.vaadin.server.ClientConnector
,com.vaadin.server.Page.BrowserWindowResizeListener
,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
,java.io.Serializable
,java.lang.Iterable<com.vaadin.ui.Component>
,java.util.EventListener
,I_CmsAppUIContext
public class CmsAppViewLayout extends com.vaadin.ui.CssLayout implements I_CmsAppUIContext, com.vaadin.server.Page.BrowserWindowResizeListener
The layout used within the app view.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
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 CmsAppViewLayout(java.lang.String appId)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.vaadin.ui.Button
addPublishButton(I_CmsUpdateListener<java.lang.String> updateListener)
Adds the publish button to the toolbar.void
addToolbarButton(com.vaadin.ui.Component button)
Adds a toolbar button.void
addToolbarButtonRight(com.vaadin.ui.Component button)
Adds a toolbar button to the right hand side.void
browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent event)
void
clearToolbarButtons()
Removes the app's toolbar buttons.void
closePopupViews()
Closes the toolbar popup views.static com.vaadin.ui.Button
createPublishButton(I_CmsUpdateListener<java.lang.String> updateListener)
Creates the publish button.void
enableDefaultToolbarButtons(boolean enabled)
Enables or removes the default toolbar buttons.java.lang.String
getAppId()
Returns the app id.java.lang.Object
getAttribute(java.lang.String key)
Gets an attribute.void
hideToolbar()
Hides the the toolbar.void
removeToolbarButton(com.vaadin.ui.Component button)
Removes the given button from the toolbar.void
setAppContent(com.vaadin.ui.Component appContent)
Sets the app content component.void
setAppInfo(com.vaadin.ui.Component infoContent)
Sets the app info component.void
setAppTitle(java.lang.String title)
Sets the app title.void
setAttribute(java.lang.String key, java.lang.Object value)
Sets an attribute.void
setMenuDialogContext(I_CmsDialogContext context)
Sets the dialog context for context menu entries.void
showInfoArea(boolean show)
Sets the info grid visibility.void
showToolbar()
Shows the formerly hidden toolbar.void
updateOnChange()
Updates the ui context on site or project changes.void
updateUserInfo()
Updates the displayed user info.-
Methods inherited from class com.vaadin.ui.CssLayout
addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, beforeClientResponse, getComponent, getComponentCount, getComponentIndex, getCss, getState, getState, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, 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, 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, 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, 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
-
CmsAppViewLayout
public CmsAppViewLayout(java.lang.String appId)
Constructor.- Parameters:
appId
- the app id
-
-
Method Detail
-
createPublishButton
public static com.vaadin.ui.Button createPublishButton(I_CmsUpdateListener<java.lang.String> updateListener)
Creates the publish button.- Parameters:
updateListener
- the update listener- Returns:
- the publish button
-
addPublishButton
public com.vaadin.ui.Button addPublishButton(I_CmsUpdateListener<java.lang.String> updateListener)
Description copied from interface:I_CmsAppUIContext
Adds the publish button to the toolbar.- Specified by:
addPublishButton
in interfaceI_CmsAppUIContext
- Parameters:
updateListener
- the update listener, called after publishing- Returns:
- the added button
- See Also:
I_CmsAppUIContext.addPublishButton(org.opencms.ui.I_CmsUpdateListener)
-
addToolbarButton
public void addToolbarButton(com.vaadin.ui.Component button)
Description copied from interface:I_CmsAppUIContext
Adds a toolbar button.- Specified by:
addToolbarButton
in interfaceI_CmsAppUIContext
- Parameters:
button
- the button to add- See Also:
I_CmsAppUIContext.addToolbarButton(com.vaadin.ui.Component)
-
addToolbarButtonRight
public void addToolbarButtonRight(com.vaadin.ui.Component button)
Description copied from interface:I_CmsAppUIContext
Adds a toolbar button to the right hand side.- Specified by:
addToolbarButtonRight
in interfaceI_CmsAppUIContext
- Parameters:
button
- the button to add- See Also:
I_CmsAppUIContext.addToolbarButtonRight(com.vaadin.ui.Component)
-
browserWindowResized
public void browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent event)
- Specified by:
browserWindowResized
in interfacecom.vaadin.server.Page.BrowserWindowResizeListener
- See Also:
Page.BrowserWindowResizeListener.browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent)
-
clearToolbarButtons
public void clearToolbarButtons()
Description copied from interface:I_CmsAppUIContext
Removes the app's toolbar buttons.- Specified by:
clearToolbarButtons
in interfaceI_CmsAppUIContext
- See Also:
I_CmsAppUIContext.clearToolbarButtons()
-
closePopupViews
public void closePopupViews()
Closes the toolbar popup views.
-
enableDefaultToolbarButtons
public void enableDefaultToolbarButtons(boolean enabled)
Description copied from interface:I_CmsAppUIContext
Enables or removes the default toolbar buttons.These are the context menu and the quick launch drop down.
The default is
enabled = true
.- Specified by:
enableDefaultToolbarButtons
in interfaceI_CmsAppUIContext
- Parameters:
enabled
-true
to enable the buttons- See Also:
I_CmsAppUIContext.enableDefaultToolbarButtons(boolean)
-
getAppId
public java.lang.String getAppId()
Description copied from interface:I_CmsAppUIContext
Returns the app id.- Specified by:
getAppId
in interfaceI_CmsAppUIContext
- Returns:
- the app id
- See Also:
I_CmsAppUIContext.getAppId()
-
getAttribute
public java.lang.Object getAttribute(java.lang.String key)
Description copied from interface:I_CmsAppUIContext
Gets an attribute.- Specified by:
getAttribute
in interfaceI_CmsAppUIContext
- Parameters:
key
- the attribute key- Returns:
- the attribute value
- See Also:
I_CmsAppUIContext.getAttribute(java.lang.String)
-
hideToolbar
public void hideToolbar()
Description copied from interface:I_CmsAppUIContext
Hides the the toolbar.- Specified by:
hideToolbar
in interfaceI_CmsAppUIContext
- See Also:
I_CmsAppUIContext.hideToolbar()
-
removeToolbarButton
public void removeToolbarButton(com.vaadin.ui.Component button)
Description copied from interface:I_CmsAppUIContext
Removes the given button from the toolbar.- Specified by:
removeToolbarButton
in interfaceI_CmsAppUIContext
- Parameters:
button
- the button to remove- See Also:
I_CmsAppUIContext.removeToolbarButton(com.vaadin.ui.Component)
-
setAppContent
public void setAppContent(com.vaadin.ui.Component appContent)
Sets the app content component.- Specified by:
setAppContent
in interfaceI_CmsAppUIContext
- Parameters:
appContent
- the app content
-
setAppInfo
public void setAppInfo(com.vaadin.ui.Component infoContent)
Description copied from interface:I_CmsAppUIContext
Sets the app info component.- Specified by:
setAppInfo
in interfaceI_CmsAppUIContext
- Parameters:
infoContent
- the info component- See Also:
I_CmsAppUIContext.setAppInfo(com.vaadin.ui.Component)
-
setAppTitle
public void setAppTitle(java.lang.String title)
Description copied from interface:I_CmsAppUIContext
Sets the app title.- Specified by:
setAppTitle
in interfaceI_CmsAppUIContext
- Parameters:
title
- the app title- See Also:
I_CmsAppUIContext.setAppTitle(java.lang.String)
-
setAttribute
public void setAttribute(java.lang.String key, java.lang.Object value)
Description copied from interface:I_CmsAppUIContext
Sets an attribute.- Specified by:
setAttribute
in interfaceI_CmsAppUIContext
- Parameters:
key
- the attribute keyvalue
- the attribute value- See Also:
I_CmsAppUIContext.setAttribute(java.lang.String, java.lang.Object)
-
setMenuDialogContext
public void setMenuDialogContext(I_CmsDialogContext context)
Description copied from interface:I_CmsAppUIContext
Sets the dialog context for context menu entries.- Specified by:
setMenuDialogContext
in interfaceI_CmsAppUIContext
- Parameters:
context
- the dialog context- See Also:
I_CmsAppUIContext.setMenuDialogContext(org.opencms.ui.I_CmsDialogContext)
-
showInfoArea
public void showInfoArea(boolean show)
Description copied from interface:I_CmsAppUIContext
Sets the info grid visibility.- Specified by:
showInfoArea
in interfaceI_CmsAppUIContext
- Parameters:
show
-true
to show the info- See Also:
I_CmsAppUIContext.showInfoArea(boolean)
-
showToolbar
public void showToolbar()
Description copied from interface:I_CmsAppUIContext
Shows the formerly hidden toolbar.- Specified by:
showToolbar
in interfaceI_CmsAppUIContext
- See Also:
I_CmsAppUIContext.showToolbar()
-
updateOnChange
public void updateOnChange()
Description copied from interface:I_CmsAppUIContext
Updates the ui context on site or project changes.- Specified by:
updateOnChange
in interfaceI_CmsAppUIContext
- See Also:
I_CmsAppUIContext.updateOnChange()
-
updateUserInfo
public void updateUserInfo()
Description copied from interface:I_CmsAppUIContext
Updates the displayed user info.- Specified by:
updateUserInfo
in interfaceI_CmsAppUIContext
- See Also:
I_CmsAppUIContext.updateUserInfo()
-
-