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

Class CmsMultiCheckBox

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, 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 CmsMultiCheckBox
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.dom.client.HasFocusHandlers
    A form widget consisting of a group of checkboxes.

    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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List<CmsCheckBox> m_checkboxes
      The list of checkboxes.
      protected CmsErrorWidget m_error
      Error display for this widget.
      protected java.util.Map<java.lang.String,​java.lang.String> m_items
      The select options of the multi check box.
      protected com.google.gwt.user.client.ui.Panel m_panel
      Panel which contains all the components of the widget.
      static java.lang.String WIDGET_TYPE
      The type string for this widget.

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

        DEBUG_ID_PREFIX

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsMultiCheckBox​(java.util.List<org.opencms.util.CmsPair<java.lang.String,​java.lang.String>> items)
      Constructs a new checkbox group from a list of string pairs.
      CmsMultiCheckBox​(java.util.Map<java.lang.String,​java.lang.String> items)
      Constructs a new checkbox group from a map from strings to strings.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addFocusHandler​(com.google.gwt.event.dom.client.FocusHandler handler)  
      com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)  
      protected void fireValueChanged​(java.lang.String newValue)
      Fires the value change event for the widget.
      java.lang.String getApparentValue()
      Returns the "apparent value", i.e.
      java.util.List<CmsCheckBox> getCheckboxes()
      Returns a list of all checkboxes.
      I_CmsFormWidget.FieldType getFieldType()
      Returns the type of data this widget produces.
      java.lang.Object getFormValue()
      Gets the selected/entered value from the widget.
      java.lang.String getFormValueAsString()
      Gets the current value of the widget as a string.
      java.util.Set<java.lang.String> getSelected()
      Returns the set of values of the selected checkboxes.
      protected void init​(java.util.Map<java.lang.String,​java.lang.String> items)
      Initializes the widget given a map of select options.
      static void initClass()
      Initializes this class.
      boolean isEnabled()
      Returns true if this widget 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 setEnabled​(boolean enabled)
      Enables or disables the widget.
      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 formValue)
      Sets the current value of the widget as a string.
      void setTextWeak​(boolean weak)
      Enables or disables italics display in the checkbox labels.

      • 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

    • Field Detail

      • m_items

        protected java.util.Map<java.lang.String,​java.lang.String> m_items
        The select options of the multi check box.

      • m_panel

        protected com.google.gwt.user.client.ui.Panel m_panel
        Panel which contains all the components of the widget.

    • Constructor Detail

      • CmsMultiCheckBox

        public CmsMultiCheckBox​(java.util.List<org.opencms.util.CmsPair<java.lang.String,​java.lang.String>> items)
        Constructs a new checkbox group from a list of string pairs.

        The first string of every pair is the value of the checkbox, the second string is the label.

        Parameters:
        items - a list of pairs of strings.

      • CmsMultiCheckBox

        public CmsMultiCheckBox​(java.util.Map<java.lang.String,​java.lang.String> items)
        Constructs a new checkbox group from a map from strings to strings.

        The keys of the map are used as the selection values of the checkboxes, while the value for a given key in the map is used as the label for the checkbox which is displayed to the user.

        Parameters:
        items - the map of checkbox options