oracle.dss.graph
Class MarkerText

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.BaseGraphComponent
          oracle.dss.graph.BaseText
              oracle.dss.graph.MarkerText

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, ViewFormatCallback, BaseViewFormatCallback

public class MarkerText
extends BaseText
implements ViewFormatCallback

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

Field Summary

protected ViewFormat	m_viewFormatStockVolume
protected ViewFormat	m_viewFormatX1
protected ViewFormat	m_viewFormatY1
protected ViewFormat	m_viewFormatY2
protected ViewFormat	m_viewFormatZ
static java.lang.String	StockVolumeViewFormat_Name
protected static java.lang.String	ViewFormat_Name
static java.lang.String	X1ViewFormat_Name
static java.lang.String	Y1ViewFormat_Name
static java.lang.String	Y2ViewFormat_Name
static java.lang.String	ZViewFormat_Name

Fields inherited from class oracle.dss.graph.BaseText

m_font

Fields inherited from class oracle.dss.graph.BaseGraphComponent

a_assignedToY2, a_association, a_automaticRotation, a_axisAutoScaledFromZero, a_axisMaxAutoScaled, a_axisMaxValue, a_axisMinAutoScaled, a_axisMinValue, a_axisZoomMaxValue, a_axisZoomMinValue, a_backGround, a_borderStyle, a_borderTransparent, a_borderUsingDefaults, a_borderWidth, a_color, a_defaultAssignedToY2, a_defaultBorderColor, a_defaultBorderTransparent, a_defaultColor, a_defaultFirstMarkerColor, a_defaultFitlineType, a_defaultHighMarkerColor, a_defaultLastMarkerColor, a_defaultLineWidth, a_defaultLowMarkerColor, a_defaultMarkerColor, a_defaultMarkers, a_defaultMarkerShape, a_defaultMarkerType, a_displayedInLegend, a_effect, a_explicitEnd, a_explicitStart, a_fitlineType, a_focusFactor, a_group, a_height, a_high_value, a_horizontalAlignment, a_imageSource, a_isometricProjection, a_labelPosition, a_legendMarkersPerRow, a_legendOrientation, a_legendTextPosition, a_lightSourceX, a_lightSourceY, a_lightSourceZ, a_line_value, a_lineColor, a_lineIndex, a_lineStyle, a_lineWidth, a_location, a_logarithmicBase, a_low_value, a_majorIncrement, a_majorTickCount, a_majorTickStep, a_majorTickStepAutomatic, a_markerColor, a_markerShape, a_markerSize, a_markersPerRowAutomatic, a_markerTextAngleDefault, a_markerTextPlace, a_markerTextRadiusDefault, a_markerType, a_minorIncrement, a_minorTickCount, a_minorTickStep, a_minorTickStepType, a_mode, a_panX, a_panY, a_pieSliceExplode, a_quadrantLineCountX, a_quadrantLineCountY, a_quadrantLineValueX, a_quadrantLineValueY, a_rendered, a_rollover_behavior, a_scaledLogarithmic, a_series, a_shapePath, a_sharePanelProperties, a_shortDesc, a_sizeX, a_sizeY, a_sizeZ, a_skippedWithLabels, a_squareRisers, a_text, a_textFittingAutomatic, a_textRotation, a_textType, a_thresholdMaxValue, a_thresholdMinValue, a_tickLabelSkipCount, a_tickLabelSkipFirst, a_tickLabelSkipMode, a_tickLabelStaggered, a_tickLabelWrapped, a_tickStyle, a_translationX, a_translationY, a_translationZ, a_transparent, a_type, a_verticalAlignment, a_viewerX, a_viewerY, a_viewerZ, a_visibility, a_visible, a_wallThickX, a_wallThickY, a_wallThickZ, a_width, a_wordWrapEnabled, a_x, a_xValue, a_y, a_yValue, a_yValueAssignment, a_zoomFactor, al_both, AL_BOTH, al_left, AL_LEFT, al_right, AL_RIGHT, ap_always, AP_ALWAYS, ap_never, AP_NEVER, ar_horiz_rotate_270, AR_HORIZ_ROTATE_270, ar_horiz_rotate_90, AR_HORIZ_ROTATE_90, ar_no_rotate, AR_NO_ROTATE, CONV_MAP, dy2_auto_assign, DY2_AUTO_ASSIGN, dy2_false, DY2_FALSE, dy2_true, DY2_TRUE, FP_LG_CHECK, FP_LG_CROSSHATCH, FP_LG_DIAG_UP_LT, FP_LG_DIAG_UP_RT, FP_LG_DIAMOND_CHECK, FP_LG_TRIANGLE_CHECK, FP_MAX, FP_SM_CHECK, FP_SM_CROSSHATCH, FP_SM_DIAG_UP_LT, FP_SM_DIAG_UP_RT, FP_SM_DIAMOND_CHECK, FP_SM_TRIANGLE_CHECK, fs_bold, FS_BOLD, fs_bold_italic_underline, FS_BOLD_ITALIC_UNDERLINE, fs_bold_underline, FS_BOLD_UNDERLINE, fs_italic, FS_ITALIC, fs_italic_bold, FS_ITALIC_BOLD, fs_italic_underline, FS_ITALIC_UNDERLINE, fs_plain, FS_PLAIN, fs_underline, FS_UNDERLINE, ft_color, FT_COLOR, ft_exponential, FT_EXPONENTIAL, ft_gradient, FT_GRADIENT, ft_linear, FT_LINEAR, ft_logarithmic, FT_LOGARITHMIC, ft_none, FT_NONE, FT_PATTERN, ft_texture, FT_TEXTURE, gd_diagonal_135, GD_DIAGONAL_135, gd_diagonal_45, GD_DIAGONAL_45, gd_down, GD_DOWN, gd_down_left, GD_DOWN_LEFT, gd_down_right, GD_DOWN_RIGHT, gd_left, GD_LEFT, gd_radial, GD_RADIAL, gd_radial_bottom_left, GD_RADIAL_BOTTOM_LEFT, gd_radial_bottom_right, GD_RADIAL_BOTTOM_RIGHT, gd_radial_top_left, GD_RADIAL_TOP_LEFT, gd_radial_top_right, GD_RADIAL_TOP_RIGHT, gd_right, GD_RIGHT, gd_up, GD_UP, gd_up_left, GD_UP_LEFT, gd_up_right, GD_UP_RIGHT, gs_automatic, GS_AUTOMATIC, gs_extended, GS_EXTENDED, gs_grid, GS_GRID, gs_in, GS_IN, gs_none, GS_NONE, gs_out, GS_OUT, gs_span, GS_SPAN, lap_bottom, LAP_BOTTOM, lap_left, LAP_LEFT, lap_right, LAP_RIGHT, lap_top, LAP_TOP, ld_percent, LD_PERCENT, ld_text, LD_TEXT, ld_text_percent, LD_TEXT_PERCENT, ld_text_value, LD_TEXT_VALUE, ld_value, LD_VALUE, LEGENDMARKERSLIMIT, lo_automatic, LO_AUTOMATIC, lo_horizontal, LO_HORIZONTAL, lo_vertical, LO_VERTICAL, lp_inside, LP_INSIDE, lp_no_labels, LP_NO_LABELS, lp_outside_feeler_if_needed, LP_OUTSIDE_FEELER_IF_NEEDED, lp_outside_with_feeler, LP_OUTSIDE_WITH_FEELER, lp_outside_without_feeler, LP_OUTSIDE_WITHOUT_FEELER, ls_dash, LS_DASH, ls_dash_dot, LS_DASH_DOT, ls_dotted, LS_DOTTED, ls_solid, LS_SOLID, ltp_above, LTP_ABOVE, ltp_below, LTP_BELOW, ltp_on_left, LTP_ON_LEFT, ltp_on_marker, LTP_ON_MARKER, ltp_on_right, LTP_ON_RIGHT, m_commonGraph, m_identObj, m_pfj, ms_automatic, MS_AUTOMATIC, ms_circle, MS_CIRCLE, ms_diamond, MS_DIAMOND, ms_human, MS_HUMAN, ms_none, MS_NONE, ms_plus, MS_PLUS, ms_square, MS_SQUARE, ms_triangle_down, MS_TRIANGLE_DOWN, ms_triangle_up, MS_TRIANGLE_UP, mt_area, MT_AREA, mt_bar, MT_BAR, mt_centered_stepped_line, MT_CENTERED_STEPPED_LINE, MT_CURVE_AREA, mt_curve_line, MT_CURVE_LINE, mt_default, MT_DEFAULT, mt_line, MT_LINE, mt_marker, MT_MARKER, mt_stepped_line, MT_STEPPED_LINE, mtp_center, MTP_CENTER, mtp_custom, MTP_CUSTOM, mtp_inside_max, MTP_INSIDE_MAX, mtp_inside_min, MTP_INSIDE_MIN, mtp_on_maxedge, MTP_ON_MAXEDGE, mtp_outside_max, MTP_OUTSIDE_MAX, mtp_under_marker, MTP_UNDER_MARKER, QUADRANTLINEVALUELIMIT, REV_CONV_MAP, ro_area, RO_AREA, ro_back, RO_BACK, ro_front, RO_FRONT, ro_line, RO_LINE, SHAPE_AUTOMATIC, SHAPE_CIRCLE, SHAPE_DIAMOND, SHAPE_HUMAN, SHAPE_PLUS, SHAPE_SQUARE, SHAPE_TRIANGLE_DOWN, SHAPE_TRIANGLE_UP, sv_hidden, SV_HIDDEN, sv_visible, SV_VISIBLE, tdm_stretched, TDM_STRETCHED, tdm_tiled, TDM_TILED, tls_automatic, TLS_AUTOMATIC, tls_manual, TLS_MANUAL, tls_noskip, TLS_NOSKIP, tr_horiz, TR_HORIZ, tr_horiz_rotate_270, TR_HORIZ_ROTATE_270, tr_horiz_rotate_90, TR_HORIZ_ROTATE_90, tsm_explicit, TSM_EXPLICIT, tsm_off, TSM_OFF, va_bottom, va_center, va_top, VF_PIE_SLICE_LABEL, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Constructor Summary

