Class Button

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.DynamicPropertied, org.zkoss.zk.ui.ext.RawId, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

    public class Button
    extends AbstractTag
    The BUTTON tag.
    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
    • Field Summary

      • 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()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getForm()
      Returns the form of this button tag.
      java.lang.String getFormaction()
      Returns the formaction of this button tag.
      java.lang.String getFormenctype()
      Returns the formenctype of this button tag.
      java.lang.String getFormmethod()
      Returns the formmethod of this tag.
      java.lang.String getFormnovalidate()
      Returns the formnovalidate of this tag.
      java.lang.String getFormtarget()
      Returns the formtarget of this tag.
      java.lang.String getName()
      Returns the name of this button tag.
      java.lang.String getType()
      Returns the type of this button tag.
      java.lang.String getValue()
      Returns the value of this button tag.
      boolean isAutofocus()
      Returns the autofocus of this button tag.
      boolean isDisabled()
      Returns the disabled of this button tag.
      void setAutofocus​(boolean autofocus)
      Sets the autofocus of this button tag.
      void setDisabled​(boolean disabled)
      Sets the disabled of this button tag.
      void setForm​(java.lang.String form)
      Sets the form of this button tag.
      void setFormaction​(java.lang.String formaction)
      Sets the formaction of this button tag.
      void setFormenctype​(java.lang.String formenctype)
      Set the formenctype of this button tag.
      void setFormmethod​(java.lang.String formmethod)
      Sets the formmethod of this tag.
      void setFormnovalidate​(java.lang.String formnovalidate)
      Sets the formnovalidate of this tag.
      void setFormtarget​(java.lang.String formtarget)
      Sets the formtarget of this tag.
      void setName​(java.lang.String name)
      Sets the name of this button tag.
      void setType​(java.lang.String type)
      Sets the type of this button tag.
      void setValue​(java.lang.String value)
      Sets the value of this button tag.
      • 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, 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, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, updateByClient, 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()
    • Method Detail

      • isAutofocus

        public boolean isAutofocus()
        Returns the autofocus of this button tag.

        Notice that this attribute refers to the corresponding attribute of the HTML5 specification. Hence, it would still be rendered to client-side as a DOM attribute even if the browser doesn’t support it.

        Since:
        8.0.3
      • setAutofocus

        public void setAutofocus​(boolean autofocus)
                          throws org.zkoss.zk.ui.WrongValueException
        Sets the autofocus of this button tag.

        Notice that this attribute refers to the corresponding attribute of the HTML5 specification. Hence, it would still be rendered to client-side as a DOM attribute even if the browser doesn’t support it.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        8.0.3
      • isDisabled

        public boolean isDisabled()
        Returns the disabled of this button tag.
        Since:
        8.0.3
      • setDisabled

        public void setDisabled​(boolean disabled)
                         throws org.zkoss.zk.ui.WrongValueException
        Sets the disabled of this button tag.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        8.0.3
      • getName

        public java.lang.String getName()
        Returns the name of this button tag.
        Since:
        8.0.3
      • setName

        public void setName​(java.lang.String name)
                     throws org.zkoss.zk.ui.WrongValueException
        Sets the name of this button tag.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        8.0.3
      • getType

        public java.lang.String getType()
        Returns the type of this button tag.
        Since:
        8.0.3
      • setType

        public void setType​(java.lang.String type)
                     throws org.zkoss.zk.ui.WrongValueException
        Sets the type of this button tag.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        8.0.3
      • getValue

        public java.lang.String getValue()
        Returns the value of this button tag.
        Since:
        8.0.3
      • setValue

        public void setValue​(java.lang.String value)
                      throws org.zkoss.zk.ui.WrongValueException
        Sets the value of this button tag.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        8.0.3
      • getForm

        public java.lang.String getForm()
        Returns the form of this button tag.
        Since:
        10.0.0
      • setForm

        public void setForm​(java.lang.String form)
                     throws org.zkoss.zk.ui.WrongValueException
        Sets the form of this button tag.

        The <form> element to associate the button with (its form owner). The value of this attribute must be the id of a <form> in the same document. (If this attribute is not set, the <button> is associated with its ancestor <form> element, if any.)

        This attribute lets you associate <button> elements to <form>s anywhere in the document, not just inside a <form>. It can also override an ancestor <form> element.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0
      • getFormaction

        public java.lang.String getFormaction()
        Returns the formaction of this button tag.
        Since:
        10.0.0
      • setFormaction

        public void setFormaction​(java.lang.String formaction)
                           throws org.zkoss.zk.ui.WrongValueException
        Sets the formaction of this button tag.

        The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. Does nothing if there is no form owner.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0
      • getFormenctype

        public java.lang.String getFormenctype()
        Returns the formenctype of this button tag.
        Since:
        10.0.0
      • setFormenctype

        public void setFormenctype​(java.lang.String formenctype)
                            throws org.zkoss.zk.ui.WrongValueException
        Set the formenctype of this button tag.

        If the button is a submit button (it's inside/associated with a <form> and doesn't have type="button"), specifies how to encode the form data that is submitted.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0
      • getFormmethod

        public java.lang.String getFormmethod()
        Returns the formmethod of this tag.
        Since:
        10.0.0
      • setFormmethod

        public void setFormmethod​(java.lang.String formmethod)
                           throws org.zkoss.zk.ui.WrongValueException
        Sets the formmethod of this tag.

        If the button is a submit button (it's inside/associated with a <form> and doesn't have type="button"), this attribute specifies the HTTP method used to submit the form.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0
      • getFormnovalidate

        public java.lang.String getFormnovalidate()
        Returns the formnovalidate of this tag.
        Since:
        10.0.0
      • setFormnovalidate

        public void setFormnovalidate​(java.lang.String formnovalidate)
                               throws org.zkoss.zk.ui.WrongValueException
        Sets the formnovalidate of this tag.

        If the button is a submit button, this Boolean attribute specifies that the form is not to be validated when it is submitted. If this attribute is specified, it overrides the novalidate attribute of the button's form owner.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0
      • getFormtarget

        public java.lang.String getFormtarget()
        Returns the formtarget of this tag.
        Since:
        10.0.0
      • setFormtarget

        public void setFormtarget​(java.lang.String formtarget)
                           throws org.zkoss.zk.ui.WrongValueException
        Sets the formtarget of this tag.

        If the button is a submit button, this attribute is an author-defined name or standardized, underscore-prefixed keyword indicating where to display the response from submitting the form. This is the name of, or keyword for, a browsing context (a tab, window, or <iframe>). If this attribute is specified, it overrides the target attribute of the button's form owner.

        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        10.0.0