com.extjs.gxt.ui.client.widget.menu
Class CheckMenuItem

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.menu.Item
                  com.extjs.gxt.ui.client.widget.menu.MenuItem
                      com.extjs.gxt.ui.client.widget.menu.CheckMenuItem

All Implemented Interfaces:

Observable, IconSupport, 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.IsWidget

public class CheckMenuItem
extends MenuItem

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

Events:

BeforeCheckChange : MenuEvent(menu, item)

Fires before the item is checked or unchecked. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• item : this
• menu : the parent menu
• checked : the check state

CheckChange : MenuEvent(menu, item)

Fires after the item is checked or unchecked.

• item : this
• menu : the parent menu
• checked : the check state

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.extjs.gxt.ui.client.widget.menu.MenuItem

html, icon, itemStyle, subMenu, widget

Fields inherited from class com.extjs.gxt.ui.client.widget.menu.Item

canActivate, hideOnClick, parentMenu

Fields inherited from class com.extjs.gxt.ui.client.widget.Component

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

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

DEBUG_ID_PREFIX

Constructor Summary

CheckMenuItem()
Creates a new check menu item.

CheckMenuItem(java.lang.String html)
Creates a new check menu item.

Method Summary

java.lang.String	getAriaGroupTitle() Returns the ARIA group title.
java.lang.String	getGroup() Returns the group name.
java.lang.String	getGroupStyle() Returns the group style.
boolean	isChecked() Returns true if the item is checked.
protected void	onClick(ComponentEvent ce)
protected void	onRadioClick(ComponentEvent ce)
protected void	onRender(com.google.gwt.user.client.Element target, int index) Subclasses must override and ensure setElement is called for lazy rendered components.
void	setAriaGroupTitle(java.lang.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 supressEvent) Set the checked state of this item.
void	setGroup(java.lang.String group) All check items with the same group name will automatically be grouped into a single-select radio button group (defaults to null).
void	setGroupStyle(java.lang.String groupStyle) The default CSS class to use for radio group check items (defaults to "x-menu-group-item").

Methods inherited from class com.extjs.gxt.ui.client.widget.menu.MenuItem

activate, afterRender, deactivate, doAttachChildren, doDetachChildren, expandMenu, expandMenu, getHtml, getIcon, getSubMenu, getWidget, onDisable, onEnable, setHtml, setIcon, setIconStyle, setSubMenu, setText, setWidget, shouldDeactivate

Methods inherited from class com.extjs.gxt.ui.client.widget.menu.Item

addSelectionListener, getActiveStyle, getHideOnClick, getParentMenu, handleClick, isCanActivate, onEscape, removeSelectionListener, setActiveStyle, setCanActivate, setHideOnClick

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createComponentEvent, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onBrowserEvent, onComponentEvent, onDetach, onDetachHelper, onEnsureDebugId, onHide, onHideContextMenu, onLoad, onRightClick, onShow, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHeight, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setPixelSize, setSize, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWidth, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

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, onUnload, setLayoutData

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckMenuItem

public CheckMenuItem()

Creates a new check menu item.

CheckMenuItem

public CheckMenuItem(java.lang.String html)

Creates a new check menu item.

Parameters:

html - the text as HTML

Method Detail

getAriaGroupTitle

public java.lang.String getAriaGroupTitle()

Returns the ARIA group title.

Returns:

the group title

getGroup

public java.lang.String getGroup()

Returns the group name.

Returns:

the name

getGroupStyle

public java.lang.String getGroupStyle()

Returns the group style.

Returns:

the group style

isChecked

public boolean isChecked()

Returns true if the item is checked.

Returns:

the checked state

setAriaGroupTitle

public void setAriaGroupTitle(java.lang.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.

Parameters:

checked - the new checked state

setChecked

public void setChecked(boolean state,
                       boolean supressEvent)

Set the checked state of this item.

Parameters:

state - the new checked state

supressEvent - true to prevent the CheckChange event from firing

setGroup

public void setGroup(java.lang.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

setGroupStyle

public void setGroupStyle(java.lang.String groupStyle)

The default CSS class to use for radio group check items (defaults to "x-menu-group-item").

Parameters:

groupStyle - the group style

onClick

protected void onClick(ComponentEvent ce)

Overrides:

onClick in class Item

onRadioClick

protected void onRadioClick(ComponentEvent ce)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)

Description copied from class: Component

Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:

onRender in class MenuItem

Parameters:

target - the target element

index - the insert location