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:

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 UIStatusMeterGauge
extends UIGaugeBase

Defines properties for a status meter 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	ANGLE_EXTENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_RADIUS_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	INNER_RADIUS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INPUT_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ORIENTATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLOT_AREA_BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLOT_AREA_BORDER_RADIUS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLOT_AREA_COLOR_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	START_ANGLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THRESHOLD_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_POSITION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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
UIStatusMeterGauge()

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getAngleExtent() Returns the angle extent of a gauge with circular orientation.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Returns the border color of the gauge indicator.
java.lang.String	getBorderRadius() Returns the border radius of the indicator and plot area.
java.awt.Color	getColor() Returns the fill color of the gauge indicator.
java.lang.String	getFamily()
java.lang.Number	getIndicatorSize() Returns the ratio of relative thickness of the indicator to the plot area.
java.lang.Number	getInnerRadius() Returns the inner radius of a gauge with circular orientation, defined by the distance from the center of the gauge to the innermost edge of the indicator and plot area.
java.lang.Number	getInputIncrement() Returns the change increment when editing the value.
java.lang.String	getOrientation() Returns the orientation of the statusmeter: horizontal - (Default) Displays a horizontal statusmeter circular - Displays a circular statusmeter vertical - Displays a vertical 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.awt.Color	getPlotAreaBorderColor() Returns the plot area border color of the gauge indicator.
java.lang.String	getPlotAreaBorderRadius() Returns the border radius of the indicator and plot area.
java.awt.Color	getPlotAreaColor() Returns the plot area fill color of the gauge indicator.
java.lang.String	getRendererType()
java.lang.Number	getStartAngle() Returns the start angle of a gauge with circular orientation.
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
java.lang.String	getTitle() Returns the title text.
java.lang.String	getTitlePosition() Returns the position of the title for horizontal and vertical gauges.
java.lang.String	getTitleStyle() Returns the font style for the title.
boolean	isReadOnly() Returns true if the value of the gauge cannot be changed by the end user.
void	setAngleExtent(java.lang.Number angleExtent) Specifies the angle extent of a gauge with circular orientation.
void	setBorderColor(java.awt.Color color) Specifies the border color of the gauge indicator.
void	setBorderRadius(java.lang.String borderRadius) Specifies the border radius of the indicator and plot area.
void	setColor(java.awt.Color color) Specifies the fill color of the gauge indicator.
void	setIndicatorSize(java.lang.Number size) Specifies the ratio of relative thickness of the indicator to the plot area.
void	setInnerRadius(java.lang.Number innerRadius) Specifies the inner radius of a gauge with circular orientation, defined by the distance from the center of the gauge to the innermost edge of the indicator and plot area.
void	setInputIncrement(java.lang.Number increment) Specifies the change increment when editing the value.
void	setOrientation(java.lang.String orientation) Specifies the orientation of the statusmeter: horizontal - (Default) Displays a horizontal statusmeter circular - Displays a circular statusmeter vertical - Displays a vertical 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	setPlotAreaBorderColor(java.awt.Color color) Specifies the plot area border color of the gauge indicator.
void	setPlotAreaBorderRadius(java.lang.String plotAreaBorderRadius) Specifies the border radius of the indicator and plot area.
void	setPlotAreaColor(java.awt.Color color) Specifies the plot area fill color of the gauge indicator.
void	setReadOnly(boolean readOnly) Specifies whether the value of the gauge can be changed by the end user.
void	setStartAngle(java.lang.Number startAngle) Specifies the start angle of a gauge with circular orientation.
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
void	setTitle(java.lang.String title) Specifies the title text.
void	setTitlePosition(java.lang.String titlePosition) Specifies the position of the title for horizontal and vertical gauges.
void	setTitleStyle(java.lang.String titleStyle) Specifies the font style for the title.

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

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

ANGLE_EXTENT_KEY

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

BORDER_COLOR_KEY

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

BORDER_RADIUS_KEY

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

INNER_RADIUS_KEY

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

INPUT_INCREMENT_KEY

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

PLOT_AREA_BORDER_COLOR_KEY

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

PLOT_AREA_BORDER_RADIUS_KEY

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

PLOT_AREA_COLOR_KEY

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

READ_ONLY_KEY

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

START_ANGLE_KEY

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

TITLE_KEY

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

TITLE_POSITION_KEY

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

TITLE_STYLE_KEY

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

getAngleExtent

