Skip navigation links

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class UIStatusMeterGauge

extends UIGaugeBase

Defines properties for a status meter gauge.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	INDICATOR_SIZE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ORIENTATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLOT_AREA_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	READ_ONLY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THRESHOLD_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

UIStatusMeterGauge()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Returns the border color of the gauge indicator.
java.awt.Color	getColor() Returns the fill color of the gauge indicator.
java.lang.String	getFamily()
java.lang.Number	getIndicatorSize() Returns the relative size of the indicator.
java.lang.String	getOrientation() Returns the orientation of the statusmeter: horizontal - (Default) Displays a horizontal statusmeter circular - Displays a circular statusmeter
java.lang.String	getPlotArea() Returns whether the plot area is displayed: auto - (Default) Displays only when thresholds are displayed on the plot area on off
java.lang.String	getRendererType()
java.lang.String	getThresholdDisplay() Returns the way in which the thresholds are displayed: onIndicator - (Default) Displays the current threshold on the indicator currentOnly - Displays the current threshold on the plotArea all - Displays all thresholds on the plotArea
boolean	isReadOnly() Returns true if the value of the gauge cannot be changed by the end user.
void	setBorderColor(java.awt.Color color) Specifies the border color of the gauge indicator.
void	setColor(java.awt.Color color) Specifies the fill color of the gauge indicator.
void	setIndicatorSize(java.lang.Number size) Specifies the relative size of the indicator.
void	setOrientation(java.lang.String orientation) Specifies the orientation of the statusmeter: horizontal - (Default) Displays a horizontal statusmeter circular - Displays a circular statusmeter
void	setPlotArea(java.lang.String plotArea) Specifies whether the plot area is displayed: auto - (Default) Displays only when thresholds are displayed on the plot area on off
void	setReadOnly(boolean readOnly) Specifies whether the value of the gauge can be changed by the end user.
void	setThresholdDisplay(java.lang.String thresholdDisplay) Specifies the way in which the thresholds are displayed: onIndicator - (Default) Displays the current threshold on the indicator currentOnly - Displays the current threshold on the plotArea all - Displays all thresholds on the plotArea

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

addValueChangeListener, broadcast, 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

BORDER_COLOR_KEY

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

COLOR_KEY

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

INDICATOR_SIZE_KEY

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

ORIENTATION_KEY

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

PLOT_AREA_KEY

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

READ_ONLY_KEY

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

THRESHOLD_DISPLAY_KEY

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

UIStatusMeterGauge

public UIStatusMeterGauge()

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

getBorderColor

public final java.awt.Color getBorderColor()

Returns the border color of the gauge indicator. Only applies when thresholds are not defined.

setBorderColor

public final void setBorderColor(java.awt.Color color)

Specifies the border color of the gauge indicator. Only applies when thresholds are not defined.

getColor

public final java.awt.Color getColor()

Returns the fill color of the gauge indicator. Only applies when thresholds are not defined.

setColor

public final void setColor(java.awt.Color color)

Specifies the fill color of the gauge indicator. Only applies when thresholds are not defined.

getIndicatorSize

public final java.lang.Number getIndicatorSize()

Returns the relative size of the indicator. Valid values are between 0 and 1 (default).

setIndicatorSize

public final void setIndicatorSize(java.lang.Number size)

Specifies the relative size of the indicator. Valid values are between 0 and 1 (default).

getOrientation

public final java.lang.String getOrientation()

Returns the orientation of the statusmeter:

• horizontal - (Default) Displays a horizontal statusmeter
• circular - Displays a circular statusmeter

setOrientation

public final void setOrientation(java.lang.String orientation)

Specifies the orientation of the statusmeter:

• horizontal - (Default) Displays a horizontal statusmeter
• circular - Displays a circular statusmeter

getPlotArea

public final java.lang.String getPlotArea()

Returns whether the plot area is displayed:

• auto - (Default) Displays only when thresholds are displayed on the plot area
• on
• off

setPlotArea

public final void setPlotArea(java.lang.String plotArea)

Specifies whether the plot area is displayed:

• auto - (Default) Displays only when thresholds are displayed on the plot area
• on
• off

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.

getThresholdDisplay

public final java.lang.String getThresholdDisplay()

Returns the way in which the thresholds are displayed:

• onIndicator - (Default) Displays the current threshold on the indicator
• currentOnly - Displays the current threshold on the plotArea
• all - Displays all thresholds on the plotArea

setThresholdDisplay

public final void setThresholdDisplay(java.lang.String thresholdDisplay)

Specifies the way in which the thresholds are displayed:

• onIndicator - (Default) Displays the current threshold on the indicator
• currentOnly - Displays the current threshold on the plotArea
• all - Displays all thresholds on the plotArea

Skip navigation links