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

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.graph.LegendArea

All Implemented Interfaces:

javax.faces.component.StateHolder

public class LegendArea
extends BIComplexAttributeBase

Defines properties for the legend area of a graph.

Since:

11.0

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ALONG_EDGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTO_PLACEMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_TRANSPARENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILL_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILL_TRANSPARENT_KEY
protected boolean	m_defaultAlongGraphEdge
protected int	m_defaultAutomaticPlacement
protected java.awt.Color	m_defaultBorderColor
protected boolean	m_defaultBorderTransparent
protected java.awt.Color	m_defaultFillColor
protected boolean	m_defaultFillTransparent
protected java.lang.String	m_defaultLegendScrolling
protected int	m_defaultPosition
protected boolean	m_defaultRendered
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITION_HINT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLLING_KEY
static java.lang.String	SCROLLING_KEY_NAME
static org.apache.myfaces.trinidad.bean.PropertyKey	SFX_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

LegendArea()

Method Summary

int	getAutomaticPlacement() Indicates when the legend position is automatically determined when automatic layout is enabled (when the AutoLayout property of the graph is set to AL_ALWAYS or AL_AS_NEEDED).
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Retrieves the color of the border for this legend area.
java.awt.Color	getFillColor() Retrieves the fill color of this legend area.
java.lang.String	getMaxWidth() Retrieves the maximum width that was set for this legend area on the graph.
int	getPosition() Retrieves the position that was set for this legend area on the graph.
java.lang.String	getPositionHint() Retrieves the position hint that was set for this legend area on the graph.
java.lang.String	getScrolling() Retrieves the legend scrolling behavior.
SpecialEffects	getSpecialEffects()
boolean	isAlongGraphEdge() Indicates whether the legend is along the entire edge of the graph, or if there is space between the legend and the graph edge.
boolean	isBorderTransparent() Indicates whether the border of this legend area is transparent.
boolean	isFillTransparent() Indicates whether the fill color of this legend area is transparent.
boolean	isRendered() Indicates whether this legend area is rendered.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setAlongGraphEdge(boolean alongEdge) Specifies whether to place the legend along the edge of the graph or away from the edge.
void	setAutomaticPlacement(int placement) Specifies whether or not the legend should be automatically positioned as a part of automatic graph layout.
void	setAutomaticPlacement(java.lang.String placement) Specifies whether or not the legend should be automatically positioned as a part of automatic graph layout.
void	setBorderColor(java.awt.Color newColor) Specifies the color of the border for this legend area.
void	setBorderTransparent(boolean yesNo) Specifies whether the border of this legend area is transparent.
void	setFillColor(java.awt.Color newColor) Specifies the fill color of this legend area.
void	setFillTransparent(boolean yesNo) Specifies whether the fill color of this legend area is transparent.
void	setMaxWith(java.lang.String maxWidth) Specifies the maximum width for this legend area on the graph.
void	setPosition(int position) Specifies the position of the rectangle for this legend area on the graph.
void	setPosition(java.lang.String position) Specifies the position of the rectangle for this legend area on the graph.
void	setPositionHint(java.lang.String positionHint) Specifies the position hint for this legend area on the graph.
void	setRendered(boolean rendered) Specifies whether this legend area is rendered.
void	setScrolling(java.lang.String scrolling) Specifies the legend scrolling behavior.
void	setSpecialEffects(SpecialEffects sfx)

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

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

protected int m_defaultPosition

m_defaultAlongGraphEdge

protected boolean m_defaultAlongGraphEdge

m_defaultAutomaticPlacement

protected int m_defaultAutomaticPlacement

m_defaultBorderTransparent

protected boolean m_defaultBorderTransparent

m_defaultFillTransparent

protected boolean m_defaultFillTransparent

m_defaultBorderColor

protected java.awt.Color m_defaultBorderColor

m_defaultFillColor

protected java.awt.Color m_defaultFillColor

