public class Menuitem extends LabelImageElement implements org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Uploadable
Menupopup
element.
It acts much like a button but it is rendered on a menu.
Default getZclass()
: z-menuitem. (since 3.5.0)
LabelImageElement.ExtraCtrl
Constructor and Description |
---|
Menuitem() |
Menuitem(String label) |
Menuitem(String label,
String src) |
Modifier and Type | Method and Description |
---|---|
void |
beforeParentChanged(org.zkoss.zk.ui.Component parent) |
Object |
clone() |
String |
getAutodisable()
Returns a list of component IDs that shall be disabled when the user
clicks this menuitem.
|
String |
getHref()
Returns the href.
|
String |
getTarget()
Returns the target frame or window.
|
String |
getUpload() |
String |
getValue()
Returns the value.
|
String |
getZclass() |
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.
|
protected boolean |
isChildable()
Not childable.
|
boolean |
isDisabled()
Returns whether it is disabled.
|
boolean |
isTopmost()
Returns whether this is an top-level menu, i.e., not owning
by another
Menupopup . |
protected void |
renderCrawlable(String label)
Renders the crawlable information.
|
protected void |
renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) |
void |
service(org.zkoss.zk.au.AuRequest request,
boolean everError)
Processes an AU request.
|
void |
setAutocheck(boolean autocheck)
Sets whether the menuitem check mark will update each time
the menu item is selected.
|
void |
setAutodisable(String autodisable)
Sets a list of component IDs that shall be disabled when the user
clicks this menuitem.
|
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) |
void |
setValue(String value)
Sets the value.
|
protected void |
updateByClient(String name,
Object value) |
getExtraCtrl, getHoverImage, getHoverImageContent, getIconSclass, getImage, getImageContent, getPropertyAccess, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setIconSclass, setImage, setImageContent, setImageContent, setSrc
getLabel, setLabel
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
addSclass, focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
public Menuitem()
public Menuitem(String label)
public boolean isCheckmark()
Default: false.
public void setCheckmark(boolean checkmark)
Note the checkbox can be checked only if isAutocheck()
is true
public String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
public void setDisabled(boolean disabled)
setDisabled
in interface org.zkoss.zk.ui.ext.Disable
public boolean isDisabled()
Default: false.
isDisabled
in interface org.zkoss.zk.ui.ext.Disable
public String getAutodisable()
public void setAutodisable(String autodisable)
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.
public String getValue()
Default: "".
public void setValue(String value)
public boolean isChecked()
Default: false.
public void setChecked(boolean checked)
This only applies when isCheckmark()
= true. (since 3.5.0)
public boolean isAutocheck()
Default: false.
public void setAutocheck(boolean autocheck)
This only applies when isCheckmark()
= true. (since 3.5.0)
public String getHref()
Default: null. If null, the button has no function unless you specify the onClick handler.
public void setHref(String href) throws org.zkoss.zk.ui.WrongValueException
org.zkoss.zk.ui.WrongValueException
public String getTarget()
Note: it is useful only if href (setHref(java.lang.String)
) is specified
(i.e., use the onClick listener).
Default: null.
public void setTarget(String target)
target
- the name of the frame or window to hyperlink.public boolean isTopmost()
Menupopup
.public String getUpload()
getUpload
in interface org.zkoss.zk.ui.ext.Uploadable
public void setUpload(String upload)
setUpload
in interface org.zkoss.zk.ui.ext.Uploadable
public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
beforeParentChanged
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeParentChanged
in class org.zkoss.zk.ui.AbstractComponent
public Object clone()
clone
in interface org.zkoss.zk.ui.Component
clone
in class LabelImageElement
protected boolean isChildable()
isChildable
in class org.zkoss.zk.ui.AbstractComponent
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
renderProperties
in class LabelImageElement
IOException
protected void renderCrawlable(String label) throws IOException
LabelElement
LabelElement.renderProperties(org.zkoss.zk.ui.sys.ContentRenderer)
,
and designed to be overridden if the deriving class wants to generate
it differently.
Default: org.zkoss.zul.impl.Utils.renderCrawlableText(label)
renderCrawlable
in class LabelElement
IOException
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onCheck.
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
Copyright © 2019. All rights reserved.