com.sencha.gxt.widget.core.client.menu

Class CheckMenuItem

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.menu.Item

com.sencha.gxt.widget.core.client.menu.MenuItem

com.sencha.gxt.widget.core.client.menu.CheckMenuItem

All Implemented Interfaces:

HasAttachHandlers, HasBeforeSelectionHandlers<Item>, HasResizeHandlers, HasSelectionHandlers<Item>, HasHandlers, HasSafeHtml, EventListener, HasEnabled, HasHTML, HasText, HasVisibility, IsWidget, ActivateEvent.HasActivateHandlers<Item>, BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<CheckMenuItem>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CheckChangeEvent.HasCheckChangeHandlers<CheckMenuItem>, DeactivateEvent.HasDeactivateHandlers<Item>, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasIcon, HasItemId

public class CheckMenuItem
extends MenuItem
implements BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<CheckMenuItem>, CheckChangeEvent.HasCheckChangeHandlers<CheckMenuItem>

Adds a menu item that contains a checkbox by default, but can also be part of a radio group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CheckMenuItem.CheckMenuItemAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.menu.MenuItem

MenuItem.MenuItemAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.menu.Item

Item.ItemAppearance

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CheckMenuItem() Creates a new check menu item.
CheckMenuItem(CheckMenuItem.CheckMenuItemAppearance appearance)
CheckMenuItem(String text) Creates a new check menu item.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addBeforeCheckChangeHandler(BeforeCheckChangeEvent.BeforeCheckChangeHandler<CheckMenuItem> handler) Adds a BeforeCheckChangeEvent.BeforeCheckChangeHandler handler for BeforeCheckChangeEvent events.
HandlerRegistration	addCheckChangeHandler(CheckChangeEvent.CheckChangeHandler<CheckMenuItem> handler) Adds a CheckChangeEvent.CheckChangeHandler handler for CheckChangeEvent events.
String	getAriaGroupTitle() Returns the ARIA group title.
CheckMenuItem.CheckMenuItemAppearance	getCheckMenuItemAppearance()
String	getGroup() Returns the group name.
boolean	isChecked() Returns true if the item is checked.
void	setAriaGroupTitle(String title) Sets the title attribute on the group container element.
void	setChecked(boolean checked) Set the checked state of this item.
void	setChecked(boolean state, boolean suppressEvent) Set the checked state of this item.
void	setGroup(String group) All check items with the same group name will automatically be grouped into a single-select radio button group (defaults to null).

Methods inherited from class com.sencha.gxt.widget.core.client.menu.MenuItem

expandMenu, getAppearance, getHTML, getIcon, getSubMenu, getText, setHTML, setHTML, setIcon, setSubMenu, setText, setWidget

Methods inherited from class com.sencha.gxt.widget.core.client.menu.Item

addActivateHandler, addBeforeSelectionHandler, addDeactivateHandler, addSelectionHandler, getHideOnClick, isCanActivate, setCanActivate, setHideOnClick

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

CheckMenuItem

public CheckMenuItem()

Creates a new check menu item.

CheckMenuItem

public CheckMenuItem(CheckMenuItem.CheckMenuItemAppearance appearance)

CheckMenuItem

public CheckMenuItem(String text)

Creates a new check menu item.

Parameters:

text - the text

Method Detail

addBeforeCheckChangeHandler

public HandlerRegistration addBeforeCheckChangeHandler(BeforeCheckChangeEvent.BeforeCheckChangeHandler<CheckMenuItem> handler)

Description copied from interface: BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers

Adds a BeforeCheckChangeEvent.BeforeCheckChangeHandler handler for BeforeCheckChangeEvent events.

Specified by:

addBeforeCheckChangeHandler in interface BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<CheckMenuItem>

Parameters:

handler - the handler

Returns:

the registration for the event

addCheckChangeHandler

public HandlerRegistration addCheckChangeHandler(CheckChangeEvent.CheckChangeHandler<CheckMenuItem> handler)

Description copied from interface: CheckChangeEvent.HasCheckChangeHandlers

Adds a CheckChangeEvent.CheckChangeHandler handler for CheckChangeEvent events.

Specified by:

addCheckChangeHandler in interface CheckChangeEvent.HasCheckChangeHandlers<CheckMenuItem>

Parameters:

handler - the handler

Returns:

the registration for the event

getCheckMenuItemAppearance

public CheckMenuItem.CheckMenuItemAppearance getCheckMenuItemAppearance()

getAriaGroupTitle

public String getAriaGroupTitle()

Returns the ARIA group title.

Returns:

the group title

getGroup

public String getGroup()

Returns the group name.

Returns:

the name

isChecked

public boolean isChecked()

Returns true if the item is checked.

Returns:

the checked state

setAriaGroupTitle

public void setAriaGroupTitle(String title)

Sets the title attribute on the group container element. Only applies to radio check items when ARIA is enabled.

Parameters:

title - the title

setChecked

public void setChecked(boolean checked)

Set the checked state of this item. If the item is in a group of CheckMenuItems, then it will toggle them as radios.

Parameters:

checked - the new checked state

setChecked

public void setChecked(boolean state,
              boolean suppressEvent)

Set the checked state of this item.

Parameters:

state - the new checked state

suppressEvent - true to prevent the CheckChange event from firing

setGroup

public void setGroup(String group)

All check items with the same group name will automatically be grouped into a single-select radio button group (defaults to null).

Parameters:

group - the group