|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.impl.LabelElement
org.zkoss.zul.impl.LabelImageElement
org.zkoss.zul.Menuitem
public class Menuitem
A single choice in a Menupopup
element.
It acts much like a button but it is rendered on a menu.
Default getZclass()
: z-menu-item. (since 3.5.0)
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.zkoss.zul.impl.LabelImageElement |
---|
LabelImageElement.ExtraCtrl |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
AbstractComponent.Children |
Field Summary |
---|
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
_height, _left, _top, _width, _zclass |
Fields inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
_visible |
Fields inherited from interface org.zkoss.zk.ui.Component |
---|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE |
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl |
---|
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE |
Constructor Summary | |
---|---|
Menuitem()
|
|
Menuitem(java.lang.String label)
|
|
Menuitem(java.lang.String label,
java.lang.String src)
|
Method Summary | |
---|---|
void |
beforeParentChanged(Component parent)
Default: does nothing. |
java.lang.String |
getHref()
Returns the href. |
java.lang.String |
getTarget()
Returns the target frame or window. |
java.lang.String |
getUpload()
Returns non-null if this button is used for file upload, or null otherwise. |
java.lang.String |
getValue()
Returns the value. |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
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 |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
void |
service(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 |
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(java.lang.String href)
Sets the href. |
void |
setTarget(java.lang.String target)
Sets the target frame or window. |
void |
setUpload(java.lang.String upload)
Sets the JavaScript class at the client to handle the upload if this button is used for file upload. |
void |
setValue(java.lang.String value)
Sets the value. |
Methods inherited from class org.zkoss.zul.impl.LabelImageElement |
---|
getHoverImage, getImage, getImageContent, getSrc, isImageAssigned, newExtraCtrl, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent, setSrc |
Methods inherited from class org.zkoss.zul.impl.LabelElement |
---|
getLabel, setLabel |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zul.impl.api.LabelImageElement |
---|
getHoverImage, getImage, getImageContent, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent |
Methods inherited from interface org.zkoss.zul.impl.api.LabelElement |
---|
getLabel, setLabel |
Methods inherited from interface org.zkoss.zul.impl.api.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent |
---|
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Menuitem()
public Menuitem(java.lang.String label)
public Menuitem(java.lang.String label, java.lang.String src)
Method Detail |
---|
public boolean isCheckmark()
Default: false.
public void setCheckmark(boolean checkmark)
setCheckmark
in interface Menuitem
public java.lang.String getZclass()
HtmlBasedComponent
Default: null (the default value depends on element).
HtmlBasedComponent.setZclass(java.lang.String)
) will completely replace the default style
of a component. In other words, the default style of a component
is associated with the default value of HtmlBasedComponent.getZclass()
.
Once it is changed, the default style won't be applied at all.
If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String)
instead.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
public void setDisabled(boolean disabled)
setDisabled
in interface Disable
setDisabled
in interface Menuitem
public boolean isDisabled()
Default: false.
isDisabled
in interface Disable
isDisabled
in interface Menuitem
public java.lang.String getValue()
Default: "".
getValue
in interface Menuitem
public void setValue(java.lang.String value)
setValue
in interface Menuitem
public boolean isChecked()
Default: false.
isChecked
in interface Menuitem
public void setChecked(boolean checked)
This only applies when isCheckmark()
= true. (since 3.5.0)
setChecked
in interface Menuitem
public boolean isAutocheck()
Default: false.
isAutocheck
in interface Menuitem
public void setAutocheck(boolean autocheck)
This only applies when isCheckmark()
= true. (since 3.5.0)
setAutocheck
in interface Menuitem
public java.lang.String getHref()
Default: null. If null, the button has no function unless you specify the onClick handler.
getHref
in interface Menuitem
public void setHref(java.lang.String href) throws WrongValueException
setHref
in interface Menuitem
WrongValueException
public java.lang.String getTarget()
Note: it is useful only if href (setHref(java.lang.String)
) is specified
(i.e., use the onClick listener).
Default: null.
getTarget
in interface Menuitem
public void setTarget(java.lang.String target)
setTarget
in interface Menuitem
target
- the name of the frame or window to hyperlink.public boolean isTopmost()
Menupopup
.
isTopmost
in interface Menuitem
public java.lang.String getUpload()
setUpload(java.lang.String)
for more details.
public void setUpload(java.lang.String upload)
Default: null.
For example, the following example declares a button for file upload:
<button label="Upload" upload="true"
onUpload="handle(event.media)"/>
As shown above, after the file is uploaded, an instance of
UploadEvent
is sent this component.
If you want to customize the handling of the file upload at
the client, you can specify a JavaScript class when calling
this method:
<button upload="foo.Upload"/>
Another options for the upload can be specified as follows:
<button label="Upload" upload="true,maxsize=-1,native"
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).public void beforeParentChanged(Component parent)
AbstractComponent
beforeParentChanged
in interface ComponentCtrl
beforeParentChanged
in class AbstractComponent
parent
- the new parent. If null, it means detachment.ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)
protected boolean isChildable()
isChildable
in class AbstractComponent
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class LabelImageElement
java.io.IOException
public void service(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 ComponentCtrl
service
in class HtmlBasedComponent
everError
- whether any error ever occured before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |