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

Class UIGaugeBase

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

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

Direct Known Subclasses:

UIDialGauge, UILedGauge, UIRatingGauge, UIStatusMeterGauge

public abstract class UIGaugeBase
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Abstract base class defining common properties for all gauge components.

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	ACTION_EXPRESSION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ACTION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAXIMUM_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINIMUM_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TRANSITIONS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_CHANGE_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	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
UIGaugeBase()

Method Summary

Modifier and Type	Method and Description
void	addValueChangeListener(javax.faces.event.ValueChangeListener listener) Adds a value change listener.
void	broadcast(javax.faces.event.FacesEvent event)
javax.el.MethodExpression	getActionExpression() Gets a reference to an action method sent by the component, or the static outcome of an action.
javax.faces.el.MethodBinding	getActionListener() Gets a method reference to an action listener
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getEmptyText() Returns the text displayed when no data has been provided to the gauge.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.Number	getMaximum() Returns the maximum value for this gauge.
java.lang.Number	getMinimum() Returns the minimum value for this gauge.
java.lang.String[]	getPartialTriggers() Retrieves the ids of the partial triggers for the component.
java.lang.String	getShortDesc() Returns the short description of this component.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
oracle.adf.view.rich.render.TransitionInfo[]	getTransitions() Retrieves the array of animation transitions applied to this component.
java.lang.Number	getValue() Returns the metric value for this gauge.
javax.el.MethodExpression	getValueChangeListener() Gets a method reference to a value change listener
javax.faces.event.ValueChangeListener[]	getValueChangeListeners() Returns an array of attached value change listeners.
java.lang.String	getVisualEffects() Returns whether visual effects such as gradients and overlays are enabled.
void	removeValueChangeListener(javax.faces.event.ValueChangeListener listener) Removes a selection listener.
void	setActionExpression(javax.el.MethodExpression actionExpression) Specifies a reference to an action method sent by the component, or the static outcome of an action.
void	setActionListener(javax.faces.el.MethodBinding actionListener) Sets a method reference to an action listener
void	setEmptyText(java.lang.String emptyText) Specifies the text displayed when no data has been provided to the gauge.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setMaximum(java.lang.Number value) Sets the maximum value for this gauge.
void	setMinimum(java.lang.Number value) Sets the minimum value for this gauge.
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the partial triggers for the component.
void	setShortDesc(java.lang.String shortDesc) Specifies the short description of this component.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setTransitions(oracle.adf.view.rich.render.TransitionInfo[] transitionInfo) Sets the array of animation transitions to be applied to this component.
void	setValue(java.lang.Number value) Sets the metric value for this gauge.
void	setValueChangeListener(javax.el.MethodExpression listener) Sets a method reference to a value change listener
void	setVisualEffects(java.lang.String visualEffects) Specifies whether visual effects such as gradients and overlays are enabled.

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, getFamily, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, 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, 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

VALUE_KEY

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

MINIMUM_KEY

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

MAXIMUM_KEY

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

ACTION_EXPRESSION_KEY

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

ACTION_LISTENER_KEY

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

CLIENT_LISTENERS_KEY

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

EMPTY_TEXT_KEY

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

INLINE_STYLE_KEY

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

PARTIAL_TRIGGERS_KEY

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

SHORT_DESC_KEY

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

STYLE_CLASS_KEY

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

TRANSITIONS_KEY

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

VALUE_CHANGE_LISTENER_KEY

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

VISUAL_EFFECTS_KEY

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

Constructor Detail

UIGaugeBase

public UIGaugeBase()

Method Detail

getBeanType

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

Overrides:

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

broadcast

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

Overrides:

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

Throws:

javax.faces.event.AbortProcessingException

getValue

public final java.lang.Number getValue()

Returns the metric value for this gauge.

Returns:

the metric value

setValue

public final void setValue(java.lang.Number value)

Sets the metric value for this gauge.

Parameters:

value - the metric value

getMinimum

public final java.lang.Number getMinimum()

Returns the minimum value for this gauge.

Returns:

the minimum value

setMinimum

public final void setMinimum(java.lang.Number value)

Sets the minimum value for this gauge.

Parameters:

value - the minimum value

getMaximum

public final java.lang.Number getMaximum()

Returns the maximum value for this gauge.

Returns:

the maximum value

setMaximum

public final void setMaximum(java.lang.Number value)

Sets the maximum value for this gauge.

Parameters:

value - the maximum value

getActionExpression

public javax.el.MethodExpression getActionExpression()

Gets a reference to an action method sent by the component, or the static outcome of an action.

Returns:

the new actionExpression value

setActionExpression

public void setActionExpression(javax.el.MethodExpression actionExpression)

Specifies a reference to an action method sent by the component, or the static outcome of an action.

Parameters:

actionExpression - the new actionExpression value

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Gets a method reference to an action listener

Returns:

the new actionListener value

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)

Sets a method reference to an action listener

Parameters:

actionListener - the new actionListener value

getEmptyText

public final java.lang.String getEmptyText()

Returns the text displayed when no data has been provided to the gauge.

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

Specifies the text displayed when no data has been provided to the gauge.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] ids)

Specifies the ids of the partial triggers for the component.

Parameters:

ids - The ids of the partial trigger components for the component.

See Also:

getPartialTriggers()

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Retrieves the ids of the partial triggers for the component.

Returns:

ids The ids of the partial trigger components for the component.

See Also:

setPartialTriggers(java.lang.String[])

getShortDesc

public final java.lang.String getShortDesc()

Returns the short description of this component. This is used to customize the tooltip text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Specifies the short description of this component. This is used to customize the tooltip text.

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component.

Parameters:

styleClass - the new styleClass value

getTransitions

public final oracle.adf.view.rich.render.TransitionInfo[] getTransitions()

Retrieves the array of animation transitions applied to this component. Supported trigger types are dataChange and display. Supported transitions are none (default) and auto. Transitions are currently not supported for rating gauge.

setTransitions

public final void setTransitions(oracle.adf.view.rich.render.TransitionInfo[] transitionInfo)

Sets the array of animation transitions to be applied to this component. Supported trigger types are dataChange and display. Supported transitions are none (default) and auto. Transitions are currently not supported for rating gauge.

getValueChangeListener

public final javax.el.MethodExpression getValueChangeListener()

Gets a method reference to a value change listener

setValueChangeListener

public final void setValueChangeListener(javax.el.MethodExpression listener)

Sets a method reference to a value change listener

getValueChangeListeners

public final javax.faces.event.ValueChangeListener[] getValueChangeListeners()

Returns an array of attached value change listeners.

addValueChangeListener

public final void addValueChangeListener(javax.faces.event.ValueChangeListener listener)

Adds a value change listener.

removeValueChangeListener

public final void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)

Removes a selection listener.

getVisualEffects

public final java.lang.String getVisualEffects()

Returns whether visual effects such as gradients and overlays are enabled. Valid values are "none" and "auto" (Default).

setVisualEffects

public final void setVisualEffects(java.lang.String visualEffects)

Specifies whether visual effects such as gradients and overlays are enabled. Valid values are "none" and "auto" (Default).