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

Class SliceLabel

java.lang.Object

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

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class SliceLabel
extends BaseTextComponent

Defines properties for the labels of a pie or funnel slice.

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
protected java.awt.Color	m_defaultFontColor
protected int	m_defaultFontSize
protected int	m_defaultFontStyle
protected java.lang.String	m_defaultFontTypeface
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCALING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_TYPE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.graph.BaseTextComponent

GRAPH_FONT_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
SliceLabel()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProperties(java.util.HashMap map) Applications should not 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 Retrieves the number format for data axis
java.lang.String	getScaling() Retrieves the scaling of this component.
int	getTextType() Retrieves a text type for this label.
boolean	isRendered() Indicates whether slice labels appear in the graph.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
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	setRendered(boolean rendered) Specifies whether slice labels appear in the graph.
void	setScaling(java.lang.String scaling) Specifies the scaling of this component.
void	setTextType(int i) Specifies a text type of this label.
void	setTextType(java.lang.String i) Specifies the type of contents to appear in a slice label.

Methods inherited from class oracle.adf.view.faces.bi.component.graph.BaseTextComponent

getGraphFont, setGraphFont

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

m_defaultFontTypeface

protected java.lang.String m_defaultFontTypeface

m_defaultFontStyle

protected int m_defaultFontStyle

m_defaultFontSize

protected int m_defaultFontSize

m_defaultFontColor

protected java.awt.Color m_defaultFontColor

TYPE

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

TEXT_TYPE_KEY

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

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

RENDERED_KEY

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

SliceLabel

public SliceLabel()

Method Detail

getTextType

public int getTextType()

Retrieves a text type for this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Returns:

A constant that represents a text type for this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT

setTextType

public void setTextType(int i)

Specifies a text type of this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Parameters:

i - A constant that represents a text type of this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT

setTextType

public void setTextType(java.lang.String i)

Specifies the type of contents to appear in a slice label. Valid values are:

Parameters:

i - A constant that represents a text type of this label.

• LD_TEXT - Slice labels contain text only.
• LD_VALUE - Slice labels contain a value.
• LD_PERCENT - (Default) Slice labels contain the percent that the slice represents in the graph.
• LD_TEXT_PERCENT - Slice labels contain both text and percent.

isRendered

public boolean isRendered()

Indicates whether slice labels appear in the graph.

Returns:

true if it is rendered, false if it is not rendered.

setRendered

public void setRendered(boolean rendered)

Specifies whether slice labels appear in the graph. Setting the Rendered property to false

Parameters:

rendered - true to display slice labels, false to hide them.

applyProperties

public void applyProperties(java.util.HashMap map)

Applications should not call this method.

Overrides:

applyProperties in class BIComplexAttributeBase

Parameters:

map -

resetStyleProperties

protected void resetStyleProperties()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                java.lang.Object stateObj)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class BIComplexAttributeBase

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