public final java.lang.Number getAngleExtent()

Returns the angle extent of a gauge with circular orientation. Value should be provided in degrees. Default value is 360.

setAngleExtent

public final void setAngleExtent(java.lang.Number angleExtent)

Specifies the angle extent of a gauge with circular orientation. Value should be provided in degrees. Default value is 360.

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.

getBorderRadius

public final java.lang.String getBorderRadius()

Returns the border radius of the indicator and plot area. When set to "auto", the border radius is set to a built-in default. Acceptable input follows CSS border-radius attribute specifications. The plot area border radius can be overwritten with the plotAreaBorderRadius atribute.

setBorderRadius

public final void setBorderRadius(java.lang.String borderRadius)

Specifies the border radius of the indicator and plot area. When set to "auto", the border radius is set to a built-in default. Acceptable input follows CSS border-radius attribute specifications. The plot area border radius can be overwritten with the plotAreaBorderRadius atribute.

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 ratio of relative thickness of the indicator to the plot area. Valid values are postive numbers, default is 1.

setIndicatorSize

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

Specifies the ratio of relative thickness of the indicator to the plot area. Valid values are postive numbers, default is 1.

getInnerRadius

public final java.lang.Number getInnerRadius()

Returns the inner radius of a gauge with circular orientation, defined by the distance from the center of the gauge to the innermost edge of the indicator and plot area. Valid values are a percent or ratio from 0 to 1, default is .7.

setInnerRadius

public final void setInnerRadius(java.lang.Number innerRadius)

Specifies the inner radius of a gauge with circular orientation, defined by the distance from the center of the gauge to the innermost edge of the indicator and plot area. Valid values are a percent or ratio from 0 to 1, default is .7.

getInputIncrement

public final java.lang.Number getInputIncrement()

Returns the change increment when editing the value.

setInputIncrement

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

Specifies the change increment when editing the value.

getOrientation

public final java.lang.String getOrientation()

Returns the orientation of the statusmeter:

• horizontal - (Default) Displays a horizontal statusmeter
• circular - Displays a circular statusmeter
• vertical - Displays a vertical 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
• vertical - Displays a vertical 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

getPlotAreaBorderColor

public final java.awt.Color getPlotAreaBorderColor()

Returns the plot area border color of the gauge indicator.

setPlotAreaBorderColor

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

Specifies the plot area border color of the gauge indicator.

getPlotAreaBorderRadius

public final java.lang.String getPlotAreaBorderRadius()

Returns the border radius of the indicator and plot area. When set to "auto", the border radius is set to a built-in default. Acceptable input follows CSS border-radius attribute specifications. The plot area border radius can be overwritten with the plotAreaBorderRadius atribute.

setPlotAreaBorderRadius

public final void setPlotAreaBorderRadius(java.lang.String plotAreaBorderRadius)

Specifies the border radius of the indicator and plot area. When set to "auto", the border radius is set to a built-in default. Acceptable input follows CSS border-radius attribute specifications. The plot area border radius can be overwritten with the plotAreaBorderRadius atribute.

getPlotAreaColor

public final java.awt.Color getPlotAreaColor()

Returns the plot area fill color of the gauge indicator.

setPlotAreaColor

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

Specifies the plot area fill color of the gauge indicator.

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.

getStartAngle

public final java.lang.Number getStartAngle()

Returns the start angle of a gauge with circular orientation. Value should be provided in degrees. Default value is 90.

setStartAngle

public final void setStartAngle(java.lang.Number startAngle)

Specifies the start angle of a gauge with circular orientation. Value should be provided in degrees. Default value is 90.

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

getTitle

public final java.lang.String getTitle()

Returns the title text.

setTitle

public final void setTitle(java.lang.String title)

Specifies the title text.

getTitlePosition

public final java.lang.String getTitlePosition()

Returns the position of the title for horizontal and vertical gauges. The default position for horizontal gauges is 'start' and for vertical gauges is 'center'. Valid values are: auto (default), center, start

setTitlePosition

public final void setTitlePosition(java.lang.String titlePosition)

Specifies the position of the title for horizontal and vertical gauges. The default position for horizontal gauges is 'start' and for vertical gauges is 'center'. Valid values are: auto (default), center, start

getTitleStyle

public final java.lang.String getTitleStyle()

Returns the font style for the title. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

setTitleStyle

public final void setTitleStyle(java.lang.String titleStyle)

Specifies the font style for the title. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

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