Skip navigation links

oracle.adf.view.faces.bi.component.gauge
Class UIRatingGauge

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.faces.bi.component.gauge.UIGaugeBase
oracle.adf.view.faces.bi.component.gauge.UIRatingGauge

All Implemented Interfaces:

javax.faces.component.StateHolder

public class UIRatingGauge

extends UIGaugeBase

Defines properties for a rating gauge.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CHANGED_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	INPUT_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	READ_ONLY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHAPE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSELECTED_SHAPE_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.gauge.UIGaugeBase

CLIENT_LISTENERS_KEY, EMPTY_TEXT_KEY, INLINE_STYLE_KEY, MAXIMUM_KEY, MINIMUM_KEY, PARTIAL_TRIGGERS_KEY, SHORT_DESC_KEY, STYLE_CLASS_KEY, TRANSITIONS_KEY, VALUE_CHANGE_LISTENER_KEY, VALUE_KEY, VISUAL_EFFECTS_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIRatingGauge()

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInputIncrement() Returns the change increment when editing the value.
java.lang.String	getRendererType()
java.lang.String	getShape() Returns the shape of the rating gauge increments.
java.lang.String	getUnselectedShape() Returns the shape of the unselected rating gauge increments.
boolean	isChanged() Returns whether the value of the gauge has already been set by the user.
boolean	isReadOnly() Returns true if the value of the gauge cannot be changed by the end user.
void	setChanged(boolean changed) Specifies whether the value of the gauge has already been set by the user.
void	setInputIncrement(java.lang.String increment) Specifies the change increment when editing the value.
void	setReadOnly(boolean readOnly) Specifies whether the value of the gauge can be changed by the end user.
void	setShape(java.lang.String shape) Specifies the shape of the rating gauge increments.
void	setUnselectedShape(java.lang.String shape) Specifies the shape of the unselected rating gauge increments.

Methods inherited from class oracle.adf.view.faces.bi.component.gauge.UIGaugeBase

addValueChangeListener, getEmptyText, getInlineStyle, getMaximum, getMinimum, getPartialTriggers, getShortDesc, getStyleClass, getTransitions, getValue, getValueChangeListener, getValueChangeListeners, getVisualEffects, removeValueChangeListener, setEmptyText, setInlineStyle, setMaximum, setMinimum, setPartialTriggers, setShortDesc, setStyleClass, setTransitions, setValue, setValueChangeListener, setVisualEffects

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CHANGED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY

INPUT_INCREMENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INPUT_INCREMENT_KEY

READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY

SHAPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHAPE_KEY

UNSELECTED_SHAPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSELECTED_SHAPE_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIRatingGauge

public UIRatingGauge()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIGaugeBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class UIGaugeBase

Throws:

javax.faces.event.AbortProcessingException

isChanged

public final boolean isChanged()

Returns whether the value of the gauge has already been set by the user.

setChanged

public final void setChanged(boolean changed)

Specifies whether the value of the gauge has already been set by the user.

getInputIncrement

public final java.lang.String getInputIncrement()

Returns the change increment when editing the value. Valid values are full (default) and half.

setInputIncrement

public final void setInputIncrement(java.lang.String increment)

Specifies the change increment when editing the value. Valid values are full (default) and half.

isReadOnly

public final boolean isReadOnly()

Returns true if the value of the gauge cannot be changed by the end user.

setReadOnly

public final void setReadOnly(boolean readOnly)

Specifies whether the value of the gauge can be changed by the end user.

getShape

public final java.lang.String getShape()

Returns the shape of the rating gauge increments. Valid values are star (default), circle, diamond, and rectangle.

setShape

public final void setShape(java.lang.String shape)

Specifies the shape of the rating gauge increments. Valid values are star (default), circle, diamond, and rectangle.

getUnselectedShape

public final java.lang.String getUnselectedShape()

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

setUnselectedShape

public final void setUnselectedShape(java.lang.String shape)

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.

Skip navigation links