Package de.knightsoftnet.mtwidgets.client.ui.widget

Class RatingInputWidget

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
de.knightsoftnet.mtwidgets.client.ui.widget.RatingInputWidget
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Integer>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<Integer>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasValue<Integer>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>, org.gwtproject.editor.client.Editor<Integer>, org.gwtproject.editor.client.HasEditorErrors<Integer>, org.gwtproject.editor.client.IsEditor<ValueBoxEditor<Integer>>, org.gwtproject.editor.client.TakesValue<Integer>
public class RatingInputWidget extends com.google.gwt.user.client.ui.Composite implements com.google.gwt.user.client.ui.HasValue<Integer>, org.gwtproject.editor.client.TakesValue<Integer>, com.google.gwt.user.client.ui.Focusable, HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>
input field for star ratings.
Author:
Manfred Tremmel

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    RatingInputWidget.Resources
    A ClientBundle that provides images and style sheets for the decorator.

    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 org.gwtproject.editor.client.Editor

    org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

  • Field Summary

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    RatingInputWidget(int max, String idBase)
    default constructor.
    RatingInputWidget(int max, String idBase, RatingInputWidget.Resources resource)
    constructor with styling information.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Integer> handler)
     
    ValueBoxEditor<Integer>
    asEditor()
     
    protected void
    ensureDomEventHandlers()
     
    protected static RatingInputWidget.Resources
    getDefaultResources()
    get default resource, if not set, create one.
    int
    getTabIndex()
     
    com.google.gwt.user.client.ui.HTMLPanel
    getValidationMessageElement()
    get validation message element.
    Integer
    getValue()
     
    void
    setAccessKey(char key)
     
    void
    setCustomValidity(String message)
    set custom validity value.
    void
    setFocus(boolean focused)
     
    void
    setTabIndex(int index)
     
    void
    setTitle(String title)
    set title of element.
    void
    setValidationMessageElement(com.google.gwt.user.client.ui.HTMLPanel element)
    set validation message element.
    void
    setValue(Integer value)
     
    void
    setValue(Integer value, boolean fireEvents)
     

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

    Methods inherited from interface de.knightsoftnet.mtwidgets.client.ui.widget.features.HasValidationMessageElement

    editorErrorMatches, showErrors, showErrors

  • Constructor Details

    • RatingInputWidget

      @UiConstructor public RatingInputWidget(int max, String idBase)
      default constructor.
      Parameters:
      max - the number stars to display
      idBase - the id of the widget and base for the ids of the single radio buttons

    • RatingInputWidget

      public RatingInputWidget(int max, String idBase, RatingInputWidget.Resources resource)
      constructor with styling information.
      Parameters:
      max - the number stars to display
      idBase - the id of the widget and base for the ids of the single radio buttons
      resource - resources with styling information

  • Method Details

    • getDefaultResources

      protected static RatingInputWidget.Resources getDefaultResources()
      get default resource, if not set, create one.
      Returns:
      default resource.

    • setValue

      public void setValue(Integer value)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<Integer>
      Specified by:
      setValue in interface com.google.gwt.user.client.TakesValue<Integer>
      Specified by:
      setValue in interface org.gwtproject.editor.client.TakesValue<Integer>

    • setValue

      public void setValue(Integer value, boolean fireEvents)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<Integer>

    • getValue

      public Integer getValue()
      Specified by:
      getValue in interface com.google.gwt.user.client.ui.HasValue<Integer>
      Specified by:
      getValue in interface com.google.gwt.user.client.TakesValue<Integer>
      Specified by:
      getValue in interface org.gwtproject.editor.client.TakesValue<Integer>

    • addValueChangeHandler

      public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Integer> handler)
      Specified by:
      addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<Integer>

    • ensureDomEventHandlers

      protected void ensureDomEventHandlers()

    • setTabIndex

      public void setTabIndex(int index)
      Specified by:
      setTabIndex in interface com.google.gwt.user.client.ui.Focusable

    • getTabIndex

      public int getTabIndex()
      Specified by:
      getTabIndex in interface com.google.gwt.user.client.ui.Focusable

    • setAccessKey

      public void setAccessKey(char key)
      Specified by:
      setAccessKey in interface com.google.gwt.user.client.ui.Focusable

    • setFocus

      public void setFocus(boolean focused)
      Specified by:
      setFocus in interface com.google.gwt.user.client.ui.Focusable

    • asEditor

      public ValueBoxEditor<Integer> asEditor()
      Specified by:
      asEditor in interface org.gwtproject.editor.client.IsEditor<ValueBoxEditor<Integer>>

    • setCustomValidity

      public void setCustomValidity(String message)
      Description copied from interface: HasValidationMessageElement
      set custom validity value.
      Specified by:
      setCustomValidity in interface HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>
      Parameters:
      message - message to show

    • setTitle

      public void setTitle(String title)
      Description copied from interface: HasValidationMessageElement
      set title of element.
      Specified by:
      setTitle in interface HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>
      Overrides:
      setTitle in class com.google.gwt.user.client.ui.UIObject
      Parameters:
      title - title to set

    • setValidationMessageElement

      public void setValidationMessageElement(com.google.gwt.user.client.ui.HTMLPanel element)
      Description copied from interface: HasValidationMessageElement
      set validation message element.
      Specified by:
      setValidationMessageElement in interface HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>
      Parameters:
      element - element to set

    • getValidationMessageElement

      public com.google.gwt.user.client.ui.HTMLPanel getValidationMessageElement()
      Description copied from interface: HasValidationMessageElement
      get validation message element.
      Specified by:
      getValidationMessageElement in interface HasValidationMessageElement<Integer,ValueBoxEditor<Integer>>
      Returns:
      element or null if non is set