oracle.dss.graph
Class MarkerText

oracle.dss.graph.BaseGraphComponent
  |
  +--oracle.dss.graph.BaseText
        |
        +--oracle.dss.graph.MarkerText

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute

public class MarkerText

extends BaseText

Describes the marker in the plot area of all graphs except for pie, pie-bar, ring, and ring-bar.

Fields inherited from class oracle.dss.graph.BaseGraphComponent

AL_BOTH, AL_LEFT, AL_RIGHT, AP_ALWAYS, AP_NEVER, AR_HORIZ_ROTATE_270, AR_HORIZ_ROTATE_90, AR_NO_ROTATE, DY2_AUTO_ASSIGN, DY2_FALSE, DY2_TRUE, FS_BOLD, FS_BOLD_ITALIC_UNDERLINE, FS_BOLD_UNDERLINE, FS_ITALIC, FS_ITALIC_BOLD, FS_ITALIC_UNDERLINE, FS_PLAIN, FS_UNDERLINE, FT_COLOR, FT_EXPONENTIAL, FT_GRADIENT, FT_LINEAR, FT_LOGARITHMIC, FT_NONE, FT_TEXTURE, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_DOWN_LEFT, GD_DOWN_RIGHT, GD_LEFT, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, GD_UP, GD_UP_LEFT, GD_UP_RIGHT, GS_EXTENDED, GS_GRID, GS_IN, GS_OUT, GS_SPAN, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, LD_PERCENT, LD_TEXT, LD_TEXT_PERCENT, LD_VALUE, LEGENDMARKERSLIMIT, LO_AUTOMATIC, LO_HORIZONTAL, LO_VERTICAL, LP_INSIDE, LP_NO_LABELS, LP_OUTSIDE_WITH_FEELER, LP_OUTSIDE_WITHOUT_FEELER, LTP_ABOVE, LTP_BELOW, LTP_ON_LEFT, LTP_ON_MARKER, LTP_ON_RIGHT, MS_AUTOMATIC, MS_CIRCLE, MS_DIAMOND, MS_NONE, MS_PLUS, MS_SQUARE, MS_TRIANGLE_DOWN, MS_TRIANGLE_UP, MT_AREA, MT_BAR, MT_DEFAULT, MT_MARKER, MTP_CENTER, MTP_CUSTOM, MTP_INSIDE_MAX, MTP_INSIDE_MIN, MTP_ON_MAXEDGE, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, TDM_STRETCHED, TDM_TILED, TLS_AUTOMATIC, TLS_MANUAL, TLS_NOSKIP, TR_HORIZ, TR_HORIZ_ROTATE_270, TR_HORIZ_ROTATE_90, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Method Summary

int	getMarkerTextAngleDefault() Retrieves the angle for this marker text.
int	getMarkerTextPlace() Retrieves the placement for this marker text.
int	getMarkerTextRadiusDefault() Retrieves the distance from this marker text to the top center of the marker that it belongs to.
ViewFormat	getViewFormat(int value) Retrieves a ViewFormat object for this marker text.
boolean	isVisible() Indicates whether this marker text is visible.
void	setMarkerTextAngleDefault(int angle) Specifies the angle of this marker text.
void	setMarkerTextPlace(int place) Specifies the placement for this marker text.
void	setMarkerTextRadiusDefault(int dist) Specifies the distance from this marker text to the top center of the marker that it belongs to.
void	setViewFormat(ViewFormat viewFormat, int value) Specifies a ViewFormat object for this marker text.
void	setVisible(boolean yesNo) Specifies whether this marker text is visible.

Methods inherited from class oracle.dss.graph.BaseText

getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute

Methods inherited from class oracle.dss.graph.BaseGraphComponent

selectObject

Method Detail

getMarkerTextAngleDefault

public int getMarkerTextAngleDefault()

Retrieves the angle for this marker text. This angle is measured from the top center of the marker that this marker text belongs to. The values for an angle range from 0 degrees to 360 degrees.

For this property to take effect, the MarkerTextPlace property must be set to BaseGraphComponent.MTP_CUSTOM.

Returns:

The angle for this marker text.

See Also:

setMarkerTextPlace(int)

setMarkerTextAngleDefault

public void setMarkerTextAngleDefault(int angle)

Specifies the angle of this marker text. This angle is measured from the top center of the marker that it belongs to. The values for an angle range from 0 degrees to 360 degrees.

For this property to take effect, the MarkerTextPlace property must be set to BaseGraphComponent.MTP_CUSTOM.

Parameters:

angle - The angle of this marker text.

See Also:

setMarkerTextPlace(int)

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_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_CUSTOM

getMarkerTextRadiusDefault

public int getMarkerTextRadiusDefault()

Retrieves the distance from this marker text to the top center of the marker that it belongs to. The values for distance can range from 0 to 100.

For this property to take effect, the MarkerTextPlace property must be set to BaseGraphComponent.MTP_CUSTOM.

Returns:

The distance from this marker text to the top center of the marker that it belongs to.

See Also:

setMarkerTextPlace(int)

setMarkerTextRadiusDefault

public void setMarkerTextRadiusDefault(int dist)

Specifies the distance from this marker text to the top center of the marker that it belongs to. The values for distance can range from 0 to 100.

For this property to take effect, the MarkerTextPlace property must be set to BaseGraphComponent.MTP_CUSTOM.

Parameters:

dist - The distance from this marker text to the top center of the marker that it belongs to.

See Also:

setMarkerTextPlace(int)

getViewFormat

public ViewFormat getViewFormat(int value)

Retrieves a ViewFormat object for this marker text. The ViewFormat objects allow you to format numbers.

Parameters:

value - A constant that represents the axis or stock volume location for which you want a ViewFormat for this marker text. Valid constants are listed in the See Also section.

Returns:

A ViewFormat object for this marker text.

See Also:

BaseGraphComponent.VF_STOCK_VOLUME, BaseGraphComponent.VF_X1, BaseGraphComponent.VF_Y1, BaseGraphComponent.VF_Y2, BaseGraphComponent.VF_Z

setViewFormat

public void setViewFormat(ViewFormat viewFormat,
                          int value)

Specifies a ViewFormat object for this marker text. The ViewFormat objects allow you to format numbers.

Parameters:

A - ViewFormat object for this marker text.

value - A constant that represents the axis or stock volume location for which you want a ViewFormat. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.VF_STOCK_VOLUME, BaseGraphComponent.VF_X1, BaseGraphComponent.VF_Y1, BaseGraphComponent.VF_Y2, BaseGraphComponent.VF_Z

isVisible

public boolean isVisible()

Indicates whether this marker text is visible.

Returns:

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

setVisible

public void setVisible(boolean yesNo)

Specifies whether this marker text is visible.

Parameters:

yesNo - true to make this marker text visible, false to make it invisible.