gwt.material.design.addins.client.rating

Class MaterialRating

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

gwt.material.design.client.base.MaterialWidget

gwt.material.design.addins.client.rating.MaterialRating

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, 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.HasEnabled, com.google.gwt.user.client.ui.HasValue<Integer>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, gwt.material.design.client.base.HasAllDragAndDropHandlers, gwt.material.design.client.base.HasBorder, gwt.material.design.client.base.HasCenterOn, gwt.material.design.client.base.HasCircle, gwt.material.design.client.base.HasColors, gwt.material.design.client.base.HasDataAttributes, gwt.material.design.client.base.HasDepth, gwt.material.design.client.base.HasDimension, gwt.material.design.client.base.HasDraggableHandlers, gwt.material.design.client.base.HasDroppableHandlers, gwt.material.design.client.base.HasFlexbox, gwt.material.design.client.base.HasFloat, gwt.material.design.client.base.HasFontSize, gwt.material.design.client.base.HasFontWeight, gwt.material.design.client.base.HasGrid, gwt.material.design.client.base.HasHideOn, gwt.material.design.client.base.HasHoverable, gwt.material.design.client.base.HasId, gwt.material.design.client.base.HasInitialClasses, gwt.material.design.client.base.HasInlineStyle, gwt.material.design.client.base.HasInteractionHandlers, gwt.material.design.client.base.HasOpacity, gwt.material.design.client.base.HasOrientation, gwt.material.design.client.base.HasOrientationChangeHandler, gwt.material.design.client.base.HasScrollspy, gwt.material.design.client.base.HasSeparator, gwt.material.design.client.base.HasShadow, gwt.material.design.client.base.HasShowOn, gwt.material.design.client.base.HasTextAlign, gwt.material.design.client.base.HasTooltip, gwt.material.design.client.base.HasTransform, gwt.material.design.client.base.HasVerticalAlign, gwt.material.design.client.base.HasWaves, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialRating
extends gwt.material.design.client.base.MaterialWidget
implements com.google.gwt.user.client.ui.HasValue<Integer>

MaterialRating is the component used by the 5-star rating system, for example, allowing users to easily express their opinion about a product, review, video and so on.

By default, it uses the IconType.STAR to represent the selected rating, but other icons can be set using the setSelectedRatingIcon(IconType) method.

XML Namespace Declaration

 
 xmlns:ma='urn:import:gwt.material.design.addins.client'
 
 

UiBinder Usage:

 
 <ma:rating.MaterialRating ui:field="rating" />
 
 

To use different icons, for instance, hearts, you can set:

 
 <ma:rating.MaterialRating ui:field="rating" selectedRatingIcon="FAVORITE" unselectedRatingIcon="FAVORITE_BORDER" textColor="red" />
 
 

You can also set the maximum rating (the default is 5):

 
 <ma:rating.MaterialRating ui:field="rating" maxRating="7" />
 
 

Example Java Usage:

 
 MaterialRating rating = ... //create using new or using UiBinder
 rating.addValueChangeHandler(...); // MaterialRating implements HasValue<Integer>
 rating.setEditable(false); // disables user interaction
 rating.setValue(2); // directly sets the desired rating
 int selectedValue = rating.getValue(); // retrieves the selected rating
 
 

Custom styling:

You use change the MaterialRating style by using the material-rating CSS class. Selected rating icons have the material-rating-selected CSS class, and unselected the material-rating-unselected CSS class.

Author:

gilberto-torrezan

Nested Class Summary

Nested classes/interfaces inherited from class gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.base.MaterialWidget.Feature

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.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

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

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class gwt.material.design.client.base.MaterialWidget

$this

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
MaterialRating() Default constructor.
MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon, gwt.material.design.client.constants.IconType unselectedRatingIcon, gwt.material.design.client.constants.Color textColor)
MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon, gwt.material.design.client.constants.IconType unselectedRatingIcon, gwt.material.design.client.constants.Color textColor, Integer value)
MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon, gwt.material.design.client.constants.IconType unselectedRatingIcon, gwt.material.design.client.constants.Color textColor, Integer value, Integer maxRating)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Integer> handler)
void	clear()
int	getMaxRating() Returns the maximum selectable rating in this component.
gwt.material.design.client.constants.IconType	getSelectedRatingIcon() Returns the IconType used to represent the selected ratings.
gwt.material.design.client.constants.IconType	getUnselectedRatingIcon() Returns the IconType used to represent the not selected ratings.
Integer	getValue()
boolean	isEditable() Returns whether the component is editable by the user.
protected void	onLoad()
protected void	revalidateLayout() Method called internally by the component to re-validate the number of icons when the maximum rating is changed.
protected void	revalidateSelection(int rating) Method called internally by the component to revalidade selections by the user, switching the icons accordingly.
void	setEditable(boolean editable) Sets whether the user can interact with the component or not.
void	setMaxRating(int maxRating) Sets the maximum number of icons to show - which represents the maximum selectable rating.
void	setSelectedRatingIcon(gwt.material.design.client.constants.IconType selectedRatingIcon) Sets the IconType to be used to represent the selected ratings.
void	setUnselectedRatingIcon(gwt.material.design.client.constants.IconType unselectedRatingIcon) Sets the IconType to be used to represent the not selected ratings.
void	setValue(Integer value)
void	setValue(Integer value, boolean fireEvents)

Methods inherited from class gwt.material.design.client.base.MaterialWidget

$this, add, add, addAttachHandler, addBlurHandler, addClickHandler, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDragOverHandler, addDragStartHandler, addDropActivateHandler, addDropDeactivateHandler, addDropHandler, addFocusHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addOrientationChangeHandler, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, body, clearActiveClass, enableFeature, getBackfaceVisibility, getBackgroundColor, getBorder, getBorderBottom, getBorderLeft, getBorderMixin, getBorderRadius, getBorderRight, getBorderTop, getCenterOn, getCenterOnMixin, getChildren, getChildrenList, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getDimensionMixin, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHandlerRegistry, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getLayoutPosition, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getOrientation, getOrientationMixin, getPerspective, getPerspectiveOrigin, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipHTML, getTooltipMixin, getTooltipPosition, getTransform, getTransformMixin, getTransformOrigin, getTransformStyle, getTruncateMixin, getVerticalAlign, getVerticalAlignMixin, getWaves, getWavesMixin, getWidth, insert, insert, isCircle, isDetectOrientation, isEnabled, isFeatureEnabled, isHoverable, isSeparator, isTruncate, onUnload, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDetectOrientation, setDisplay, setEnabled, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOffset, setOpacity, setOrientation, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPerspective, setPerspectiveOrigin, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setStyle, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipHTML, setTooltipPosition, setTop, setTransform, setTransformOrigin, setTransformStyle, setTransition, setTruncate, setVerticalAlign, setVisibility, setWaves, stopTouchStartEvent, validate, window

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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, resolvePotentialElement, 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

Methods inherited from interface gwt.material.design.client.base.HasFlexbox

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterialRating

public MaterialRating()

Default constructor.

MaterialRating

public MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon,
                      gwt.material.design.client.constants.IconType unselectedRatingIcon,
                      gwt.material.design.client.constants.Color textColor)

MaterialRating

public MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon,
                      gwt.material.design.client.constants.IconType unselectedRatingIcon,
                      gwt.material.design.client.constants.Color textColor,
                      Integer value)

MaterialRating

public MaterialRating(gwt.material.design.client.constants.IconType selectedRatingIcon,
                      gwt.material.design.client.constants.IconType unselectedRatingIcon,
                      gwt.material.design.client.constants.Color textColor,
                      Integer value,
                      Integer maxRating)

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class gwt.material.design.client.base.MaterialWidget

setMaxRating

public void setMaxRating(int maxRating)

Sets the maximum number of icons to show - which represents the maximum selectable rating. The default is 5.

Parameters:

maxRating - The maximum selectable rating for this component

getMaxRating

public int getMaxRating()

Returns the maximum selectable rating in this component. The default is 5.

Returns:

The maximum rating

setSelectedRatingIcon

public void setSelectedRatingIcon(gwt.material.design.client.constants.IconType selectedRatingIcon)

Sets the IconType to be used to represent the selected ratings. The default is IconType.STAR.

Parameters:

selectedRatingIcon - The icon of the selected ratings

getSelectedRatingIcon

public gwt.material.design.client.constants.IconType getSelectedRatingIcon()

Returns the IconType used to represent the selected ratings. The default is IconType.STAR.

Returns:

The icon for selected ratings

setUnselectedRatingIcon

public void setUnselectedRatingIcon(gwt.material.design.client.constants.IconType unselectedRatingIcon)

Sets the IconType to be used to represent the not selected ratings. The default is IconType.STAR_BORDER.

Parameters:

unselectedRatingIcon - The icon of the unselected ratings

getUnselectedRatingIcon

public gwt.material.design.client.constants.IconType getUnselectedRatingIcon()

Returns the IconType used to represent the not selected ratings. The default is IconType.STAR_BORDER.

Returns:

The icon for unselected ratings

clear

public void clear()

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

clear in class com.google.gwt.user.client.ui.Panel

revalidateLayout

protected void revalidateLayout()

Method called internally by the component to re-validate the number of icons when the maximum rating is changed.

revalidateSelection

protected void revalidateSelection(int rating)

Method called internally by the component to revalidade selections by the user, switching the icons accordingly.

getValue

public Integer getValue()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<Integer>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<Integer>

setValue

public void setValue(Integer value)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<Integer>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Integer>

setValue

public void setValue(Integer value,
                     boolean fireEvents)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Integer>

setEditable

public void setEditable(boolean editable)

Sets whether the user can interact with the component or not. Non-editable MaterialRatings can only show values, not allowing users to change them. The default is true (editable).

Parameters:

editable - true to allow the user change the state of the component, false otherwise.

isEditable

public boolean isEditable()

Returns whether the component is editable by the user. The default is true (editable).

Returns:

true if the component is editable by the user, false otherwise'

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>