Package org.zkoss.zul

Class Checkbox

    • Constructor Detail

      • Checkbox

        public Checkbox()

      • Checkbox

        public Checkbox​(java.lang.String label)

      • Checkbox

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

    • Method Detail

      • isIndeterminate

        public boolean isIndeterminate()
        Return whether checkbox is in indeterminate state. Default: false.
        Returns:
        true if checkbox is indeterminate
        Since:
        8.6.0

      • setIndeterminate

        public void setIndeterminate​(boolean indeterminate)
        Set whether checkbox is in indeterminate state.
        Parameters:
        indeterminate - whether checkbox is indeterminate
        Since:
        8.6.0

      • getAutodisable

        public java.lang.String getAutodisable()
        Returns a list of component IDs that shall be disabled when the user clicks this checkbox.
        Since:
        6.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 checkbox.

        To represent the checkbox itself, the developer can specify self. For example, <checkbox id="ok" autodisable="self,cancel"/> is the same as <checkbox id="ok" autodisable="ok,cancel"/> that will disable both the ok and cancel checkboxes when an user clicks it.

        The checkbox 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 checkbox is disabled with this method.

        However, if you prefer to enable them later manually, you can prefix with '+'. For example, <checkbox 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

      • isDisabled

        public boolean isDisabled()
        Returns whether it is disabled.

        Default: false.

        Specified by:
        isDisabled in interface Disable

      • setDisabled

        public void setDisabled​(boolean disabled)
        Sets whether it is disabled.
        Specified by:
        setDisabled in interface Disable

      • isChecked

        public boolean isChecked()
        Returns whether it is checked.

        Default: false.

      • setChecked

        public void setChecked​(boolean checked)
        Sets whether it is checked, changing checked will set indeterminate to false.

      • getState

        public Checkbox.State getState()
        Returns the current state according to isIndeterminate() and isChecked().
        Returns:
        CHECKED, UNCHECKED or INDETERMINATE
        Since:
        9.0.0

      • getValue

        public <T> T getValue()
        Returns the value.

        Default: null. (since 6.5.0)

        Since:
        5.0.4

      • setValue

        public <T> void setValue​(T value)
        Sets the value.
        Parameters:
        value - the value;
        Since:
        5.0.4

      • getName

        public java.lang.String getName()
        Returns the name of this component.

        Default: null.

        Don't use this method if your application is purely based on ZK's event-driven model.

        The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

      • setName

        public void setName​(java.lang.String name)
        Sets the name of this component.

        Don't use this method if your application is purely based on ZK's event-driven model.

        The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

        Parameters:
        name - the name of this component.

      • 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