Package org.zkoss.zul

Class Button

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.ext.Uploadable, org.zkoss.zk.ui.sys.ComponentCtrl
    Direct Known Subclasses:
    Combobutton, Fileupload, MessageboxDlg.Button, Toolbarbutton
    public class Button
extends LabelImageElement
implements org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Uploadable
    A button.

    Default getZclass(): z-button.(since 3.5.0)

    Author:
    tomyeh
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

        org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

      • Nested classes/interfaces inherited from interface org.zkoss.zk.ui.ext.Uploadable

        org.zkoss.zk.ui.ext.Uploadable.Error

    • Field Summary

      • Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        _zclass

      • 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

        AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

    • Constructor Summary

      Constructors 
      Constructor Description
      Button()  
      Button​(java.lang.String label)  
      Button​(java.lang.String label, java.lang.String image)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      java.lang.String getAutodisable()
      Returns a list of component IDs that shall be disabled when the user clicks this button.
      java.lang.String getDir()
      Returns the direction.
      java.lang.String getHref()
      Returns the href that the browser shall jump to, if a user clicks this button.
      java.lang.String getOrient()
      Returns the orient.
      java.lang.String getTarget()
      Returns the target frame or window.
      java.lang.String getType()
      Returns the button type.
      java.lang.String getUpload()  
      java.lang.String getZclass()  
      protected boolean isChildable()
      No child is allowed.
      boolean isDisabled()
      Returns whether it is disabled.
      protected void renderCrawlable​(java.lang.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​(java.lang.String autodisable)
      Sets a list of component IDs that shall be disabled when the user clicks this button.
      void setDir​(java.lang.String dir)
      Sets the direction to layout image.
      void setDisabled​(boolean disabled)
      Sets whether it is disabled.
      void setHref​(java.lang.String href)
      Sets the href.
      void setOrient​(java.lang.String orient)
      Sets the orient to layout image.
      void setTarget​(java.lang.String target)
      Sets the target frame or window.
      void setType​(java.lang.String type)
      Sets the button type.
      void setUpload​(java.lang.String upload)  
      protected void updateByClient​(java.lang.String name, java.lang.Object value)  

      • Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, 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

      • Methods inherited from class org.zkoss.zk.ui.AbstractComponent

        addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, 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, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, 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, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Button

        public Button()

      • Button

        public Button​(java.lang.String label)

      • Button

        public Button​(java.lang.String label,
              java.lang.String image)

    • Method Detail

      • isDisabled

        public boolean isDisabled()
        Returns whether it is disabled.

        Default: false.

        Specified by:
        isDisabled in interface org.zkoss.zk.ui.ext.Disable

      • setDisabled

        public void setDisabled​(boolean disabled)
        Sets whether it is disabled.
        Specified by:
        setDisabled in interface org.zkoss.zk.ui.ext.Disable
        See Also:
        setAutodisable(java.lang.String)

      • getAutodisable

        public java.lang.String getAutodisable()
        Returns a list of component IDs that shall be disabled when the user clicks this button.
        Since:
        5.0.0

      • setAutodisable

        public void setAutodisable​(java.lang.String autodisable)
        Sets a list of component IDs that shall be disabled when the user clicks this button.

        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 a 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.

        Since:
        5.0.0

      • getDir

        public java.lang.String getDir()
        Returns the direction.

        Default: "normal".

      • setDir

        public void setDir​(java.lang.String dir)
            throws org.zkoss.zk.ui.WrongValueException
        Sets the direction to layout image.
        Parameters:
        dir - either "normal" or "reverse".
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getOrient

        public java.lang.String getOrient()
        Returns the orient.

        Default: "horizontal".

      • setOrient

        public void setOrient​(java.lang.String orient)
               throws org.zkoss.zk.ui.WrongValueException
        Sets the orient to layout image.
        Parameters:
        orient - either "horizontal" or "vertical".
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getType

        public java.lang.String getType()
        Returns the button type.

        Default: "button".

        Since:
        5.0.4

      • setType

        public void setType​(java.lang.String type)
             throws org.zkoss.zk.ui.WrongValueException
        Sets the button type.

        Default: "button". It is meaningful only if it is used with a HTML form. Refer to HTML Button Type for details.

        Parameters:
        type - either "button", "submit" or "reset".
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        5.0.4

      • getHref

        public java.lang.String getHref()
        Returns the href that the browser shall jump to, if a user clicks this button.

        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.

      • setHref

        public void setHref​(java.lang.String href)
        Sets the href.

      • getTarget

        public java.lang.String getTarget()
        Returns the target frame or window.

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

        Default: null.

      • setTarget

        public void setTarget​(java.lang.String target)
        Sets the target frame or window.
        Parameters:
        target - the name of the frame or window to hyperlink.

      • getUpload

        public java.lang.String getUpload()
        Specified by:
        getUpload in interface org.zkoss.zk.ui.ext.Uploadable

      • setUpload

        public void setUpload​(java.lang.String upload)
        Specified by:
        setUpload in interface org.zkoss.zk.ui.ext.Uploadable

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class LabelImageElement
        Throws:
        java.io.IOException

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

      • clone

        public java.lang.Object clone()
        Specified by:
        clone in interface org.zkoss.zk.ui.Component
        Overrides:
        clone in class LabelImageElement

      • isChildable

        protected boolean isChildable()
        No child is allowed.
        Overrides:
        isChildable in class org.zkoss.zk.ui.AbstractComponent

      • updateByClient

        protected void updateByClient​(java.lang.String name,
                              java.lang.Object value)
        Overrides:
        updateByClient in class org.zkoss.zk.ui.AbstractComponent

      • service

        public void service​(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
        Specified by:
        service in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        service in class org.zkoss.zk.ui.HtmlBasedComponent