org.opencms.gwt.client.ui.contextmenu

类 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

所有已实现的接口:

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.

从以下版本开始:

version 8.0.0

嵌套类概要

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

字段概要

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsContextMenu(java.util.List<I_CmsContextMenuEntry> menuData, boolean isFixed, I_CmsAutoHider autoHideParent) Constructor.

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

从类继承的方法 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

从类继承的方法 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, unsinkEvents

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsContextMenu

public CmsContextMenu(java.util.List<I_CmsContextMenuEntry> menuData,
              boolean isFixed,
              I_CmsAutoHider autoHideParent)

Constructor.

参数:

menuData - the data structure for the context menu

isFixed - indicating if the position of the menu should be fixed.

autoHideParent - the menu auto hide parent

方法详细资料

addAutoHidePartner

public void addAutoHidePartner(com.google.gwt.dom.client.Element partner)

从接口复制的说明: I_CmsAutoHider

Mouse events that occur within an autoHide partner will not hide a panel set to autoHide.

指定者:

addAutoHidePartner 在接口中 I_CmsAutoHider

参数:

partner - the auto hide partner to add

另请参阅:

I_CmsAutoHider.addAutoHidePartner(com.google.gwt.dom.client.Element)

addItem

public void addItem(A_CmsContextMenuItem item)

Adds a menu item to this menu.

参数:

item - the item to be added

addSeparator

public void addSeparator()

Adds a separator to this menu.

hide

public void hide()

从接口复制的说明: I_CmsAutoHider

Hides the widget.

指定者:

hide 在接口中 I_CmsAutoHider

另请参阅:

I_CmsAutoHider.hide()

hideAll

public void hideAll()

Hides this menu and all its parent menus.

isAutoHideEnabled

public boolean isAutoHideEnabled()

从接口复制的说明: I_CmsAutoHider

Returns if the auto hide feature is enabled.

指定者:

isAutoHideEnabled 在接口中 I_CmsAutoHider

返回:

true if auto hide is enabled

另请参阅:

I_CmsAutoHider.isAutoHideEnabled()

isAutoHideOnHistoryEventsEnabled

public boolean isAutoHideOnHistoryEventsEnabled()

从接口复制的说明: I_CmsAutoHider

Returns if the auto hide on history event feature is enabled.

指定者:

isAutoHideOnHistoryEventsEnabled 在接口中 I_CmsAutoHider

返回:

true if auto hide is enabled

另请参阅:

I_CmsAutoHider.isAutoHideOnHistoryEventsEnabled()

onResize

public 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.

指定者:

onResize 在接口中 com.google.gwt.event.logical.shared.ResizeHandler

另请参阅:

ResizeHandler.onResize(com.google.gwt.event.logical.shared.ResizeEvent)

removeAutoHidePartner

public void removeAutoHidePartner(com.google.gwt.dom.client.Element partner)

从接口复制的说明: I_CmsAutoHider

Removes an auto-hide partner.

指定者:

removeAutoHidePartner 在接口中 I_CmsAutoHider

参数:

partner - the auto-hide partner to remove

另请参阅:

I_CmsAutoHider.removeAutoHidePartner(com.google.gwt.dom.client.Element)

setAutoHideEnabled

public void setAutoHideEnabled(boolean autoHide)

从接口复制的说明: I_CmsAutoHider

Enable or disable the autoHide feature. When enabled, the popup will be automatically hidden when the user clicks outside of it.

指定者:

setAutoHideEnabled 在接口中 I_CmsAutoHider

参数:

autoHide - enable true to enable, false to disable

另请参阅:

I_CmsAutoHider.setAutoHideEnabled(boolean)

setAutoHideOnHistoryEventsEnabled

public void setAutoHideOnHistoryEventsEnabled(boolean enabled)

从接口复制的说明: I_CmsAutoHider

Enable or disable autoHide on history change events. When enabled, the popup will be automatically hidden when the history token changes, such as when the user presses the browser's back button. Disabled by default.

指定者:

setAutoHideOnHistoryEventsEnabled 在接口中 I_CmsAutoHider

参数:

enabled - enable true to enable, false to disable

另请参阅:

I_CmsAutoHider.setAutoHideOnHistoryEventsEnabled(boolean)

setParentItem

public void setParentItem(A_CmsContextMenuItem parentItem)

Sets the parent item.

参数:

parentItem - the parent item

getSelectedItem

protected A_CmsContextMenuItem getSelectedItem()

Returns the selected item of this menu.

返回:

the selected item of this menu

onClose

protected void onClose()

Action on close.

On close all sub menus should be hidden, the currently selected item should be deselected and the popup will be closed.

openPopup

protected void openPopup(A_CmsContextMenuItem item)

Opens a sub menu and sets its position.

参数:

item - the item to show the sub menu of

setSelectedItem

protected void setSelectedItem(A_CmsContextMenuItem selectedItem)

Sets the selected item of this menu.

参数:

selectedItem - the item to select

setSubMenuPosition

protected void setSubMenuPosition(A_CmsContextMenuItem item)

Sets the position of the sub menu popup.

First calculates the best space where to show the popup.

The following list shows the possibilities, beginning with the best and ending with the worst.

• bottom-right
• bottom-left
• top-right
• top-left

Then the position (top and left coordinate) are calculated.

Finally the position of the sub menu popup is set to the calculated values.

参数:

item - the item to show the sub menu of