public class Button extends LabelImageElement implements org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Uploadable
Default getZclass()
: z-button.(since 3.5.0)
LabelImageElement.ExtraCtrl
Constructor and Description |
---|
Button() |
Button(String label) |
Button(String label,
String image) |
Modifier and Type | Method and Description |
---|---|
Object |
clone() |
String |
getAutodisable()
Returns a list of component IDs that shall be disabled when the user
clicks this button.
|
String |
getDir()
Returns the direction.
|
String |
getHref()
Returns the href that the browser shall jump to, if an user clicks
this button.
|
String |
getOrient()
Returns the orient.
|
String |
getTarget()
Returns the target frame or window.
|
String |
getType()
Returns the button type.
|
String |
getUpload() |
String |
getZclass() |
protected boolean |
isChildable()
No child is allowed.
|
boolean |
isDisabled()
Returns whether it is disabled.
|
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) |
void |
setAutodisable(String autodisable)
Sets a list of component IDs that shall be disabled when the user
clicks this button.
|
void |
setDir(String dir)
Sets the direction to layout image.
|
void |
setDisabled(boolean disabled)
Sets whether it is disabled.
|
void |
setHref(String href)
Sets the href.
|
void |
setOrient(String orient)
Sets the orient to layout image.
|
void |
setTarget(String target)
Sets the target frame or window.
|
void |
setType(String type)
Sets the button type.
|
void |
setUpload(String upload) |
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, beforeParentChanged, 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 Button()
public Button(String label)
public boolean isDisabled()
Default: false.
isDisabled
in interface org.zkoss.zk.ui.ext.Disable
public void setDisabled(boolean disabled)
setDisabled
in interface org.zkoss.zk.ui.ext.Disable
setAutodisable(java.lang.String)
public String getAutodisable()
public void setAutodisable(String autodisable)
To represent the button itself, the developer can specify self
.
For example, <button id="ok" autodisable="self,cancel"/>
is the same as <button id="ok" autodisable="ok,cancel"/>
that will disable
both the ok and cancel buttons when an user clicks it.
The button 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 button is disabled with this method.
However, if you prefer to enable them later manually, you can
prefix with '+'. For example,
<button 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 getDir()
Default: "normal".
public void setDir(String dir) throws org.zkoss.zk.ui.WrongValueException
dir
- either "normal" or "reverse".org.zkoss.zk.ui.WrongValueException
public String getOrient()
Default: "horizontal".
public void setOrient(String orient) throws org.zkoss.zk.ui.WrongValueException
orient
- either "horizontal" or "vertical".org.zkoss.zk.ui.WrongValueException
public String getType()
Default: "button".
public void setType(String type) throws org.zkoss.zk.ui.WrongValueException
Default: "button". It is meaningful only if it is used with a HTML form. Refer to HTML Button Type for details.
type
- either "button", "submit" or "reset".org.zkoss.zk.ui.WrongValueException
public String getHref()
Default: null. If null, the button has no function unless you specify the onClick event listener.
If it is not null, the onClick event won't be sent.
public void setHref(String href)
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 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
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 String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
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 updateByClient(String name, Object value)
updateByClient
in class org.zkoss.zk.ui.AbstractComponent
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
Copyright © 2019. All rights reserved.