Package org.opencms.gwt.client.ui
Class CmsQuickLauncher
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Composite
-
- org.opencms.gwt.client.ui.CmsMenuButton
-
- org.opencms.gwt.client.ui.CmsQuickLauncher
-
- All Implemented Interfaces:
com.google.gwt.event.dom.client.HasClickHandlers
,com.google.gwt.event.logical.shared.HasAttachHandlers
,com.google.gwt.event.shared.HasHandlers
,com.google.gwt.user.client.EventListener
,com.google.gwt.user.client.ui.HasVisibility
,com.google.gwt.user.client.ui.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
,I_CmsToolbarButton
public class CmsQuickLauncher extends CmsMenuButton implements I_CmsToolbarButton
The user info toolbar button.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsQuickLauncher.A_QuickLaunchHandler
Abstract class for standard handling of quick launh items.protected class
CmsQuickLauncher.FontIconHtml
The font icon HTML.protected static interface
CmsQuickLauncher.I_ButtonTemplates
The button HTML generator templates.static interface
CmsQuickLauncher.I_QuickLaunchHandler
The quick launch handler interface.class
CmsQuickLauncher.QuickLaunchButton
Button for an individual entry in the quick launch menu.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
BUTTON_HTML
Html for the menu button.protected static java.lang.String
FONT_ICON_PREFIX
The font icon HTML prefix.-
Fields inherited from class org.opencms.gwt.client.ui.CmsMenuButton
m_button, m_popup, m_resizeRegistration
-
-
Constructor Summary
Constructors Constructor Description CmsQuickLauncher()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
autoClose()
Called on auto close.protected void
fillItems(java.util.Collection<org.opencms.gwt.shared.CmsQuickLaunchData> quickLaunchData)
Fills the quick launch menu with buttons corresponding to the given quick launch beans.protected I_CmsToolbarHandler
getHandler()
Returns the container-page handler.boolean
isActive()
Returns whether this button is active (pushed, not disabled).void
onToolbarActivate()
Method executed when the button is activated.void
onToolbarClick()
Executed when the tool-bar button is clicked.void
onToolbarDeactivate()
Method executed when the button is deactivated.void
setActive(boolean active)
Sets the button to active (pushed, not disabled).void
setHandler(I_CmsToolbarHandler handler)
Sets the button handler.void
setQuicklaunchHandler(CmsQuickLauncher.I_QuickLaunchHandler handler)
Sets the quick launch handler and makes the button visible.-
Methods inherited from class org.opencms.gwt.client.ui.CmsMenuButton
addClickHandler, clear, closeMenu, disable, enable, getPopup, hide, hideMenu, isEnabled, isOpen, isOpenRight, onBrowserEvent, openMenu, setButtonDown, setButtonUp, setEnabled, setMenuWidget, setOpenRight, setToolbarMode, show
-
Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, render, render, resolvePotentialElement, setWidget
-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
-
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.opencms.gwt.client.ui.I_CmsToolbarButton
getTitle, setEnabled
-
-
-
-
Field Detail
-
BUTTON_HTML
public static final java.lang.String BUTTON_HTML
Html for the menu button.
-
FONT_ICON_PREFIX
protected static final java.lang.String FONT_ICON_PREFIX
The font icon HTML prefix.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsQuickLauncher
public CmsQuickLauncher()
Constructor.
-
-
Method Detail
-
isActive
public boolean isActive()
Description copied from interface:I_CmsToolbarButton
Returns whether this button is active (pushed, not disabled).- Specified by:
isActive
in interfaceI_CmsToolbarButton
- Returns:
true
if the button is active- See Also:
I_CmsToolbarButton.isActive()
-
onToolbarActivate
public void onToolbarActivate()
Description copied from interface:I_CmsToolbarButton
Method executed when the button is activated.- Specified by:
onToolbarActivate
in interfaceI_CmsToolbarButton
- See Also:
I_CmsToolbarButton.onToolbarActivate()
-
onToolbarClick
public void onToolbarClick()
Description copied from interface:I_CmsToolbarButton
Executed when the tool-bar button is clicked.- Specified by:
onToolbarClick
in interfaceI_CmsToolbarButton
- See Also:
I_CmsToolbarButton.onToolbarClick()
-
onToolbarDeactivate
public void onToolbarDeactivate()
Description copied from interface:I_CmsToolbarButton
Method executed when the button is deactivated.- Specified by:
onToolbarDeactivate
in interfaceI_CmsToolbarButton
- See Also:
I_CmsToolbarButton.onToolbarDeactivate()
-
setActive
public void setActive(boolean active)
Description copied from interface:I_CmsToolbarButton
Sets the button to active (pushed, not disabled).- Specified by:
setActive
in interfaceI_CmsToolbarButton
- Parameters:
active
-true
if active- See Also:
I_CmsToolbarButton.setActive(boolean)
-
setHandler
public void setHandler(I_CmsToolbarHandler handler)
Sets the button handler.- Parameters:
handler
- the button handler
-
setQuicklaunchHandler
public void setQuicklaunchHandler(CmsQuickLauncher.I_QuickLaunchHandler handler)
Sets the quick launch handler and makes the button visible.- Parameters:
handler
- the quick launch handler
-
autoClose
protected void autoClose()
Description copied from class:CmsMenuButton
Called on auto close.- Overrides:
autoClose
in classCmsMenuButton
- See Also:
CmsMenuButton.autoClose()
-
fillItems
protected void fillItems(java.util.Collection<org.opencms.gwt.shared.CmsQuickLaunchData> quickLaunchData)
Fills the quick launch menu with buttons corresponding to the given quick launch beans.- Parameters:
quickLaunchData
- the list of quick launch beans
-
getHandler
protected I_CmsToolbarHandler getHandler()
Returns the container-page handler.- Returns:
- the container-page handler
-
-