org.cruxframework.crux.widgets.client.stackmenu

Class StackMenuItem

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.cruxframework.crux.widgets.client.stackmenu.StackMenuItem

All Implemented Interfaces:

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.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class StackMenuItem
extends com.google.gwt.user.client.ui.Composite

A stack menu's item. When it contains child items, the action of clicking or pressing ENTER or SPACE BAR over it makes it show or hide its children.

Author:

Gesse Dafe

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 and Description
StackMenuItem(String key, String label) Constructs a menu item with the given label and a given key.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(StackMenuItem subItem) Adds a child item.
String	getKey()
String	getLabel()
com.google.gwt.user.client.ui.Grid	getMenuItemCanvas()
StackMenuItem	getParentItem()
StackMenu	getParentMenu() Returns the stack menu that contains this item
List<StackMenuItem>	getSubItems()
Object	getUserData() Gets the userData object associated with this menu item.
boolean	hasChildren() Returns true if the item has child items.
boolean	isOpen() Returns true if the children items are visible.
void	remove(StackMenuItem subItem) Removes a child item.
void	setLabel(String label)
void	setLast(boolean last) Changes the layout of the item if it is the last one
void	setOpen(boolean open) Shows or hides the child items.
void	setParentMenu(StackMenu menu) Sets the parent menu
void	setUserData(Object userData) Associate an userData object with this menu item.

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

Constructor Detail

StackMenuItem

public StackMenuItem(String key,
             String label)

Constructs a menu item with the given label and a given key.

Parameters:

key - a textual mark useful to identify which item was selected by the user

label - the text to be displayed on item

Method Detail

add

public void add(StackMenuItem subItem)

Adds a child item.

Parameters:

subItem -

remove

public void remove(StackMenuItem subItem)

Removes a child item.

Parameters:

subItem -

isOpen

public boolean isOpen()

Returns true if the children items are visible.

setOpen

public void setOpen(boolean open)

Shows or hides the child items.

Parameters:

open -

getLabel

public String getLabel()

Returns:

the label

setLabel

public void setLabel(String label)

Parameters:

label -

getSubItems

public List<StackMenuItem> getSubItems()

Returns:

the subItems

getParentItem

public StackMenuItem getParentItem()

Returns:

the parent

hasChildren

public boolean hasChildren()

Returns true if the item has child items.

setParentMenu

public void setParentMenu(StackMenu menu)

Sets the parent menu

Parameters:

menu -

getUserData

public Object getUserData()

Gets the userData object associated with this menu item.

Returns:

userData

setUserData

public void setUserData(Object userData)

Associate an userData object with this menu item.

Parameters:

userData - the user data object

getParentMenu

public StackMenu getParentMenu()

Returns the stack menu that contains this item

getKey

public String getKey()

Returns:

the key

setLast

public void setLast(boolean last)

Changes the layout of the item if it is the last one

Parameters:

last -

getMenuItemCanvas

public com.google.gwt.user.client.ui.Grid getMenuItemCanvas()

Returns:

the menu item widget.