Package org.zkoss.zul

Class Button

    • 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 Disable

      • 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 WrongValueException
        Sets the direction to layout image.
        Parameters:
        dir - either "normal" or "reverse".
        Throws:
        WrongValueException

      • getOrient

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

        Default: "horizontal".

      • setOrient

        public void setOrient​(java.lang.String orient)
               throws WrongValueException
        Sets the orient to layout image.
        Parameters:
        orient - either "horizontal" or "vertical".
        Throws:
        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 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:
        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.

      • setUpload

        public void setUpload​(java.lang.String upload)
        Description copied from interface: Uploadable
        Sets the JavaScript class at the client to handle the upload if this component is used for file 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,multiple=true,accept=audio/*|video/*|image/*,native"
        • maxsize: the maximal allowed upload size of the component, in kilobytes, or a negative value if no limit, if the maxsize is not specified, it will use Configuration.getMaxUploadSize()
        • native: treating the uploaded file(s) as binary, i.e., not to convert it to image, audio or text files.
        • multiple: treating the file chooser allows multiple files to upload, the setting only works with HTML5 supported browsers (since ZK 6.0.0).
        • accept: specifies the types of files that the server accepts, the setting only works with HTML5 supported browsers (since ZK 7.0.0).
        • suppressedErrors: specifies the suppressed uploading errors, separated by | (e.g. missing-required-component|illegal-upload) (since ZK 9.5.1).

        Note: if the options of the false or the customized handler (like foo.Upload) are not specified, the option of true is implicit by default.

        Specified by:
        setUpload in interface Uploadable
        Parameters:
        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).
        See Also:
        Uploadable.Error

      • clone

        public java.lang.Object clone()
        Description copied from interface: Component
        Clones the component. All of its children and descendants are cloned. Also, ID are preserved.
        Specified by:
        clone in interface Component
        Overrides:
        clone in class LabelImageElement
        Returns:
        the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.

      • updateByClient

        protected void updateByClient​(java.lang.String name,
                              java.lang.Object value)
        Description copied from class: AbstractComponent
        Called when the widget running at the client asks the server to update a value. The update is caused by an AU request named setAttr (by invoking zk.Widget's smartUpdate at client).

        By default, it does nothing but log a warning message, since it is not safe to allow the client to update a field arbitrary.

        However, if you'd like to allow the update for a particular component you could do one of the following

        1. For component developers: override this method to update the field directly. For example,
          protected void updateByClient(String name, Object value) {
        if ("disabled".equals(name))
                setDisabled(name, ((Boolean)value).booleanValue());
        else
                super.updateByClient(name, value);
        2. For application developers: set an attribute called org.zkoss.zk.ui.updateByClient to be true. Then, this method will use reflection to find out the setter to update the value. Nothing happens if the method is not found.

          3. Notice: this method will invoke AbstractComponent.disableClientUpdate(boolean) to disable any update to the client, when calling the setter.

          If you want to enable the client update for all instances of a given component (though not recommended for the security reason), you could refer to here.

          See also zk.Widget.smartUpdate().

        Overrides:
        updateByClient in class AbstractComponent