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

Class MetricLabel

java.lang.Object

oracle.adf.view.faces.bi.component.BIComplexAttributeBase

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

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class MetricLabel
extends BaseLabel

Defines properties for the metric label of a gauge.

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTOPRECISION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONVERTER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_TYPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCALING_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.gauge.BaseLabel

a_aboveGauge, a_belowGauge, a_insideGauge, a_insideGaugeLeft, a_insideGaugeRight, a_none, a_withBottomLabel, m_defaultPosition, POSITION_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.gauge.BaseText

FONT_COLOR_KEY, GAUGE_FONT_KEY, m_defaultFontColor, m_defaultFontSize, m_defaultFontStyle, m_defaultFontTypeface

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
MetricLabel()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProperties(java.util.HashMap map) Applications do not need to call this method.
java.lang.String	getAutoPrecision() Retrieves the precision of this component.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.faces.convert.Converter	getConverter() Retrieves the number converter
NumberFormat	getNumberFormat() Deprecated. Use Converter Gets the number format
int	getNumberType() Gets the type of number displayed in the tick label.
int	getPosition() Returns the position of the label.
java.lang.String	getScaling() Retrieves the scaling of this component.
void	setAutoPrecision(java.lang.String precision) Specifies the precision of this component.
void	setConverter(javax.faces.convert.Converter converter) Specifies the number converter
void	setNumberFormat(NumberFormat format) Deprecated. Use Converter Sets the number format
void	setNumberType(int type) Sets the type of number to be displayed in the tick label.
void	setNumberType(java.lang.String type) Format for numbers that are displayed in the metric label.
void	setPosition(int position) Specifies the position of the label.
void	setPosition(java.lang.String position) Specifies the location of the label.
void	setScaling(java.lang.String scaling) Specifies the scaling of this component.

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

resetStyleProperties

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

getGaugeFont, restoreState, setGaugeFont

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

NUMBER_FORMAT_KEY

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

NUMBER_TYPE_KEY

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

CONVERTER_KEY

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

SCALING_KEY

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

AUTOPRECISION_KEY

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

Constructor Detail

MetricLabel

public MetricLabel()

Method Detail

getPosition

public int getPosition()

Returns the position of the label.

Overrides:

getPosition in class BaseLabel

Returns:

the integer constant that represents where the label is placed. The following values are supported for all gauge types: GaugeAttributes.LP_NONE, GaugeAttributes.LP_BELOW_GAUGE, GaugeAttributes.LP_WITH_BOTTOM_LABEL, GaugeAttributes.LP_INSIDE_GAUGE. For statusmeter gauges, the following values are also supported: GaugeAttributes.LP_INSIDE_GAUGE_LEFT, GaugeAttributes.LP_INSIDE_GAUGE_RIGHT.

setPosition

public void setPosition(int position)

Specifies the position of the label.

Overrides:

setPosition in class BaseLabel

Parameters:

position - the integer constant that represents where the label is placed. The following values are supported for all gauge types: GaugeAttributes.LP_NONE, GaugeAttributes.LP_BELOW_GAUGE, GaugeAttributes.LP_WITH_BOTTOM_LABEL, GaugeAttributes.LP_INSIDE_GAUGE. For statusmeter gauges, the following values are also supported: GaugeAttributes.LP_INSIDE_GAUGE_LEFT, GaugeAttributes.LP_INSIDE_GAUGE_RIGHT.

setPosition

public void setPosition(java.lang.String position)

Specifies the location of the label.

Overrides:

setPosition in class BaseLabel

Parameters:

position - the String indicating where the labels are placed. The following values are supported for all gauge types:

