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

Class BaseTitle

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

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

GraphFootnote, GraphSubtitle, GraphTitle

public class BaseTitle
extends BaseTextComponent

Base class for the title objects in a graph.

Since:

11.0

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
BaseTitle()

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 title.
java.lang.String	getText() Retrieves the text for the title.
boolean	isRendered() Indicates whether the title 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 title.
void	setHorizontalAlignment(java.lang.String align) Specifies the horizontal positioning of the title.
void	setRendered(boolean rendered) Specifies whether the title is rendered.
void	setText(java.lang.String str) Specifies the text for the title.

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_defaultRendered

protected boolean m_defaultRendered

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

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

BaseTitle

public BaseTitle()

Method Detail

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the text within the rectangle of the title. The constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT. When the text has been rotated to a vertical position, the horizontal alignment properties appear to move the text up and down, rather than left and right.

Automatic layout and doAutoLayout change the size of the rectangles for the GraphTitle, GraphSubtitle, and GraphFootnote so that they are just big enough for the text. Automatic layout and doAutoLayout then align the titles with the graph, based on the value of this property.

Returns:

A swing constant that represents the horozontal alignment for the text of this title.

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the title. When the text has been rotated to a vertical position, the horizontal alignment properties appear to move the text up and down, rather than left and right.

This method has no effect on axis titles in a 3-D graph.

Automatic layout and doAutoLayout change the size of the rectangles for the GraphTitle, GraphSubtitle, and GraphFootnote so that they are just big enough for the text. Automatic layout and doAutoLayout then align the titles with the graph, based on the value of this property.

Parameters:

a - A Swing constant that represents the horizontal alignment for the text of the title. Valid constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT.

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String align)

Specifies the horizontal positioning of the title.

Parameters:

align - Valid values are:

• CENTER
• LEADING
• LEFT (Default)
• RIGHT

setText

public void setText(java.lang.String str)

Specifies the text for the title. When you specify text for a title, the Rendered property of the title is automatically set to true.

If you use token substitution, pass a key string to this method, not a token string.

Parameters:

str - The text of this title.

See Also:

BaseTokenSubstitution.getKeyString(java.lang.String)

getText

public java.lang.String getText()

Retrieves the text for the title.

Returns:

The text for the title.

isRendered

public boolean isRendered()

Indicates whether the title is rendered.

Returns:

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

setRendered

public void setRendered(boolean rendered)

Specifies whether the title is rendered.

Parameters:

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

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