zul.menu

Class Menuitem

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.LabelImageWidget

zul.menu.Menuitem

public class Menuitem
extends LabelImageWidget

A single choice in a Menupopup element. It acts much like a button but it is rendered on a menu.

Default Widget.getZclass(): z-menuitem.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getAutodisable() Returns a list of component IDs that shall be disabled when the user clicks this menuitem.
String	getHref() Returns the href.
Menubar	getMenubar() Returns the Menubar that contains this menuitem, or null if not available.
String	getTarget() Returns the target frame or window.
String	getUpload() Returns non-null if this button is used for file upload, or null otherwise.
String	getValue() Returns the value.
boolean	isAutocheck() Returns whether the menuitem check mark will update each time the menu item is selected.
boolean	isChecked() Returns whether it is checked.
boolean	isCheckmark() Returns whether the check mark shall be displayed in front of each item.
boolean	isDisabled() Returns whether it is disabled.
boolean	isTopmost() Returns whether this is an top-level menu, i.e., not owning by another Menupopup.
void	setAutocheck(boolean autocheck) Sets whether the menuitem check mark will update each time the menu item is selected.
void	setAutodisable(String autodisable) Sets whether to disable the button after the user clicks it.
void	setChecked(boolean checked) Sets whether it is checked.
void	setCheckmark(boolean checkmark) Sets whether the check mark shall be displayed in front of each item.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setHref(String href) Sets the href.
void	setTarget(String target) Sets the target frame or window.
void	setUpload(String upload) Sets the JavaScript class at the client to handle the upload if this button is used for file upload.
void	setValue(String value) Sets the value.

Methods inherited from class zul.LabelImageWidget

domContent_, domIcon_, domImage_, domLabel_, getHoverImage, getIconSclass, getImage, getImageNode, getLabel, setHoverImage, setIconSclass, setImage, setLabel, updateDomContent_

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

setCheckmark

public void setCheckmark(boolean checkmark)

Sets whether the check mark shall be displayed in front of each item.

Parameters:

checkmark -

isCheckmark

public boolean isCheckmark()

Returns whether the check mark shall be displayed in front of each item.

Default: false.

Returns:

boolean

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled.

Parameters:

disabled -

isDisabled

public boolean isDisabled()

Returns whether it is disabled.

Default: false.

Returns:

boolean

setHref

public void setHref(String href)

Sets the href.

Parameters:

href -

getHref

public String getHref()

Returns the href.

Default: null. If null, the button has no function unless you specify the onClick handler.

Returns:

String

setValue

public void setValue(String value)

Sets the value.

Parameters:

value -

getValue

public String getValue()

Returns the value.

Default: "".

Returns:

String

setChecked

public void setChecked(boolean checked)

Sets whether it is checked.

This only applies when isCheckmark() = true.

Parameters:

checked -

isChecked

public boolean isChecked()

Returns whether it is checked.

Default: false.

Returns:

boolean

setAutocheck

public void setAutocheck(boolean autocheck)

Sets whether the menuitem check mark will update each time the menu item is selected.

This only applies when isCheckmark() = true.

Parameters:

autocheck -

isAutocheck

public boolean isAutocheck()

Returns whether the menuitem check mark will update each time the menu item is selected.

Default: false.

Returns:

boolean

setTarget

public void setTarget(String target)

Sets the target frame or window.

Parameters:

target - the name of the frame or window to hyperlink.

getTarget

public String getTarget()

Returns the target frame or window.

Note: it is useful only if href (setHref(_global_.String)) is specified (i.e., use the onClick listener).

Default: null.

Returns:

String

setAutodisable

public void setAutodisable(String autodisable)

Sets whether to disable the button after the user clicks it.

Parameters:

autodisable -

Since:

5.0.7

getAutodisable

public String getAutodisable()

Returns a list of component IDs that shall be disabled when the user clicks this menuitem.

To represent the menuitem itself, the developer can specify self. For example, <menuitem id="ok" autodisable="self,cancel"/> is the same as <menuitem id="ok" autodisable="ok,cancel"/> that will disable both the ok and cancel menuitem when an user clicks it.

The menuitem being disabled will be enabled automatically once the client receives a response from the server. In other words, the server doesn't notice if a menuitem is disabled with this method.

However, if you prefer to enable them later manually, you can prefix with '+'. For example, <menuitem id="ok" autodisable="+self,+cancel"/>

Then, you have to enable them manually such as

if (something_happened){
  ok.setDisabled(false);
  cancel.setDisabled(false);

Default: null.

Returns:

String

Since:

5.0.7

setUpload

public void setUpload(String upload)

Sets the JavaScript class at the client to handle the upload if this button is used for file upload.

Default: null.

Parameters:

upload - a JavaScript class to handle the file upload at the client, or "true" if the default class is used, or null or "false" to disable the file download (and then this button behaves like a normal button).

getUpload

public String getUpload()

Returns non-null if this button is used for file upload, or null otherwise. Refer to setUpload(_global_.String) for more details.

Returns:

String

isTopmost

public boolean isTopmost()

Returns whether this is an top-level menu, i.e., not owning by another Menupopup.

Returns:

boolean

getMenubar

public Menubar getMenubar()

Returns the Menubar that contains this menuitem, or null if not available.

Returns:

zul.menu.Menubar