oracle.dss.graph

Class BaseTickLabel

java.lang.Object

oracle.dss.dataView.BaseComponentXML

oracle.dss.graph.BaseGraphComponent

oracle.dss.graph.BaseText

oracle.dss.graph.BaseTickLabel

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, HorizontalAlignment

Direct Known Subclasses:

O1TickLabel, X1TickLabel, Y1TickLabel, Y2TickLabel

public abstract class BaseTickLabel
extends BaseText
implements HorizontalAlignment

Identifies a tick mark on an axis of the graph.

See Also:

TickLabelCallback

Field Summary

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_seriesDisplayInLegend, 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_left, MTP_LEFT, mtp_on_maxedge, MTP_ON_MAXEDGE, mtp_outside_max, MTP_OUTSIDE_MAX, mtp_right, MTP_RIGHT, 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_NONE, 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

Constructors

Constructor and Description
BaseTickLabel(CommonGraph graph)

Method Summary

Modifier and Type	Method and Description
int	getHorizontalAlignment() Retrieves the horizontal alignment for the text within the rectangle of the tick label.
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
boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
int	getTextRotation() Retrieves the rotation of the text for all of the tick labels of this axis in the graph.
boolean	isTextFittingAutomatic() Indicates whether all of the this axis tick labels are automatically moved and resized relative to the size of the graph.
abstract boolean	isTickLabelStaggered() Indicates whether all of the tick labels of this axis are staggered.
boolean	isVisible() Indicates whether the tick labels are visible.
void	resetStyle()
boolean	selectObject(int series, int group) Selects all tick labels of this axis in the graph.
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the tick label.
void	setNonstyleXML(oracle.dss.util.xml.ObjectNode node)
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
void	setTextFittingAutomatic(boolean yesNo) Specifies whether the tick labels are automatically moved and resized relative to the size of the graph.
void	setTextRotation(int orient) Specifies the rotation of the text for all of the tick labels of this axis in the graph.
abstract void	setTickLabelStaggered(boolean yesNo) Specifies whether all of the tick labels of this axis are staggered.
void	setVisible(boolean yesNo) Specifies whether the tick labels are visible.
void	setXML(oracle.dss.util.xml.ObjectNode node)

Methods inherited from class oracle.dss.graph.BaseText

_getGraphFont, getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute, 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

getComponentName, getStyleXML, getXML, setNonstyleXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTickLabel

@Concealed
public BaseTickLabel(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 does it automatically.

Method Detail

selectObject

public boolean selectObject(int series,
                            int group)

Selects all tick labels of this axis in the graph. Because tick labels do not represent data, the parameter values are irrelevant.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - Any integer.

group - Any integer.

Returns:

true if successful, false if not.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the text within the rectangle of the tick label. 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 graph layout ignores this property. The doAutoLayout method sets this property.

Specified by:

getHorizontalAlignment in interface HorizontalAlignment

Returns:

A SwingConstant value that represents the horizontal alignment for the text of this tick label.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the tick label. 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 graph layout ignores this property. The doAutoLayout method sets this property.

Specified by:

setHorizontalAlignment in interface HorizontalAlignment

Parameters:

a - A SwingConstant value that represents the horizontal alignment for the text of the tick label. Valid constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT.

getTextRotation

public int getTextRotation()

Retrieves the rotation of the text for all of the tick labels of this axis in the graph.

Automatic rotation respects this property.

Returns:

A constant that represents the rotation of the text for all of the axis tick labels in the graph. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)

setTextRotation

public void setTextRotation(int orient)

Specifies the rotation of the text for all of the tick labels of this axis in the graph.

Automatic rotation respects this property, but setting this property limits the strategies that automatic layout can use to display tick labels. If you specify rotation for tick labels, you eliminate several possibilities for better tick label layout.

Parameters:

orient - A constant that represents the rotation of the text for all of the tick labels of this axis in the graph. Valid constants are listed in the See Also section.
Note: Only these constants are accepted. And if you pass an invalid value, the graph logs a message with the registered error handler, and TextRotation retains its previous value.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)

isTickLabelStaggered

public abstract boolean isTickLabelStaggered()

Indicates whether all of the tick labels of this axis are staggered. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Returns:

true if they are staggered, false if they are aligned.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setTickLabelStaggered

public abstract void setTickLabelStaggered(boolean yesNo)

Specifies whether all of the tick labels of this axis are staggered. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Parameters:

yesNo - true to stagger the tick labels, false to align the tick labels.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

isTextFittingAutomatic

public boolean isTextFittingAutomatic()

Indicates whether all of the this axis tick labels are automatically moved and resized relative to the size of the graph. The return value of this method takes effect only when the FontSizeAbsolute property is set to false. Automatic graph layout ignores this property.

Returns:

true if they are automatically moved and resized, false if they are independent from the size of the graph.

See Also:

BaseText.isFontSizeAbsolute()

setTextFittingAutomatic

public void setTextFittingAutomatic(boolean yesNo)

Specifies whether the tick labels are automatically moved and resized relative to the size of the graph. For example, if the range of data on the axis is relatively small, and you do not have many tick labels, then the tick labels probably fit fine. If the range of data increases so that there are many more tick labels, then the tick labels might need to be smaller in order to remain legible. The tick label size might also need to change when a user resizes the plot area. Setting TextFittingAutomatic to true instructs the graph to resize the tick labels when appropriate.

In order for this method to take effect, the FontSizeAbsolute property must be set to false.

Automatic graph layout ignores this property.

Parameters:

yesNo - true to have the tick labels automatically resized, false prevent resizing.

See Also:

BaseText.isFontSizeAbsolute(), BaseText.setFontSizeAbsolute(boolean)

isVisible

public boolean isVisible()

Indicates whether the tick labels are visible.

Returns:

true if they are visible, false if they are invisible.

setVisible

public void setVisible(boolean yesNo)

Specifies whether the tick labels are visible.

Parameters:

yesNo - true to make them visible, false to make them invisible.

setXML

@Concealed
public void setXML(oracle.dss.util.xml.ObjectNode node)

Overrides:

setXML in class BaseComponentXML

For internal use only. Application developers should not use this

Sets XML on this component

getNonstyleXML

@Concealed
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

@Concealed
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 TickLabel object

setNonstyleXML

@Concealed
public void setNonstyleXML(oracle.dss.util.xml.ObjectNode node)

Overrides:

setNonstyleXML in class BaseText

For internal use only. Application developers should not use this

Sets Nonstyle properties of this TickLabel from XML

setStyleXML

@Concealed
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 TickLabel from XML

resetStyle

@Concealed
public void resetStyle()

Overrides:

resetStyle in class BaseText

For internal use only. Application developers should not use this