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

Class LegendTitle

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.LegendTitle

All Implemented Interfaces:

javax.faces.component.StateHolder

public class LegendTitle
extends BaseTextComponent

Defines properties for the legend title of a graph.

Since:

release specific (what release of product did this appear in)

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	HORZ_ALIGN_KEY
protected java.awt.Color	m_defaultFontColor
protected int	m_defaultFontSize
protected int	m_defaultFontStyle
protected java.lang.String	m_defaultFontTypeface
protected int	m_defaultHorizontalAlignment
protected boolean	m_defaultRendered
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_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
LegendTitle()

Method Summary

Modifier and Type	Method and Description
void	applyProperties(java.util.HashMap map) Applications do not need to call this method.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
int	getHorizontalAlignment() Retrieves the horizontal alignment for the text within the rectangle of the legend title.
java.lang.String	getText() Retrives the legend text for the fixed marked on the line in case of LINE_SELECT_POINT Graph type.
boolean	isRendered() Indicates whether this legend area is rendered.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the legend text.
void	setHorizontalAlignment(java.lang.String align) Specifies the horizontal positioning of the text.
void	setRendered(boolean rendered) Specifies whether this legend area is rendered.
void	setText(java.lang.String text) Specified the legend text for the fixed marker on the line in case of LINE_SELECT_POINT Graph type.

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_defaultHorizontalAlignment

protected int m_defaultHorizontalAlignment

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

m_defaultRendered

protected boolean m_defaultRendered

TYPE

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

HORZ_ALIGN_KEY

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

TEXT_KEY

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

RENDERED_KEY

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

Constructor Detail

LegendTitle

public LegendTitle()

Method Detail

getText

public java.lang.String getText()

Retrives the legend text for the fixed marked on the line in case of LINE_SELECT_POINT Graph type.

Returns:

setText

public void setText(java.lang.String text)

Specified the legend text for the fixed marker on the line in case of LINE_SELECT_POINT Graph type.

Parameters:

text -

isRendered

public boolean isRendered()

Indicates whether this legend area is rendered. Automatic graph layout respects this property.

Returns:

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

setRendered

public void setRendered(boolean rendered)

Specifies whether this legend area is rendered. Automatic graph layout respects this property.

Parameters:

yesNo - true to make it rendered, false to make it not rendered.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the text within the rectangle of the legend title. The constants are LEFT, CENTER and RIGHT.

Returns:

A swing constant that represents the horizontal alignment for this legend text.

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the legend text. The constants are LEFT, CENTER and RIGHT.

Parameters:

a - A swing constant that represents the horizontal alignment of this legend text.

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String align)

Specifies the horizontal positioning of the text.

Parameters:

align - Valid values are:

• CENTER
• LEADING
• LEFT (Default)
• RIGHT

applyProperties

public void applyProperties(java.util.HashMap map)

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

Overrides:

applyProperties in class BIComplexAttributeBase

Parameters:

map - hashMap that contains property value pairs.

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

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase