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

Class MarkerText

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class MarkerText
extends BaseTextComponent

Defines properties for the marker text.

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	m_defaultFontColor
protected int	m_defaultFontSize
protected int	m_defaultFontStyle
protected java.lang.String	m_defaultFontTypeface
protected int	m_defaultMarkerTextPlace
protected boolean	m_defaultRendered
static org.apache.myfaces.trinidad.bean.PropertyKey	MARKER_TEXT_PLACE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STOCK_VOLUME_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STOCK_VOLUME_NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	X1_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	X1_NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Y1_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Y1_NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Y2_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Y2_NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Z_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	Z_NUMBER_FORMAT_KEY

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

Method Summary

Methods

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	getMarkerTextPlace() Retrieves the placement for this marker text.
BaseFormat	getStockVolumeFormat() Retrieves the base format for x1 axis
NumberFormat	getStockVolumeNumberFormat() Deprecated. Use getStockVolumeFormat().getNumberFormat()
BaseFormat	getX1Format() Retrieves the base format for x1 axis
NumberFormat	getX1NumberFormat() Deprecated. Use getX1Format().getNumberFormat()
BaseFormat	getY1Format() Retrieves the base format for x1 axis
NumberFormat	getY1NumberFormat() Deprecated. Use getY1Format().getNumberFormat()
BaseFormat	getY2Format() Retrieves the base format for x1 axis
NumberFormat	getY2NumberFormat() Deprecated. Use getY2Format().getNumberFormat()
BaseFormat	getZFormat() Retrieves the base format for x1 axis
NumberFormat	getZNumberFormat() Deprecated. Use getZFormat().getNumberFormat()
boolean	isRendered() Indicates whether this marker text is rendered.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setMarkerTextPlace(int place) Specifies the placement for this marker text.
void	setMarkerTextPlace(java.lang.String place) Specifies the placement for this marker text.
void	setRendered(boolean rendered) Specifies whether this marker text is rendered.
void	setStockVolumeFormat(BaseFormat baseFormat) Specifies the base format for x1 axis
void	setStockVolumeNumberFormat(NumberFormat format) Deprecated. Use getStockVolumeFormat().setNumberFormat()
void	setX1Format(BaseFormat baseFormat) Specifies the base format for x1 axis
void	setX1NumberFormat(NumberFormat format) Deprecated. Use getX1Format().setNumberFormat()
void	setY1Format(BaseFormat baseFormat) Specifies the base format for x1 axis
void	setY1NumberFormat(NumberFormat format) Deprecated. Use getY1Format().setNumberFormat()
void	setY2Format(BaseFormat baseFormat) Specifies the base format for x1 axis
void	setY2NumberFormat(NumberFormat format) Deprecated. Use getY2Format().setNumberFormat()
void	setZFormat(BaseFormat baseFormat) Specifies the base format for x1 axis
void	setZNumberFormat(NumberFormat format) Deprecated. Use getZFormat().setNumberFormat()

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_defaultMarkerTextPlace

protected int m_defaultMarkerTextPlace

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

MARKER_TEXT_PLACE_KEY

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

RENDERED_KEY

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

X1_NUMBER_FORMAT_KEY

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

Y1_NUMBER_FORMAT_KEY

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

Y2_NUMBER_FORMAT_KEY

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

Z_NUMBER_FORMAT_KEY

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

STOCK_VOLUME_NUMBER_FORMAT_KEY

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

X1_FORMAT_KEY

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

Y1_FORMAT_KEY

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

Y2_FORMAT_KEY

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

Z_FORMAT_KEY

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

STOCK_VOLUME_FORMAT_KEY

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

Constructor Detail

MarkerText

public MarkerText()

Method Detail

getMarkerTextPlace

public int getMarkerTextPlace()

Retrieves the placement for this marker text. The placement is relative to the marker that this marker text belongs to.

Returns:

A constant that represents the placement for this marker text. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.MTP_OUTSIDE_MAX, BaseGraphComponent.MTP_ON_MAXEDGE, BaseGraphComponent.MTP_INSIDE_MAX, BaseGraphComponent.MTP_INSIDE_MIN, BaseGraphComponent.MTP_CENTER, BaseGraphComponent.MTP_LEFT, BaseGraphComponent.MTP_RIGHT, BaseGraphComponent.MTP_CUSTOM

setMarkerTextPlace

public void setMarkerTextPlace(int place)

Specifies the placement for this marker text. The placement is relative to the marker that this marker text belongs to.

Parameters:

place - A constant that represents the placement for this marker text. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.MTP_OUTSIDE_MAX, BaseGraphComponent.MTP_ON_MAXEDGE, BaseGraphComponent.MTP_INSIDE_MAX, BaseGraphComponent.MTP_INSIDE_MIN, BaseGraphComponent.MTP_CENTER, BaseGraphComponent.MTP_LEFT, BaseGraphComponent.MTP_RIGHT, BaseGraphComponent.MTP_CUSTOM