m_defaultRendered

protected boolean m_defaultRendered

m_defaultLegendScrolling

protected java.lang.String m_defaultLegendScrolling

TYPE

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

FILL_COLOR_KEY

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

BORDER_COLOR_KEY

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

FILL_TRANSPARENT_KEY

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

BORDER_TRANSPARENT_KEY

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

RENDERED_KEY

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

POSITION_KEY

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

POSITION_HINT_KEY

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

ALONG_EDGE_KEY

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

AUTO_PLACEMENT_KEY

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

SFX_KEY

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

SCROLLING_KEY

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

MAX_WIDTH_KEY

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

SCROLLING_KEY_NAME

public static final java.lang.String SCROLLING_KEY_NAME

See Also:

Constant Field Values

Constructor Detail

LegendArea

public LegendArea()

Method Detail

getBorderColor

public java.awt.Color getBorderColor()

Retrieves the color of the border for this legend area.

Automatic graph layout respects this property.

Returns:

The color of the border for this legend area.

setBorderColor

public void setBorderColor(java.awt.Color newColor)

Specifies the color of the border for this legend area.

Automatic graph layout respects this property.

Parameters:

newColor - The color of the border for this legend area.

isBorderTransparent

public boolean isBorderTransparent()

Indicates whether the border of this legend area is transparent. To make the legend area transparent, set both the setBorderTransparent and setFillTransparent methods to false. When an attribute or an object is transparent, it is not rendered, but you can select it.

Automatic graph layout respects this property.

Returns:

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

setBorderTransparent

public void setBorderTransparent(boolean yesNo)

Specifies whether the border of this legend area is transparent. To make the legend area transparent, set both the setBorderTransparent and setFillTransparent methods to false. When an attribute or an object is transparent, it is not rendered, but you can select it.

Automatic graph layout respects this property.

Parameters:

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

isFillTransparent

public boolean isFillTransparent()

Indicates whether the fill color of this legend area is transparent. To make the legend area transparent, set both the setBorderTransparent and setFillTransparent methods to false. When an attribute or an object is transparent, it is not rendered, but you can select it.

Automatic graph layout respects this property.

Returns:

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

setFillTransparent

public void setFillTransparent(boolean yesNo)

Specifies whether the fill color of this legend area is transparent. To make the legend area transparent, set both the setBorderTransparent and setFillTransparent methods to false. When an attribute or an object is transparent, it is not rendered, but you can select it.

Automatic graph layout respects this property.

Parameters:

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

getFillColor

public java.awt.Color getFillColor()

Retrieves the fill color of this legend area.

Automatic graph layout respects this property.

Returns:

The fill color of this legend area.

setFillColor

public void setFillColor(java.awt.Color newColor)

Specifies the fill color of this legend area.

Automatic graph layout respects this property.

Parameters:

newColor - The fill color of this legend area.

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.

getPosition

public int getPosition()

Retrieves the position that was set for this legend area on the graph. This method returns the setting that was specified through the user interface panel or through the API. This method does not account for changes that the user might make through direct manipulation of the Java-client graph, when graph automatic layout is disabled. For example, if you call setPosition to LAP_TOP, and a user later drags the legend to the right of the graph, this method still returns LAP_TOP, even though the legend appears at the right of the graph.

Automatic graph layout respects this property if the AutomaticPlacement property is set to AP_NEVER. If AutomaticPlacement is set to AP_ALWAYS, then automatic graph layout ignores this property, and doAutoLayout sets this property either to LAP_BOTTOM or to LAP_RIGHT.

Returns:

A constant that represents the position of this legend area on the graph. The constants are listed in the See Also section.

See Also:

setAutomaticPlacement(int), BaseGraphComponent.LAP_BOTTOM, BaseGraphComponent.LAP_LEFT, BaseGraphComponent.LAP_RIGHT, BaseGraphComponent.LAP_TOP, Graph#setAutoLayout, Graph#doAutoLayout

setPosition

public void setPosition(int position)

Specifies the position of the rectangle for this legend area on the graph.

Automatic graph layout respects this property if the AutomaticPlacement property is set to AP_NEVER. If AutomaticPlacement is set to AP_ALWAYS, then automatic graph layout ignores this property, and doAutoLayout sets this property either to LAP_BOTTOM or to LAP_RIGHT.

Parameters:

position - A constant that represents the position of the rectangle for this legend area on the graph. Valid constants are listed in the See Also section.

See Also:

setAutomaticPlacement(int), BaseGraphComponent.LAP_BOTTOM, BaseGraphComponent.LAP_LEFT, BaseGraphComponent.LAP_RIGHT, BaseGraphComponent.LAP_TOP, Graph#setAutoLayout, Graph#doAutoLayout

setPosition

public void setPosition(java.lang.String position)

Specifies the position of the rectangle for this legend area on the graph.

Automatic graph layout respects this property if the AutomaticPlacement property is set to AP_NEVER. If AutomaticPlacement is set to AP_ALWAYS, then automatic graph layout ignores this property, and doAutoLayout sets this property either to LAP_BOTTOM or to LAP_RIGHT.

Parameters:

position - A constant that represents the position of the rectangle for this legend area on the graph. Specifies a constant that indicates the position of this legend area on the graph. Valid values are:

• LAP_BOTTOM - Positions the legend area at the bottom of the graph.
• LAP_LEFT - Positions the legend area on the left of the graph.
• LAP_RIGHT - (Default) Positions the legend area on the right of the graph.
• LAP_TOP - Positions the legend area at the top of the graph.

getPositionHint

public java.lang.String getPositionHint()

Retrieves the position hint that was set for this legend area on the graph. Valid values are:
alignToCenter - The legend is aligned toward the center of the plot area.
alignToEdge - The legend is aligned toward the edge of the graph frame.

Returns:

the position hint for this legend area on the graph.

setPositionHint

public void setPositionHint(java.lang.String positionHint)

Specifies the position hint for this legend area on the graph. Valid values are:
alignToCenter - The legend is aligned toward the center of the plot area.
alignToEdge - The legend is aligned toward the edge of the graph frame.

Parameters:

the - position hint for this legend area on the graph.

setAlongGraphEdge

public void setAlongGraphEdge(boolean alongEdge)

Specifies whether to place the legend along the edge of the graph or away from the edge. When this property is set to true, then the legend area covers the entire edge of the graph. When this property is false, then the legend has a variable size, and white space, and possibly graph titles, appear between the legend and the edge of the graph.

When you set AlongGraphEdge to true, then any visible graph titles are moved, so that they do not overlap the legend area:

• If the legend is at the top of the graph, then the title and subtitle appear below the legend.
• If the legend is at the bottom of the graph, then the footnote appears above the legend.
• If the legend is at the right or left edge of the graph, then the title and subtitle are centered in the reduced space that is available to them. If the legend is at the right edge, the footnote is aligned next to the legend.

When AlongGraphEdge to false, then the graph does not generally move the visible titles. If you set AlongGraphEdge to false after it has been set to true, then the titles move back to default positions. For example, if the legend is along the top edge of the graph and you set AlongGraphEdge to false, then the title and subtitle move back above the legend area.

The default value of AlongGraphEdge is false.

Note: If AlongGraphEdge and AutomaticPlacement are both set to true, then the title, subtitle and footnote cannot be moved by direct manipulation.

Automatic graph layout respects this property. You should enable automatic graph layout when you set this property to true.

Note:Legend scrolling is not supported when alongGraphEdge is true.

Parameters:

alongEdge - true to place the legend along the entire edge of the graph, false to leave space around the legend.

See Also:

setAutomaticPlacement(int), setPosition(int), Graph#setAutoLayout

isAlongGraphEdge

public boolean isAlongGraphEdge()

