oracle.adf.view.faces.bi.component.graph

Class BaseFormat

java.lang.Object

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

oracle.adf.view.faces.bi.component.graph.BaseFormat

All Implemented Interfaces:

javax.faces.component.StateHolder

public class BaseFormat
extends BIComplexAttributeBase

The base component class for format tag under marker text. There are X1Format, Y1Format, Y2Format, ZFormat and StockVolumeFormat. User can specify scaling, autoPrecision and converter on this format to format the marker text as well as tooltip of the specific axis.

Since:

11.1.2.0.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	SCALING_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
BaseFormat()

Method Summary

Modifier and Type	Method and Description
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 Retrieves the number format for data axis
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 Specifies the number format for data axis
void	setScaling(java.lang.String scaling) Specifies the scaling of this component.

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

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, 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

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

BaseFormat

public BaseFormat()

Method Detail

getNumberFormat

@Deprecated
public NumberFormat getNumberFormat()

Deprecated. Use Converter Retrieves the number format for data axis

Returns:

the number format

setNumberFormat

@Deprecated
public void setNumberFormat(NumberFormat format)

Deprecated. Use Converter Specifies the number format for data axis

Parameters:

format - the number format

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

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase