com.sap.ui.commons.client
Class RatingIndicatorWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.RatingIndicatorWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class RatingIndicatorWidget
extends com.sap.ui.core.client.ControlWidget

The class RatingIndicator is the GWT wrapper for the Phoenix control: sap.ui.commons.RatingIndicator.

You can specify the amount of rating symbols, as well as the URIs to the image icons which shall be used as rating symbols. When the user performs a rating, an event is fired.

• Properties
  • visible : boolean
    Invisible rating indicators are not rendered.
  • editable : boolean
    Value "true" is required for displaying changed rating indicator colors, for example.
  • maxValue : int
    The amount of rating symbols.
  • value : float
    The current selected value.
  • iconSelected : String
    URI to the image which is displayed for all selected rating symbols. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.
  • iconUnselected : String
    URI to the image which is displayed for all deselected rating symbols. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.
  • iconHovered : String
    URI to the image which is displayed when hovering the mouse onto a rating symbol. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.
  • visualMode : com.sap.ui.commons.client.RatingIndicatorVisualMode
    Defines how float values are visualized.
• Aggregations
• Associations
• Events
  • change The event is fired when the user has done a rating.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: )

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 inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	RatingIndicatorWidget() constructs the class RatingIndicatorWidget
protected	RatingIndicatorWidget(RatingIndicator control) constructs the class RatingIndicatorWidget
	RatingIndicatorWidget(String id) constructs the class RatingIndicatorWidget

Method Summary

void	attachChangeEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener The event is fired when the user has done a rating.
void	detachChangeEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener The event is fired when the user has done a rating.
RatingIndicator	getControl() returns the reference to the Phoenix Control
String	getIconHovered() Getter for property iconHovered URI to the image which is displayed when hovering the mouse onto a rating symbol.
String	getIconSelected() Getter for property iconSelected URI to the image which is displayed for all selected rating symbols.
String	getIconUnselected() Getter for property iconUnselected URI to the image which is displayed for all deselected rating symbols.
int	getMaxValue() Getter for property maxValue The amount of rating symbols.
float	getValue() Getter for property value The current selected value.
RatingIndicatorVisualMode	getVisualMode() Getter for property visualMode Defines how float values are visualized.
boolean	isEditable() Getter for property editable Value "true" is required for displaying changed rating indicator colors, for example.
boolean	isVisible() Getter for property visible Invisible rating indicators are not rendered.
void	setEditable(boolean value) Setter for property editable Default value is: true
void	setIconHovered(String value) Setter for property iconHovered
void	setIconSelected(String value) Setter for property iconSelected
void	setIconUnselected(String value) Setter for property iconUnselected
void	setMaxValue(int value) Setter for property maxValue Default value is: 5
void	setValue(float value) Setter for property value Default value is: 0
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setVisualMode(RatingIndicatorVisualMode value) Setter for property visualMode Default value is: Half

Methods inherited from class com.sap.ui.core.client.ControlWidget

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

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, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingIndicatorWidget

public RatingIndicatorWidget()

constructs the class RatingIndicatorWidget

RatingIndicatorWidget

public RatingIndicatorWidget(String id)

constructs the class RatingIndicatorWidget

Parameters:

id - id of the RatingIndicatorWidget

RatingIndicatorWidget

protected RatingIndicatorWidget(RatingIndicator control)

constructs the class RatingIndicatorWidget

Parameters:

control - reference to an existing RatingIndicator

Method Detail

getControl

public RatingIndicator getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

isVisible

public boolean isVisible()

Getter for property visible Invisible rating indicators are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

isEditable

public boolean isEditable()

Getter for property editable Value "true" is required for displaying changed rating indicator colors, for example.

Returns:

the value of property editable

setEditable

public void setEditable(boolean value)

Setter for property editable
Default value is: true

Parameters:

value - boolean

getMaxValue

public int getMaxValue()

Getter for property maxValue The amount of rating symbols.

Returns:

the value of property maxValue

setMaxValue

public void setMaxValue(int value)

Setter for property maxValue
Default value is: 5

Parameters:

value - int

getValue

public float getValue()

Getter for property value The current selected value.

Returns:

the value of property value

setValue

public void setValue(float value)

Setter for property value
Default value is: 0

Parameters:

value - float

getIconSelected

public String getIconSelected()

Getter for property iconSelected URI to the image which is displayed for all selected rating symbols. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.

Returns:

the value of property iconSelected

setIconSelected

public void setIconSelected(String value)

Setter for property iconSelected

Parameters:

value - String

getIconUnselected

public String getIconUnselected()

Getter for property iconUnselected URI to the image which is displayed for all deselected rating symbols. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.

Returns:

the value of property iconUnselected

setIconUnselected

public void setIconUnselected(String value)

Setter for property iconUnselected

Parameters:

value - String

getIconHovered

public String getIconHovered()

Getter for property iconHovered URI to the image which is displayed when hovering the mouse onto a rating symbol. When this icon-relevant attribute is used also the other icon attributes have to be set. Requirement is that all custom icons have the same size.

Returns:

the value of property iconHovered

setIconHovered

public void setIconHovered(String value)

Setter for property iconHovered

Parameters:

value - String

getVisualMode

public RatingIndicatorVisualMode getVisualMode()

Getter for property visualMode Defines how float values are visualized.

Returns:

the value of property visualMode

setVisualMode

public void setVisualMode(RatingIndicatorVisualMode value)

Setter for property visualMode
Default value is: Half

Parameters:

value - com.sap.ui.commons.client.RatingIndicatorVisualMode

attachChangeEvent

public void attachChangeEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener The event is fired when the user has done a rating.

Event Parameters:

{int} value The rated value.

Parameters:

listener - reference to the EventListener

detachChangeEvent

public void detachChangeEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener The event is fired when the user has done a rating.

Parameters:

listener - reference to the EventListener