Indicates whether the legend is along the entire edge of the graph, or if there is space between the legend and the graph edge.

Automatic graph layout respects this property.

Returns:

true if the legend is along the entire edge of the graph, false if there is some space around the edge.

setAutomaticPlacement

public void setAutomaticPlacement(int placement)

Specifies whether or not the legend should be automatically positioned as a part of automatic graph layout.

When automatic graph layout is disabled, this property setting has effect only when you call the doAutoLayout method of the graph.

The doAutoLayout method sets this property to AP_NEVER so you can adjust the placement. doAutoLayout(Graph.HONOR_PROPERTIES) honors this property. doAutoLayout(Graph.RESET_PROPERTIES) treats this property as AP_ALWAYS.

Parameters:

placement - A constant that represents whether to include the legend position as part of automatic graph layout. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.AP_ALWAYS, BaseGraphComponent.AP_NEVER, Graph#setAutoLayout, Graph#doAutoLayout

setAutomaticPlacement

public void setAutomaticPlacement(java.lang.String placement)

Specifies whether or not the legend should be automatically positioned as a part of automatic graph layout.

When automatic graph layout is disabled, this property setting has effect only when you call the doAutoLayout method of the graph.

The doAutoLayout method sets this property to AP_NEVER so you can adjust the placement. doAutoLayout(Graph.HONOR_PROPERTIES) honors this property. doAutoLayout(Graph.RESET_PROPERTIES) treats this property as AP_ALWAYS.

Parameters:

placement - A constant that represents whether to include the legend position as part of automatic graph layout. Specifies whether the graph should automatically position the legend area on the graph. Valid values are:

• AP_ALWAYS - (Default) Automatic graph layout determines whether to position the legend on the right or the bottom.
• AP_NEVER - The graph layout engine respects the setting of the position attribute of the legend area.

getAutomaticPlacement

public int getAutomaticPlacement()

Indicates when the legend position is automatically determined when automatic layout is enabled (when the AutoLayout property of the graph is set to AL_ALWAYS or AL_AS_NEEDED).

When AutomaticPlacement is set to AP_ALWAYS, automatic layout places the legend area at the bottom of the graph or to the right of the plot area.

The doAutoLayout method sets this property to AP_NEVER so you can adjust the placement. doAutoLayout(Graph.HONOR_PROPERTIES) honors this property. doAutoLayout(Graph.RESET_PROPERTIES) treats this property as AP_ALWAYS.

Returns:

A constant that represents when the legend position is automatic. Possible constants are listed in the See Also section.

See Also:

BaseGraphComponent.AP_ALWAYS, BaseGraphComponent.AP_NEVER, Graph#setAutoLayout, Graph#doAutoLayout

setScrolling

public void setScrolling(java.lang.String scrolling)

Specifies the legend scrolling behavior.

"off" - Legend scrolling is always off.
"asNeeded" - Legend scrolling will be turned on if the required legend space exceeds the available space.

Parameters:

scrolling - The legend scrolling behavior.

getScrolling

public java.lang.String getScrolling()

Retrieves the legend scrolling behavior.
"off" - Legend scrolling is always off.
"asNeeded" - Legend scrolling will be turned on if the required legend space exceeds the available space.

Returns:

The legend scrolling behavior.

getMaxWidth

public java.lang.String getMaxWidth()

Retrieves the maximum width that was set for this legend area on the graph. Valid values are percentages (e.g. 35%).

Returns:

the maximum width for this legend area on the graph.

setMaxWith

public void setMaxWith(java.lang.String maxWidth)

Specifies the maximum width for this legend area on the graph. Valid values are percentages (e.g. 35%).

Parameters:

maxWidth - the maximum width for this legend area on the graph.

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

getSpecialEffects

public SpecialEffects getSpecialEffects()

setSpecialEffects

public void setSpecialEffects(SpecialEffects sfx)

resetStyleProperties

protected void resetStyleProperties()

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase