Package org.opencms.gwt.client.ui.contextmenu

Class CmsContextMenu

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.contextmenu.CmsContextMenu
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.ResizeHandler, com.google.gwt.event.shared.EventHandler, 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_CmsAutoHider
public class CmsContextMenu extends com.google.gwt.user.client.ui.Composite implements com.google.gwt.event.logical.shared.ResizeHandler, I_CmsAutoHider
A implementation for a context menu.

Since:
version 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

  • Field Summary

    Fields inherited from class com.google.gwt.user.client.ui.UIObject

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsContextMenu(List<I_CmsContextMenuEntry> menuData, boolean isFixed, I_CmsAutoHider autoHideParent)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAutoHidePartner(com.google.gwt.dom.client.Element partner)
    Mouse events that occur within an autoHide partner will not hide a panel set to autoHide.
    void
    addItem(A_CmsContextMenuItem item)
    Adds a menu item to this menu.
    void
    addSeparator()
    Adds a separator to this menu.
    protected A_CmsContextMenuItem
    getSelectedItem()
    Returns the selected item of this menu.
    void
    hide()
    Hides the widget.
    void
    hideAll()
    Hides this menu and all its parent menus.
    boolean
    isAutoHideEnabled()
    Returns if the auto hide feature is enabled.
    boolean
    isAutoHideOnHistoryEventsEnabled()
    Returns if the auto hide on history event feature is enabled.
    protected void
    onClose()
    Action on close.
    void
    onResize(com.google.gwt.event.logical.shared.ResizeEvent event)
    If the browser's window is resized this method rearranges the sub menus of the selected item.
    protected void
    openPopup(A_CmsContextMenuItem item)
    Opens a sub menu and sets its position.
    void
    removeAutoHidePartner(com.google.gwt.dom.client.Element partner)
    Removes an auto-hide partner.
    void
    setAutoHideEnabled(boolean autoHide)
    Enable or disable the autoHide feature.
    void
    setAutoHideOnHistoryEventsEnabled(boolean enabled)
    Enable or disable autoHide on history change events.
    void
    setParentItem(A_CmsContextMenuItem parentItem)
    Sets the parent item.
    protected void
    setSelectedItem(A_CmsContextMenuItem selectedItem)
    Sets the selected item of this menu.
    protected void
    setSubMenuPosition(A_CmsContextMenuItem item)
    Sets the position of the sub menu popup.

    Methods inherited from class com.google.gwt.user.client.ui.Composite

    claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, 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