Package org.opencms.gwt.client.ui.input

Class CmsCheckBox

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsHasInit, I_CmsFormWidget
    public class CmsCheckBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.dom.client.HasClickHandlers, I_CmsFormWidget, I_CmsHasInit, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>
    This class represents a labeled checkbox which is not represented as an INPUT element in the DOM, but is displayed as an image.

    It can be checked/unchecked and enabled/disabled, which means 4 combinations in total. So you need to supply 4 images, one for each of the combinations.

    Since:
    8.0.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

        com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String WIDGET_TYPE
      Type string for this widget.

      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

      • Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

        ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsCheckBox()
      Default constructor which creates a checkbox without a label.
      CmsCheckBox​(java.lang.String labelText)
      Public constructor for a checkbox.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addClickHandler​(com.google.gwt.event.dom.client.ClickHandler handler)
      Adds a click handler to the checkbox.
      com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.Boolean> handler)  
      void disable​(java.lang.String disabledReason)
      Disables the checkbox and changes the checkbox title attribute to the disabled reason.
      void enable()
      Enables the checkbox, switching the checkbox title attribute from the disabled reason to the original title.
      protected void fireValueChangedEvent()
      Helper method for firing a 'value changed' event.
      java.lang.String getApparentValue()
      Returns the "apparent value", i.e.
      CmsToggleButton getButton()
      Gets the toggle button used internally.
      I_CmsFormWidget.FieldType getFieldType()
      Returns the type of data this widget produces.
      java.lang.Boolean getFormValue()
      Gets the selected/entered value from the widget.
      java.lang.String getFormValueAsString()
      Gets the current value of the widget as a string.
      com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()
      This is the alignment of the text in reference to the checkbox, possible values are left or right.
      java.lang.String getInternalValue()
      Returns the internal value of this Checkbox.
      java.lang.String getText()
      Returns the text.
      static void initClass()
      Initializes this class.
      boolean isChecked()
      Returns true if the checkbox is checked.
      boolean isEnabled()
      Returns true if the checkbox is enabled.
      void reset()
      Resets the widget to its default state.
      void setAutoHideParent​(I_CmsAutoHider autoHideParent)
      Call this when auto hiding parents are shown.
      void setChecked​(boolean checked)
      Checks or unchecks the checkbox.
      void setDisplayInline​(boolean inline)
      Toggles between display:inline-block and display:block.
      void setEnabled​(boolean enabled)
      Enables or disables the checkbox.
      void setErrorMessage​(java.lang.String errorMessage)
      Sets the error message for this widget.
      void setFormValue​(java.lang.Object value)
      Sets the value of the widget.
      void setFormValueAsString​(java.lang.String value)
      Sets the current value of the widget as a string.
      void setHorizontalAlignment​(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)
      This is the alignment of the text in reference to the checkbox, possible values are left or right.
      void setInternalValue​(java.lang.String value)
      Sets the internal value of this Checkbox.
      void setText​(java.lang.String text)
      Sets the text.

      • Methods inherited from class com.google.gwt.user.client.ui.Composite

        claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface com.google.gwt.event.shared.HasHandlers

        fireEvent

    • Constructor Detail

      • CmsCheckBox

        public CmsCheckBox()
        Default constructor which creates a checkbox without a label.

      • CmsCheckBox

        public CmsCheckBox​(java.lang.String labelText)
        Public constructor for a checkbox.

        The label text passed will be displayed to the right of the checkbox. If it is null, no label is displayed.

        Parameters:
        labelText - the label text

    • Method Detail

      • initClass

        public static void initClass()
        Initializes this class.

      • addClickHandler

        public com.google.gwt.event.shared.HandlerRegistration addClickHandler​(com.google.gwt.event.dom.client.ClickHandler handler)
        Adds a click handler to the checkbox.

        Specified by:
        addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers
        See Also:
        HasClickHandlers.addClickHandler(com.google.gwt.event.dom.client.ClickHandler)

      • addValueChangeHandler

        public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.Boolean> handler)
        Specified by:
        addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>
        See Also:
        HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

      • disable

        public void disable​(java.lang.String disabledReason)
        Disables the checkbox and changes the checkbox title attribute to the disabled reason.

        Parameters:
        disabledReason - the disabled reason

      • enable

        public void enable()
        Enables the checkbox, switching the checkbox title attribute from the disabled reason to the original title.

      • getHorizontalAlignment

        public com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()
        This is the alignment of the text in reference to the checkbox, possible values are left or right.

        Specified by:
        getHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment
        See Also:
        HasHorizontalAlignment.getHorizontalAlignment()

      • getInternalValue

        public java.lang.String getInternalValue()
        Returns the internal value of this Checkbox.

        Returns:
        the internal value of this Checkbox

      • getText

        public java.lang.String getText()
        Returns the text.

        Returns:
        the text as String

      • isChecked

        public boolean isChecked()
        Returns true if the checkbox is checked.

        Returns:
        true if the checkbox is checked

      • isEnabled

        public boolean isEnabled()
        Returns true if the checkbox is enabled.

        Specified by:
        isEnabled in interface I_CmsFormWidget
        Returns:
        true if the checkbox is enabled

      • setChecked

        public void setChecked​(boolean checked)
        Checks or unchecks the checkbox.

        Parameters:
        checked - if true, check the checkbox else uncheck it

      • setDisplayInline

        public void setDisplayInline​(boolean inline)
        Toggles between display:inline-block and display:block.

        Parameters:
        inline - true to display inline-block

      • setEnabled

        public void setEnabled​(boolean enabled)
        Enables or disables the checkbox.

        Specified by:
        setEnabled in interface I_CmsFormWidget
        Parameters:
        enabled - if true, enable the checkbox, else disable it

      • setFormValue

        public void setFormValue​(java.lang.Object value)
        Sets the value of the widget.

        Parameters:
        value - the new value

      • setHorizontalAlignment

        public void setHorizontalAlignment​(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)
        This is the alignment of the text in reference to the checkbox, possible values are left or right.

        Specified by:
        setHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment
        See Also:
        HasHorizontalAlignment.setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant)

      • setInternalValue

        public void setInternalValue​(java.lang.String value)
        Sets the internal value of this Checkbox.

        Parameters:
        value - the new internal value

      • setText

        public void setText​(java.lang.String text)
        Sets the text.

        Parameters:
        text - the text to set

      • fireValueChangedEvent

        protected void fireValueChangedEvent()
        Helper method for firing a 'value changed' event.