Package com.google.gwt.user.client.ui

Class SimpleCheckBox

    • Constructor Detail

      • SimpleCheckBox

        public SimpleCheckBox()
        Creates a new simple checkbox.

      • SimpleCheckBox

        protected SimpleCheckBox​(Element element)
        This constructor may be used by subclasses to explicitly use an existing element. This element must be an <input> element whose type is either 'checkbox'.
        Parameters:
        element - the element to be used

      • SimpleCheckBox

        SimpleCheckBox​(Element element,
               java.lang.String styleName)

    • Method Detail

      • wrap

        public static SimpleCheckBox wrap​(Element element)
        Creates a SimpleCheckBox widget that wraps an existing <input type='checkbox'> element. This element must already be attached to the document. If the element is removed from the document, you must call RootPanel.detachNow(Widget).
        Parameters:
        element - the element to be wrapped

      • getFormValue

        public java.lang.String getFormValue()
        Returns the value property of the input element that backs this widget. This is the value that will be associated with the check box name and submitted to the server if a FormPanel that holds it is submitted and the box is checked.

        Don't confuse this with getValue(), which returns true or false if the widget is checked.

      • getName

        public java.lang.String getName()
        Description copied from interface: HasName
        Gets the widget's name.
        Specified by:
        getName in interface HasName
        Returns:
        the widget's name

      • getValue

        public java.lang.Boolean getValue()
        Determines whether this check box is currently checked.

        Note that this does not return the value property of the checkbox input element wrapped by this widget. For access to that property, see getFormValue()

        Specified by:
        getValue in interface HasValue<java.lang.Boolean>
        Specified by:
        getValue in interface TakesValue<java.lang.Boolean>
        Returns:
        true if the check box is checked, false otherwise. Will not return null
        See Also:
        TakesValue.setValue(V)

      • isChecked

        @Deprecated
public boolean isChecked()
        Deprecated.
        Use getValue() instead
        Determines whether this check box is currently checked.
        Returns:
        true if the check box is checked

      • setChecked

        @Deprecated
public void setChecked​(boolean checked)
        Deprecated.
        Use setValue(Boolean) instead
        Checks or unchecks this check box.
        Parameters:
        checked - true to check the check box

      • setEnabled

        public void setEnabled​(boolean enabled)
        Description copied from class: FocusWidget
        Sets whether this widget is enabled.
        Specified by:
        setEnabled in interface HasEnabled
        Overrides:
        setEnabled in class FocusWidget
        Parameters:
        enabled - true to enable the widget, false to disable it

      • setFormValue

        public void setFormValue​(java.lang.String value)
        Set the value property on the input element that backs this widget. This is the value that will be associated with the check box's name and submitted to the server if a FormPanel that holds it is submitted and the box is checked.

        Don't confuse this with setValue(java.lang.Boolean), which actually checks and unchecks the box.

        Parameters:
        value -

      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: HasName
        Sets the widget's name.
        Specified by:
        setName in interface HasName
        Parameters:
        name - the widget's new name

      • setValue

        public void setValue​(java.lang.Boolean value)
        Checks or unchecks the check box.

        Note that this does not set the value property of the checkbox input element wrapped by this widget. For access to that property, see setFormValue(String)

        Specified by:
        setValue in interface HasValue<java.lang.Boolean>
        Specified by:
        setValue in interface TakesValue<java.lang.Boolean>
        Parameters:
        value - true to check, false to uncheck; null value implies false
        See Also:
        TakesValue.getValue()

      • setValue

        public void setValue​(java.lang.Boolean value,
                     boolean fireEvents)
        Checks or unchecks the check box, firing ValueChangeEvent if appropriate.

        Note that this does not set the value property of the checkbox input element wrapped by this widget. For access to that property, see setFormValue(String)

        Specified by:
        setValue in interface HasValue<java.lang.Boolean>
        Parameters:
        value - true to check, false to uncheck; null value implies false
        fireEvents - If true, and value has changed, fire a ValueChangeEvent

      • ensureDomEventHandlers

        protected void ensureDomEventHandlers()

      • onUnload

        protected void onUnload()
        This method is called when a widget is detached from the browser's document. Overridden because of IE bug that throws away checked state.
        Overrides:
        onUnload in class Widget