Class CmsSitemapHoverbar
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Panel
-
- com.google.gwt.user.client.ui.ComplexPanel
-
- com.google.gwt.user.client.ui.FlowPanel
-
- org.opencms.ade.sitemap.client.hoverbar.CmsSitemapHoverbar
-
- All Implemented Interfaces:
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.HasWidgets
,com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
,com.google.gwt.user.client.ui.IndexedPanel
,com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
,com.google.gwt.user.client.ui.InsertPanel
,com.google.gwt.user.client.ui.InsertPanel.ForIsWidget
,com.google.gwt.user.client.ui.IsWidget
,java.lang.Iterable<com.google.gwt.user.client.ui.Widget>
public final class CmsSitemapHoverbar extends com.google.gwt.user.client.ui.FlowPanel
Sitemap tree item hover-bar.- Since:
- 8.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
-
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.gwt.event.shared.HandlerRegistration
addHideHandler(I_CmsHoverbarHideHandler handler)
Adds a new detach event handler.com.google.gwt.event.shared.HandlerRegistration
addShowHandler(I_CmsHoverbarShowHandler handler)
Adds a new attach event handler.CmsSitemapController
getController()
Returns the controller.org.opencms.ade.sitemap.shared.CmsClientSitemapEntry
getEntry()
Returns the sitemap entry.org.opencms.util.CmsUUID
getId()
Gets the entry id.void
hide()
Detaches the hover bar.static CmsSitemapHoverbar
installOn(CmsSitemapController controller, CmsTreeItem treeItem, java.util.Collection<com.google.gwt.user.client.ui.Widget> buttons)
Installs a hover bar for the given item widget.static void
installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId)
Installs a hover bar for the given item widget.static CmsSitemapHoverbar
installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, boolean movable, boolean contextmenu, I_CmsContextMenuItemProvider menuItemProvider)
Installs a hover bar for the given item widget.static void
installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, java.lang.String sitePath, boolean contextmenu)
Installs a hover bar for the given item widget.static void
installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, I_CmsContextMenuItemProvider menuItemProvider)
Installs a hover bar for the given item widget.boolean
isHovered()
Returns if the bar is hovered.protected boolean
isLocked()
Returns if the hoverbar visibility is locked.protected void
loadEntry(com.google.gwt.user.client.rpc.AsyncCallback<org.opencms.ade.sitemap.shared.CmsClientSitemapEntry> callback)
Loads the sitemap entry.void
setAlwaysVisible()
Makes the hoverbar permanently visible.void
setEnabled(boolean enable, java.lang.String disableMessage)
Sets the buttons of the hoverbar enabled.protected void
setHovered(boolean hovered)
Sets the hovered state.void
setLocked(boolean locked)
Locks the hoverbar visibility.protected void
show()
Shows the hoverbar firing the appropriate event.-
Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove
-
Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, doAttachChildren, doDetachChildren, orphan, remove
-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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, resolvePotentialElement, 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 com.google.gwt.user.client.ui.IndexedPanel
getWidget, getWidgetCount, getWidgetIndex, remove
-
-
-
-
Method Detail
-
installOn
public static void installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId)
Installs a hover bar for the given item widget.- Parameters:
controller
- the controllertreeItem
- the item to hoverentryId
- the entry id
-
installOn
public static CmsSitemapHoverbar installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, boolean movable, boolean contextmenu, I_CmsContextMenuItemProvider menuItemProvider)
Installs a hover bar for the given item widget.- Parameters:
controller
- the controllertreeItem
- the item to hoverentryId
- the entry idmovable
- true if the item should be movablecontextmenu
- true if the item should have a context menumenuItemProvider
- provides items for the context menu- Returns:
- the installed hover bar
-
installOn
public static void installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, I_CmsContextMenuItemProvider menuItemProvider)
Installs a hover bar for the given item widget.- Parameters:
controller
- the controllertreeItem
- the item to hoverentryId
- the entry idmenuItemProvider
- the context menu item provider
-
installOn
public static void installOn(CmsSitemapController controller, CmsTreeItem treeItem, org.opencms.util.CmsUUID entryId, java.lang.String sitePath, boolean contextmenu)
Installs a hover bar for the given item widget.- Parameters:
controller
- the controllertreeItem
- the item to hoverentryId
- the entry idsitePath
- the entry site pathcontextmenu
- flag to control whether the context menu should be shown
-
installOn
public static CmsSitemapHoverbar installOn(CmsSitemapController controller, CmsTreeItem treeItem, java.util.Collection<com.google.gwt.user.client.ui.Widget> buttons)
Installs a hover bar for the given item widget.- Parameters:
controller
- the controllertreeItem
- the item to hoverbuttons
- the buttons- Returns:
- the hover bar instance
-
addHideHandler
public com.google.gwt.event.shared.HandlerRegistration addHideHandler(I_CmsHoverbarHideHandler handler)
Adds a new detach event handler.- Parameters:
handler
- the handler to add- Returns:
- the handler registration
-
addShowHandler
public com.google.gwt.event.shared.HandlerRegistration addShowHandler(I_CmsHoverbarShowHandler handler)
Adds a new attach event handler.- Parameters:
handler
- the handler to add- Returns:
- the handler registration
-
getController
public CmsSitemapController getController()
Returns the controller.- Returns:
- the controller
-
getEntry
public org.opencms.ade.sitemap.shared.CmsClientSitemapEntry getEntry()
Returns the sitemap entry.- Returns:
- the sitemap entry
-
getId
public org.opencms.util.CmsUUID getId()
Gets the entry id.- Returns:
- the entry id
-
hide
public void hide()
Detaches the hover bar.
-
isHovered
public boolean isHovered()
Returns if the bar is hovered.- Returns:
true
if hovered
-
setAlwaysVisible
public void setAlwaysVisible()
Makes the hoverbar permanently visible.
-
setEnabled
public void setEnabled(boolean enable, java.lang.String disableMessage)
Sets the buttons of the hoverbar enabled.- Parameters:
enable
- iftrue
the buttons will be enableddisableMessage
- message for disabling buttons
-
setLocked
public void setLocked(boolean locked)
Locks the hoverbar visibility.- Parameters:
locked
-true
to lock the hoverbar visibility
-
isLocked
protected boolean isLocked()
Returns if the hoverbar visibility is locked.- Returns:
true
if the hoverbar visibility is locked
-
loadEntry
protected void loadEntry(com.google.gwt.user.client.rpc.AsyncCallback<org.opencms.ade.sitemap.shared.CmsClientSitemapEntry> callback)
Loads the sitemap entry.- Parameters:
callback
- executed when the entry is loaded
-
setHovered
protected void setHovered(boolean hovered)
Sets the hovered state.- Parameters:
hovered
-true
if hovered
-
show
protected void show()
Shows the hoverbar firing the appropriate event.
-
-