Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
12c (12.1.3)
E41655-01

<dvt:ratingGauge>

UIComponent class: oracle.adf.view.faces.bi.component.gauge.UIRatingGauge
Component type: oracle.dss.adf.gauge.RatingGauge

Overview

A gauge displaying and optionally accepting input for a metric value. The rating gauge is commonly used to show ratings for products or services, such as the star rating for a movie.

Code Sample

<dvt:ratingGauge value="3" readOnly="false"/>

Browser Support and Output Formats

This component relies on HTML5 technologies available in modern browsers for animations and interactivity. When displayed in older browsers, such as IE8, a PNG image will be displayed. Animations and interactivity are not supported in these browsers.

Customization Options

Visual Effects

Visual effects such as gradients and overlays can be disabled to achieve a flatter look using the visualEffects attribute.

Interactivity Features

Note: As mentioned in the browser support section, the interactivity features are not supported in older browsers, such as IE8.

Popups and Context Menus

Popups and context menus can be displayed using af:showPopupBehavior.

Value Change Support

The readOnly attribute can be set to false enabling the end user to change the metric value of the gauge. The value change can be processed using valueChangeListener on the server or the valueChange and input event types on the client.

Screen Shot(s)

Events

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application, Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Attributes

Name	Type	Supports EL?	Description
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding	oracle.adf.view.faces.bi.component.gauge.UIRatingGauge	Only EL	Specifies a binding reference to store a specific instance of UIRatingGauge from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a gauge component in the sample managed bean, use the following code: `binding="#{sample.gauge}"`
changed	boolean	Yes	Default Value: false Specifies whether the value of the gauge has already been set by the user.
emptyText	String	Yes	The text of the component when empty.
id	String	No	Specifies the identifier for the component
inlineStyle	String	Yes	Style of the outer element (enclosing div) of the component
inputIncrement	String	Yes	Valid Values: full, half Default Value: full Specifies the change increment when editing the value. Valid values are full (default) and half.
maximum	Number	Yes	The maximum value for the gauge.
minimum	Number	Yes	The minimum value for the gauge.
partialTriggers	String[]	Yes	The IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
readOnly	boolean	Yes	Default Value: true Specifies whether the value of the gauge can be changed by the end user.
rendered	boolean	Yes	Default Value: true Specifies whether the component is rendered.
shape	String	Yes	Valid Values: circle, diamond, rectangle, star Default Value: star Specifies the shape of the rating gauge increments. Valid values are star (default), circle, diamond, and rectangle.
shortDesc	String	Yes	The short description of this component. This is used to customize the tooltip text.
styleClass	String	Yes	Sets a CSS style class to use for this component.
unselectedShape	String	Yes	Valid Values: auto, none, circle, diamond, dot, rectangle, star Default Value: auto Specifies the shape of the unselected rating gauge increments. Valid values are auto (default), circle, diamond, dot, rectangle, and star. Defaults to the value of the shape attribute.
value	Number	Yes	The metric value for the gauge.
valueChangeListener	javax.el.MethodExpression	Only EL	A method reference to a value change listener
visualEffects	String	Yes	Valid Values: none, auto Default Value: auto Specifies whether visual effects such as gradients and overlays are enabled. Valid values are "none" and "auto" (Default).