Class ContextMenuCheckBoxItem

Object

UIObject

Widget

LabelBase<String>

Label

ContextMenuItem

ContextMenuCheckBoxItem

All Implemented Interfaces:

IsEditor<LeafValueEditor<String>>, ClickHandler, ContextMenuHandler, HasAllDragAndDropHandlers, HasAllGestureHandlers, HasAllMouseHandlers, HasAllTouchHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragEndHandlers, HasDragEnterHandlers, HasDragHandlers, HasDragLeaveHandlers, HasDragOverHandlers, HasDragStartHandlers, HasDropHandlers, HasGestureChangeHandlers, HasGestureEndHandlers, HasGestureStartHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasTouchCancelHandlers, HasTouchEndHandlers, HasTouchMoveHandlers, HasTouchStartHandlers, MouseOutHandler, MouseOverHandler, HasAttachHandlers, EventHandler, HasHandlers, HasDirection, HasDirectionEstimator, EventListener, HasAutoHorizontalAlignment, HasDirectionalText, HasEnabled, HasHorizontalAlignment, HasText, HasVisibility, HasWordWrap, IsWidget, SourcesClickEvents, SourcesMouseEvents

public class ContextMenuCheckBoxItem
extends ContextMenuItem

Component of the context menu extension to GWT's user interface.

Implements context menu items with a check box to indicate whether the menu item is active (checked) or not. The layout is controlled via CSS by adding (or removing) the class name checked if menu item is active (or not).

CSS Style Rules

Same as for ContextMenuItem plus

.gwt-ContextMenuItem-checked

if the context menu item is checked.

but cannot control a submenu.

Author:

Christoph Hauert

See Also:

• ContextMenu

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface HasDirection

HasDirection.Direction

Nested classes/interfaces inherited from interface HasHorizontalAlignment

HasHorizontalAlignment.AutoHorizontalAlignmentConstant, HasHorizontalAlignment.HorizontalAlignmentConstant

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isChecked	true if context menu item is checked.

Fields inherited from class ContextMenuItem

clickHandler, cmd, contextMenuHandler, mouseOutHandler, mouseOverHandler

Fields inherited from class Label

DEFAULT_DIRECTION_ESTIMATOR

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Fields inherited from interface HasAutoHorizontalAlignment

ALIGN_CONTENT_END, ALIGN_CONTENT_START

Fields inherited from interface HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Constructor Summary

Constructors

Constructor	Description
ContextMenuCheckBoxItem(String text, boolean isChecked, Scheduler.ScheduledCommand cmd)	Create new menu item with check box and the title text.
ContextMenuCheckBoxItem(String text, boolean isChecked, Scheduler.ScheduledCommand cmd, String key)	Create new menu item with check box and the title text.
ContextMenuCheckBoxItem(String text, Scheduler.ScheduledCommand cmd)	Create new menu item with check box and the title text.
ContextMenuCheckBoxItem(String text, Scheduler.ScheduledCommand cmd, String key)	Create new menu item with check box and the title text.

Method Summary

Modifier and Type	Method	Description
boolean	isChecked()	Check if menu item is active (checked).
protected void	onLoad()
void	setChecked(boolean checked)	Set state of check box in menu item to checked.

Methods inherited from class ContextMenuItem

action, close, closeNow, handlesKey, hasSubmenu, isEnabled, normalizeKey, onClick, onContextMenu, onMouseOut, onMouseOver, onUnload, open, setEnabled, setKey

Methods inherited from class Label

addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, asEditor, getDirection, getText, getTextDirection, removeClickListener, removeMouseListener, removeMouseWheelListener, setDirection, setText, setText, wrap

Methods inherited from class LabelBase

getAutoHorizontalAlignment, getDirectionEstimator, getHorizontalAlignment, getWordWrap, setAutoHorizontalAlignment, setDirectionEstimator, setDirectionEstimator, setHorizontalAlignment, setWordWrap, updateHorizontalAlignment

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class 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 Object

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

Methods inherited from interface HasHandlers

fireEvent

Field Details

isChecked

private boolean isChecked

true if context menu item is checked.

Constructor Details

ContextMenuCheckBoxItem

public ContextMenuCheckBoxItem(String text,
 Scheduler.ScheduledCommand cmd)

Create new menu item with check box and the title text. Initially the menu item is not checked. Clicking the menu item executes cmd.

Parameters:

text - title of menu item

cmd - command to execute when clicked

ContextMenuCheckBoxItem

public ContextMenuCheckBoxItem(String text,
 boolean isChecked,
 Scheduler.ScheduledCommand cmd)

Create new menu item with check box and the title text. Initially the menu item is not checked. Clicking the menu item executes cmd.

Parameters:

text - title of menu item

isChecked - true for checked menu item

cmd - command to execute when clicked

ContextMenuCheckBoxItem

public ContextMenuCheckBoxItem(String text,
 Scheduler.ScheduledCommand cmd,
 String key)

Create new menu item with check box and the title text. Initially the menu item is not checked. Clicking the menu item executes cmd and shows key as the keyboard hint.

Parameters:

text - title of menu item

cmd - command to execute when clicked

key - keyboard key label shown in the trailing column

ContextMenuCheckBoxItem

public ContextMenuCheckBoxItem(String text,
 boolean isChecked,
 Scheduler.ScheduledCommand cmd,
 String key)

Create new menu item with check box and the title text. Initially the menu item is not checked. Clicking the menu item executes cmd and shows key as the keyboard hint.

Parameters:

text - title of menu item

isChecked - true for checked menu item

cmd - command to execute when clicked

key - keyboard key label shown in the trailing column

Method Details

onLoad

protected void onLoad()

Overrides:

onLoad in class ContextMenuItem

setChecked

public void setChecked(boolean checked)

Set state of check box in menu item to checked.

Parameters:

checked - true to mark menu item as active (checked)

isChecked

public boolean isChecked()

Check if menu item is active (checked).

Returns:

true if active (checked)