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:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIRatingGauge
extends UIGaugeBase

Defines properties for a rating gauge.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	CHANGED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CHANGED_STYLE_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	HOVER_STYLE_KEY
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	SELECTED_STYLE_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
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSELECTED_STYLE_KEY

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

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

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UIRatingGauge()

Method Summary

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getChangedStyle() Gets the CSS style of the changed state for the shapes.
java.lang.String	getFamily()
java.lang.String	getHoverStyle() Specifies the CSS style of the hover state for the shapes.
java.lang.String	getInputIncrement() Returns the change increment when editing the value.
java.lang.String	getRendererType()
java.lang.String	getSelectedStyle() Gets the CSS style of the selected state for the shapes.
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.
java.lang.String	getUnselectedStyle() Gets the CSS style of the unselected state for the shapes.
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	setChangedStyle(java.lang.String changedStyle) Specifies the CSS style of the changed state for the shapes.
void	setHoverStyle(java.lang.String hoverStyle) Specifies the CSS style of the hover state for the shapes.
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	setSelectedStyle(java.lang.String selectedStyle) Specifies the CSS style of the selected state for the shapes.
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.
void	setUnselectedStyle(java.lang.String unselectedStyle) Specifies the CSS style of the unselected state for the shapes.

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

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

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, 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, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

CHANGED_STYLE_KEY

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

SELECTED_STYLE_KEY

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

UNSELECTED_STYLE_KEY

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

HOVER_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HOVER_STYLE_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.

• star - (Default)
• circle
• diamond
• rectangle
• triangle

setShape

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

Specifies the shape of the rating gauge increments.

• star - (Default)
• circle
• diamond
• rectangle
• triangle

getUnselectedShape

public final java.lang.String getUnselectedShape()

Returns the shape of the unselected rating gauge increments. Defaults to the value of the shape attribute.

• auto - (Default)
• star
• circle
• diamond
• rectangle
• triangle

setUnselectedShape

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

Specifies the shape of the unselected rating gauge increments. Defaults to the value of the shape attribute.

• auto - (Default)
• star
• circle
• diamond
• rectangle
• triangle

setChangedStyle

public void setChangedStyle(java.lang.String changedStyle)

Specifies the CSS style of the changed state for the shapes. Currently supports color and border-color.

getChangedStyle

public java.lang.String getChangedStyle()

Gets the CSS style of the changed state for the shapes. Currently supports color and border-color.

setSelectedStyle

public void setSelectedStyle(java.lang.String selectedStyle)

Specifies the CSS style of the selected state for the shapes. Currently supports color and border-color.

getSelectedStyle

public java.lang.String getSelectedStyle()

Gets the CSS style of the selected state for the shapes. Currently supports color and border-color.

setUnselectedStyle

public void setUnselectedStyle(java.lang.String unselectedStyle)

Specifies the CSS style of the unselected state for the shapes. Currently supports color and border-color.

getUnselectedStyle

public java.lang.String getUnselectedStyle()

Gets the CSS style of the unselected state for the shapes. Currently supports color and border-color.

setHoverStyle

public void setHoverStyle(java.lang.String hoverStyle)

Specifies the CSS style of the hover state for the shapes. Currently supports color and border-color.

getHoverStyle

public java.lang.String getHoverStyle()

Specifies the CSS style of the hover state for the shapes. Currently supports color and border-color.