setMarkerTextPlace

public void setMarkerTextPlace(java.lang.String place)

Specifies the placement for this marker text. The placement is relative to the marker that this marker text belongs to.

Parameters:

place - A constant that represents the placement for this marker text.

• MTP_CENTER - For bar graph, text appears centered on the bar. For non-bar graphs, text appears above the data point if the value is positive and below the data point if the value is negative.
• MTP_INSIDE_MAX - For bar graph, text appears on the bar, near the top. For non-bar graphs, text appears below the data point if the value is positive and above the data point if the value is negative.
• MTP_INSIDE_MIN - For bar graph, text appears inside on the bar, near the bottom. For non-bar graphs, text appears above the data point if the value is positive and below the data point if the value is negative.
• MTP_OUTSIDE_MAX - (Default) For bar graph, text appears above the bar. For non-bar graphs, text appears above the data point if the value is positive and below the data point if the value is negative.
• MTP_ON_MAX_EDGE - For bar graph, text sits on the bar. For non-bar graphs, text sits at the data point.
• MTP_LEFT - For scatter and bubble graphs, text appears on the left side of the marker.
• MTP_RIGHT - For scatter and bubble graphs, text appears on the right side of the marker.

isRendered

public boolean isRendered()

Indicates whether this marker text is rendered.

Returns:

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

setRendered

public void setRendered(boolean rendered)

Specifies whether this marker text is rendered.

Parameters:

yesNo - true to make this marker text rendered, false to make it not rendered.

applyProperties

public void applyProperties(java.util.HashMap map)

Description copied from class: BIComplexAttributeBase

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

getX1NumberFormat

@Deprecated
public NumberFormat getX1NumberFormat()

Deprecated. Use getX1Format().getNumberFormat()

Deprecated.

setX1NumberFormat

public void setX1NumberFormat(NumberFormat format)

Deprecated. Use getX1Format().setNumberFormat()

Deprecated.

getY1NumberFormat

@Deprecated
public NumberFormat getY1NumberFormat()

Deprecated. Use getY1Format().getNumberFormat()

Deprecated.

setY1NumberFormat

@Deprecated
public void setY1NumberFormat(NumberFormat format)

Deprecated. Use getY1Format().setNumberFormat()

Deprecated.

getY2NumberFormat

@Deprecated
public NumberFormat getY2NumberFormat()

Deprecated. Use getY2Format().getNumberFormat()

Deprecated.

setY2NumberFormat

public void setY2NumberFormat(NumberFormat format)

Deprecated. Use getY2Format().setNumberFormat()

Deprecated.

getZNumberFormat

@Deprecated
public NumberFormat getZNumberFormat()

Deprecated. Use getZFormat().getNumberFormat()

Deprecated.

setZNumberFormat

@Deprecated
public void setZNumberFormat(NumberFormat format)

Deprecated. Use getZFormat().setNumberFormat()

Deprecated.

getStockVolumeNumberFormat

@Deprecated
public NumberFormat getStockVolumeNumberFormat()

Deprecated. Use getStockVolumeFormat().getNumberFormat()

Deprecated.

setStockVolumeNumberFormat

@Deprecated
public void setStockVolumeNumberFormat(NumberFormat format)

Deprecated. Use getStockVolumeFormat().setNumberFormat()

Deprecated.

getX1Format

public BaseFormat getX1Format()

Retrieves the base format for x1 axis

Returns:

the base format

setX1Format

public void setX1Format(BaseFormat baseFormat)

Specifies the base format for x1 axis

Parameters:

baseFormat - the base format

getY1Format

public BaseFormat getY1Format()

Retrieves the base format for x1 axis

Returns:

the base format

setY1Format

public void setY1Format(BaseFormat baseFormat)

Specifies the base format for x1 axis

Parameters:

baseFormat - the base format

getY2Format

public BaseFormat getY2Format()

Retrieves the base format for x1 axis

Returns:

the base format

setY2Format

public void setY2Format(BaseFormat baseFormat)

Specifies the base format for x1 axis

Parameters:

baseFormat - the base format

getZFormat

public BaseFormat getZFormat()

Retrieves the base format for x1 axis

Returns:

the base format

setZFormat

public void setZFormat(BaseFormat baseFormat)

Specifies the base format for x1 axis

Parameters:

baseFormat - the base format

getStockVolumeFormat

public BaseFormat getStockVolumeFormat()

Retrieves the base format for x1 axis

Returns:

the base format

setStockVolumeFormat

public void setStockVolumeFormat(BaseFormat baseFormat)

Specifies the base format for x1 axis

Parameters:

baseFormat - the base format

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase