public class GaugeOptions extends ExtendedPatternOptions
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.
|
Modifier and Type | Method and Description |
---|---|
void |
applyChanges(BinderParams bindParams)
Applies changes from this set of properties to the subtree rooted by the
bind root in the bind params.
|
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).
|
merge
public static final java.lang.String GAUGE_TYPE_DIAL
public static final java.lang.String GAUGE_TYPE_LED
public static final java.lang.String GAUGE_TYPE_STATUSMETER
public static final java.lang.String GAUGE_TYPE_VERTICALSTATUSMETER
public void applyChanges(BinderParams bindParams)
bindParams
- The bind params containing the binding rootpublic GaugeExtendedProperties getExtendedProperties()
ExtendedProperties
of this pattern if present.
Properties may be set on the extended properties until the component is
bound.getExtendedProperties
in class ExtendedPatternOptions
public GaugeBindingOptions getBindingOptions()
public static GaugeOptions cloneFrom(GaugeOptions options)
options
- the options class that properties will be transferred fromGaugeOptions
cloned from a given instance of GaugeOptions
.public void setGaugeType(java.lang.String strGaugeType)
Specifies the type of gauge (DIAL by default). Valid values are:
strGaugeType
- A String
representing the gauge type.GAUGE_TYPE_DIAL
,
GAUGE_TYPE_LED
,
GAUGE_TYPE_STATUSMETER
,
GAUGE_TYPE_VERTICALSTATUSMETER
public java.lang.String getGaugeType()
Retrieves the type of gauge (DIAL by default). Valid values are:
String
representing the gauge type.GAUGE_TYPE_DIAL
,
GAUGE_TYPE_LED
,
GAUGE_TYPE_STATUSMETER
,
GAUGE_TYPE_VERTICALSTATUSMETER
public void setGaugeBottomLabel(GaugeBottomLabel gaugeBottomLabel)
GaugeBottomLabel
.gaugeBottomLabel
- A GaugeBottomLabel
gauge bottom label.public GaugeBottomLabel getGaugeBottomLabel()
GaugeBottomLabel
.GaugeBottomLabel
representing the gauge bottom label.public void setGaugeTopLabel(GaugeTopLabel gaugeTopLabel)
GaugeTopLabel
.gaugeTopLabel
- A GaugeTopLabel
gauge top label.public GaugeTopLabel getGaugeTopLabel()
GaugeTopLabel
.GaugeTopLabel
representing the gauge top label.