• none - No label for the gauge.
• belowGauge - Displays the bottom / metric label below the gauge. Note: If the position of both the bottom label and the metric label are set to belowGauge, then both labels are displayed below the gauge. However, the bottom label is displayed above the metric label.
• insideGauge - Displays the label inside the gauge. Note: Top, bottom, and metric labels are horizontally centered across a gauge. When these labels are positioned inside a gauge, they are also centered vertically within the gauge plot area.
• withBottomLabel - Displays the metric label beside the bottom label. Note: If the position of the bottom label is set to none, the metric label will not be displayed.

For statusmeter gauges, the following values are also supported:

• insideGaugeLeft - Displays the label inside the gauge aligned left. Note: Top, bottom, and metric labels are horizontally centered across a gauge. When these labels are positioned inside a gauge, they are also centered vertically within the gauge plot area.
• insideGaugeRight - Displays the label inside the gauge aligned right. Note: Top, bottom, and metric labels are horizontally centered across a gauge. When these labels are positioned inside a gauge, they are also centered vertically within the gauge plot area.

getNumberFormat

@Deprecated
public NumberFormat getNumberFormat()

Deprecated. Use Converter Gets the number format

Returns:

format

setNumberFormat

@Deprecated
public void setNumberFormat(NumberFormat format)

Deprecated. Use Converter Sets the number format

Parameters:

format -

getNumberType

public int getNumberType()

Gets the type of number displayed in the tick label.

Returns:

Integer representing the type of number intended for display in this gauge; valid values are constants in Gauge beginning with NT_

setNumberType

public void setNumberType(int type)

Sets the type of number to be displayed in the tick label.

Parameters:

type - Integer representing the type of number intended for display in this gauge; valid values are constants in the Gauge class beginning with NT_

setNumberType

public void setNumberType(java.lang.String type)

Format for numbers that are displayed in the metric label. Valid values are:

Parameters:

type - Valid values are:

• number - (Default) Specifies that the actual values for the thresholds are displayed.
• percent - Specifies that the percentages for the thresholds are displayed.

getScaling

public java.lang.String getScaling()

Retrieves the scaling of this component. It is the scaling for numbers that are displayed. Valid values are:

• auto - (Default) The number will be scaled automatically.
• none - The number will not be scaled.
• thousand - The number will be scaled to thousands.
• million - The number will be scaled to millions.
• billion - The number will be scaled to billions.
• trillion - The number will be scaled to trillions.
• quadrillion - The number will be scaled to quadrillions.

Returns:

the scaling factor

setScaling

public void setScaling(java.lang.String scaling)

Specifies the scaling of this component. It is the scaling for numbers that are displayed. Valid values are:

• auto - (Default) The number will be scaled automatically.
• none - The number will not be scaled.
• thousand - The number will be scaled to thousands.
• million - The number will be scaled to millions.
• billion - The number will be scaled to billions.
• trillion - The number will be scaled to trillions.
• quadrillion - The number will be scaled to quadrillions.

Parameters:

scaling - the scaling factor

getAutoPrecision

public java.lang.String getAutoPrecision()

Retrieves the precision of this component. Whether to turn on the automatic precision for decimal digits. Valid values are:

• on - (Default) The number of decimal digits are determined automatically.
• off - The number of digits is based on the user specification from af:convertNumber

Returns:

the precision

setAutoPrecision

public void setAutoPrecision(java.lang.String precision)

Specifies the precision of this component. Whether to turn on the automatic precision for decimal digits. Valid values are:

• on - (Default) The number of decimal digits are determined automatically.
• off - The number of digits is based on the user specification from af:convertNumber

Parameters:

precision - the precision

getConverter

public javax.faces.convert.Converter getConverter()

Retrieves the number converter

Returns:

the numberConverter

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Specifies the number converter

Parameters:

converter - the numberConverter

applyProperties

public void applyProperties(java.util.HashMap map)

Description copied from class: BIComplexAttributeBase

Applications do not need to call this method. This is for internal use.

Overrides:

applyProperties in class BaseText

Parameters:

map - hashMap that contains property value pairs.

getBeanType

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

Overrides:

getBeanType in class BaseLabel