MarkerText(CommonGraph graph)

Method Summary

static int	convertMarkerTextPlaceToInt(java.lang.String str)
protected java.lang.String	convertMarkerTextPlaceToString(int textPlace)
void	formatChanged(int attributeId, java.lang.String attributeName, java.lang.Object oldValue, java.lang.Object newValue)
protected java.lang.String	getComponentName()
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.
boolean	getNonstyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node) Retrieves Non style properties of this component to XML returns whether if the node exists
protected oracle.dss.util.xml.ObjectNode	getStockVolumeViewFormatXML(boolean allProperties)
boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
ViewFormat	getViewFormat(int value) Retrieves a ViewFormat object for this marker text.
protected oracle.dss.util.xml.ObjectNode	getX1ViewFormatXML(boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getY1ViewFormatXML(boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getY2ViewFormatXML(boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getZViewFormatXML(boolean allProperties)
boolean	isVisible() Indicates whether this marker text is visible.
protected void	resetStyle()
void	resetToDefault()
boolean	selectObject(int series, int group) This method is designed to select a component of the graph.
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	setNonstyleXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset)
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
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

_getGraphFont, getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute, setNonstyleXML, truncateText

Methods inherited from class oracle.dss.graph.BaseGraphComponent

convertAssociationToInt, convertFillPatternToString, convertGradientDirectionToString, convertHorizontalAlignmentToInt, convertHorizontalAlignmentToString, convertLineStyleToInt, convertLineStyleToString, convertLocationToInt, convertTextRotationtToInt, convertTickStyleToInt, convertTypeToInt, convertVerticalAlignmentToInt, convertVerticalAlignmentToString, hexStringToInt, toHexString

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getStyleXML, getXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ViewFormat_Name

protected static final java.lang.String ViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

X1ViewFormat_Name

public static final java.lang.String X1ViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Y1ViewFormat_Name

public static final java.lang.String Y1ViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Y2ViewFormat_Name

public static final java.lang.String Y2ViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ZViewFormat_Name

public static final java.lang.String ZViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

StockVolumeViewFormat_Name

public static final java.lang.String StockVolumeViewFormat_Name

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_viewFormatX1

protected ViewFormat m_viewFormatX1

For internal use only. Application developers should not use this

m_viewFormatY1

protected ViewFormat m_viewFormatY1

For internal use only. Application developers should not use this

m_viewFormatY2

protected ViewFormat m_viewFormatY2

For internal use only. Application developers should not use this

m_viewFormatZ

protected ViewFormat m_viewFormatZ

For internal use only. Application developers should not use this

m_viewFormatStockVolume

protected ViewFormat m_viewFormatStockVolume

For internal use only. Application developers should not use this

Constructor Detail

MarkerText

public MarkerText(CommonGraph graph)

Parameters:

graph - The graph that this object belongs to.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph automatically does it.

Method Detail

resetToDefault

public void resetToDefault()

For internal use only. Application developers should not use this

Resets all of the number formatting properties to their default values. This method resets the properties in the ViewFormat that specifies number formatting for the marker text in the graph.

selectObject

public boolean selectObject(int series,
                            int group)

Description copied from class: BaseGraphComponent

This method is designed to select a component of the graph. However, this particular implementation does nothing but return false. A subclass of this class must override this method in order to be selected.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - The series of the marker text that you want to select.

group - The group of the marker text that you want to select.

Returns:

true if successful, false if not.

For internal use only. Application developers should not use this

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_UNDER_MARKER, 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_UNDER_MARKER, 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

formatChanged

public void formatChanged(int attributeId,
                          java.lang.String attributeName,
                          java.lang.Object oldValue,
                          java.lang.Object newValue)

Specified by:

formatChanged in interface BaseViewFormatCallback

Parameters:

attributeId - the static constant in ViewFormat that identifies the attribute

attributeName - the name of the attribute that changed

oldValue - the old value of the attribute

newValue - the new value of the attribute

For internal use only. Application developers should not use this

Notification that one or more attributes on the ViewFormat have changed.

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.

convertMarkerTextPlaceToString

protected java.lang.String convertMarkerTextPlaceToString(int textPlace)

For internal use only. Application developers should not use this

convert style int constants to string constants

convertMarkerTextPlaceToInt

public static int convertMarkerTextPlaceToInt(java.lang.String str)

For internal use only. Application developers should not use this

convert style string constants to int constants

getX1ViewFormatXML

protected oracle.dss.util.xml.ObjectNode getX1ViewFormatXML(boolean allProperties)

For internal use only. Application developers should not use this

getY1ViewFormatXML

protected oracle.dss.util.xml.ObjectNode getY1ViewFormatXML(boolean allProperties)

For internal use only. Application developers should not use this

getZViewFormatXML

protected oracle.dss.util.xml.ObjectNode getZViewFormatXML(boolean allProperties)

For internal use only. Application developers should not use this

getY2ViewFormatXML

protected oracle.dss.util.xml.ObjectNode getY2ViewFormatXML(boolean allProperties)

For internal use only. Application developers should not use this

getStockVolumeViewFormatXML

protected oracle.dss.util.xml.ObjectNode getStockVolumeViewFormatXML(boolean allProperties)

For internal use only. Application developers should not use this

getComponentName

protected java.lang.String getComponentName()

Overrides:

getComponentName in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves the name of the object.

getNonstyleXML

public boolean getNonstyleXML(boolean allProperties,
                              oracle.dss.util.xml.ObjectNode node)

Description copied from class: BaseComponentXML

Retrieves Non style properties of this component to XML returns whether if the node exists

Overrides:

getNonstyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves Non style properties of this component to XML returns whether if the node exists

getStyleXML

public boolean getStyleXML(boolean allProperties,
                           oracle.dss.util.xml.ObjectNode node)

Overrides:

getStyleXML in class BaseText

For internal use only. Application developers should not use this

Retrieves Style XML from this component returns whether if the node exists

setNonstyleXML

public void setNonstyleXML(oracle.dss.util.xml.ObjectNode node,
                           java.lang.String version,
                           int reset)

Overrides:

setNonstyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Sets Nonstyle properties of this MarkerText from XML

setStyleXML

public void setStyleXML(oracle.dss.util.xml.ObjectNode node)

Overrides:

setStyleXML in class BaseText

For internal use only. Application developers should not use this

Sets Style properties of this MarkerText from XML

resetStyle

protected void resetStyle()

Overrides:

resetStyle in class BaseText

For internal use only. Application developers should not use this

reset style properties