oracle.adfdt.view.dvt.binding.pattern.gauge

Class GaugeOptions

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.PatternOptions

oracle.adfdt.view.common.binding.creator.v2.ExtendedPatternOptions

oracle.adfdt.view.dvt.binding.pattern.gauge.GaugeOptions

public class GaugeOptions
extends ExtendedPatternOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GAUGE_TYPE_DIAL (Default) Depicts an N-degree circular shaped gauge.
static java.lang.String	GAUGE_TYPE_LED Graphically depicts a key measurement as defined by a key performance indicator (KPI).
static java.lang.String	GAUGE_TYPE_STATUSMETER A horizontal bar which indicates the progress of a task or the level of some measurement.
static java.lang.String	GAUGE_TYPE_VERTICALSTATUSMETER A vertical bar which indicates the progress of a task or the level of some measurement.

Method Summary

Methods

Modifier and Type	Method and Description
static GaugeOptions	cloneFrom(GaugeOptions options) Creates an options class from the specified options class, transferring any common properties
GaugeBindingOptions	getBindingOptions()
GaugeExtendedProperties	getExtendedProperties() Returns the ExtendedProperties of this pattern if present.
GaugeBottomLabel	getGaugeBottomLabel() Retrieves the GaugeBottomLabel.
GaugeTopLabel	getGaugeTopLabel() Retrieves the GaugeTopLabel.
java.lang.String	getGaugeType() Retrieves the type of gauge (DIAL by default).
void	setGaugeBottomLabel(GaugeBottomLabel gaugeBottomLabel) Specifies the GaugeBottomLabel.
void	setGaugeTopLabel(GaugeTopLabel gaugeTopLabel) Specifies the GaugeTopLabel.
void	setGaugeType(java.lang.String strGaugeType) Specifies the type of gauge (DIAL by default).

Methods inherited from class oracle.adfdt.view.common.binding.creator.v2.PatternOptions

merge

Methods inherited from class java.lang.Object

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

Field Detail

GAUGE_TYPE_DIAL

public static final java.lang.String GAUGE_TYPE_DIAL

(Default) Depicts an N-degree circular shaped gauge. N is specified by the angleExtent attribute.

See Also:

Constant Field Values

GAUGE_TYPE_LED

public static final java.lang.String GAUGE_TYPE_LED

Graphically depicts a key measurement as defined by a key performance indicator (KPI). Also gives a quick assessment of any metric by generalizing the metric to a specific value range.

See Also:

Constant Field Values

GAUGE_TYPE_STATUSMETER

public static final java.lang.String GAUGE_TYPE_STATUSMETER

A horizontal bar which indicates the progress of a task or the level of some measurement.

See Also:

Constant Field Values

GAUGE_TYPE_VERTICALSTATUSMETER

public static final java.lang.String GAUGE_TYPE_VERTICALSTATUSMETER

A vertical bar which indicates the progress of a task or the level of some measurement.

See Also:

Constant Field Values

Method Detail

getExtendedProperties

public GaugeExtendedProperties getExtendedProperties()

Description copied from class: ExtendedPatternOptions

Returns the ExtendedProperties of this pattern if present. Properties may be set on the extended properties until the component is bound.

Specified by:

getExtendedProperties in class ExtendedPatternOptions

getBindingOptions

public GaugeBindingOptions getBindingOptions()

cloneFrom

public static GaugeOptions cloneFrom(GaugeOptions options)

Creates an options class from the specified options class, transferring any common properties

Parameters:

options - the options class that properties will be transferred from

setGaugeType

public void setGaugeType(java.lang.String strGaugeType)

Specifies the type of gauge (DIAL by default). Valid values are:

• DIAL - (Default) Depicts an N-degree circular shaped gauge. N is specified by the angleExtent attribute.
• LED - Graphically depicts a key measurement as defined by a key performance indicator (KPI). Also gives a quick assessment of any metric by generalizing the metric to a specific value range.
• STATUSMETER - A horizontal bar which indicates the progress of a task or the level of some measurement.
• VERTICALSTATUSMETER - A vertical bar which indicates the progress of a task or the level of some measurement.

Parameters:

strGaugeType - A String representing the gauge type.

See Also:

GAUGE_TYPE_DIAL, GAUGE_TYPE_LED, GAUGE_TYPE_STATUSMETER, GAUGE_TYPE_VERTICALSTATUSMETER

getGaugeType

public java.lang.String getGaugeType()

Retrieves the type of gauge (DIAL by default). Valid values are:

• DIAL - (Default) Depicts an N-degree circular shaped gauge. N is specified by the angleExtent attribute.
• LED - Graphically depicts a key measurement as defined by a key performance indicator (KPI). Also gives a quick assessment of any metric by generalizing the metric to a specific value range.
• STATUSMETER - A horizontal bar which indicates the progress of a task or the level of some measurement.
• VERTICALSTATUSMETER - A vertical bar which indicates the progress of a task or the level of some measurement.

Returns:

String representing the gauge type.

See Also:

GAUGE_TYPE_DIAL, GAUGE_TYPE_LED, GAUGE_TYPE_STATUSMETER, GAUGE_TYPE_VERTICALSTATUSMETER

setGaugeBottomLabel

public void setGaugeBottomLabel(GaugeBottomLabel gaugeBottomLabel)

Specifies the GaugeBottomLabel.

Parameters:

gaugeBottomLabel - A GaugeBottomLabel gauge bottom label.

getGaugeBottomLabel

public GaugeBottomLabel getGaugeBottomLabel()

Retrieves the GaugeBottomLabel.

Returns:

GaugeBottomLabel representing the gauge bottom label.

setGaugeTopLabel

public void setGaugeTopLabel(GaugeTopLabel gaugeTopLabel)

Specifies the GaugeTopLabel.

Parameters:

gaugeTopLabel - A GaugeTopLabel gauge top label.

getGaugeTopLabel

public GaugeTopLabel getGaugeTopLabel()

Retrieves the GaugeTopLabel.

Returns:

GaugeTopLabel representing the gauge top label.