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

Class CmsRadioButtonGroupWidget

  • All Implemented Interfaces:
    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 CmsRadioButtonGroupWidget
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, I_CmsHasInit
    Widget class consisting of a group of radio buttons, of which at most one may be active.

    This is mostly a 'convenience widget' for creating and handling multiple radio buttons as a single widget. The radio buttons will be layed out vertically. If you need more control about the layout of the radio buttons, use multiple CmsRadioButton instances and link them with a CmsRadioButtonGroup.

    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 com.google.gwt.event.shared.SimpleEventBus m_eventBus
      The event bus.
      static java.lang.String WIDGET_TYPE
      The widget type identifier.

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

        DEBUG_ID_PREFIX

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsRadioButtonGroupWidget​(java.util.List<org.opencms.util.CmsPair<java.lang.String,​java.lang.String>> items)
      Creates a new instance from a list of key/value pairs.
      CmsRadioButtonGroupWidget​(java.util.Map<java.lang.String,​java.lang.String> items)
      Creates a new instance from a map of strings.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)  
      void fireEvent​(com.google.gwt.event.shared.GwtEvent<?> event)  
      java.lang.String getApparentValue()
      Returns the "apparent value", i.e.
      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.
      protected void init​(java.util.Map<java.lang.String,​java.lang.String> items)
      Internal method for initializing the widget with a list 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.

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