oracle.dss.graph

Class ZTickLabel

java.lang.Object

oracle.dss.dataView.BaseComponentXML

oracle.dss.graph.BaseGraphComponent

oracle.dss.graph.BaseText

oracle.dss.graph.ZTickLabel

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, HorizontalAlignment

public class ZTickLabel
extends BaseText
implements HorizontalAlignment

Identifies a tick mark on the Z-axis of a 3-D graph.

Field Summary

Fields

Modifier and Type	Field and Description
protected oracle.dss.graph.pfj.draw.IdentObj	m_identObj2

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
ZTickLabel(CommonGraph graph)

Method Summary

Modifier and Type	Method and Description
protected int	convertTickLabelSkipModeToInt(java.lang.String string)
protected java.lang.String	convertTickLabelSkipModeToString(int value)
protected java.lang.String	getComponentName()
int	getHorizontalAlignment() Retrieves the horizontal alignment for the text within the rectangle of the tick label.
boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
int	getTextRotation() Retrieves the rotation for the rectangle for all of the Z-axis tick labels.
int	getTickLabelSkipCount() Retrieves the number of Z-axis tick labels that the graph hides between each one that is displayed.
int	getTickLabelSkipFirst() Retrieves the index of the first Z-axis tick label that is skipped.
int	getTickLabelSkipMode() Retrieves the type of skipping that is used for the Z-axis tick labels.
void	resetStyle()
boolean	selectObject(int series, int group) Selects all of the Z-axis tick labels in the graph.
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the tick label.This property is also tied to the ZDrillLable
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
void	setTextRotation(int orient) Specifies the rotation for the rectangle for all of the Z-axis tick labels.
void	setTickLabelSkipCount(int count) Specifies the number of Z-axis tick labels that the graph hides between each one that is displayed.
void	setTickLabelSkipFirst(int first) Specifies the index of the first Z-axis tick label that is skipped.
void	setTickLabelSkipMode(int mode) Specifies the type of skipping that is used for the Z-axis tick labels.

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

getNonstyleXML, getStyleXML, getXML, setNonstyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Field Detail

m_identObj2

@Concealed
protected oracle.dss.graph.pfj.draw.IdentObj m_identObj2

For internal use only. Application developers should not use this

Constructor Detail

ZTickLabel

@Concealed
public ZTickLabel(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 of the Z-axis tick labels in the graph. Because Z-axis tick labels are series components, the group parameter is irrelevant.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - The series in the graph that these tick labels belong to.

group - Any integer.

Returns:

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

getTextRotation

public int getTextRotation()

Retrieves the rotation for the rectangle for all of the Z-axis tick labels.

Returns:

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

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270

setTextRotation

public void setTextRotation(int orient)

Specifies the rotation for the rectangle for all of the Z-axis tick labels.

Parameters:

orient - A constant that represents the rotation for the rectangle for all of the Z-axis tick labels. 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

getTickLabelSkipCount

public int getTickLabelSkipCount()

Retrieves the number of Z-axis tick labels that the graph hides between each one that is displayed.

Returns:

The number of Z-axis tick labels that the graph hides between each one that is displayed.

setTickLabelSkipCount

public void setTickLabelSkipCount(int count)

Specifies the number of Z-axis tick labels that the graph hides between each one that is displayed. If the count is less than 0, an error is logged with the error handler and the property value is not changed.

Parameters:

count - The number of Z-axis tick labels for the graph to hide between each one that is displayed.

getTickLabelSkipFirst

public int getTickLabelSkipFirst()

Retrieves the index of the first Z-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis.

Returns:

The index of the first ZTickLabel that is skipped.

setTickLabelSkipFirst

public void setTickLabelSkipFirst(int first)

Specifies the index of the first Z-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis. If the index is less than 0, an error is logged with the error handler and the property value is not changed.

Parameters:

first - The index of the first Z-axis tick label that is skipped.

getTickLabelSkipMode

public int getTickLabelSkipMode()

Retrieves the type of skipping that is used for the Z-axis tick labels.

Returns:

A constant that represents the type of skipping that is used for the Z-axis tick labels. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP

setTickLabelSkipMode

public void setTickLabelSkipMode(int mode)

Specifies the type of skipping that is used for the Z-axis tick labels.

Parameters:

mode - A constant that represents the type of skipping that is used for the Z-axis tick labels. Valid constants are listed in the See Also section. If you enter an invalid value, then the graph logs a message with the ErrorHandler, and the TickLabelSkipMode property value does not change.

See Also:

BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the tick label.This property is also tied to the ZDrillLable

This method has no effect on axis titles in a 3-D graph.

Specified by:

setHorizontalAlignment in interface HorizontalAlignment

Parameters:

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

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for 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.

Specified by:

getHorizontalAlignment in interface HorizontalAlignment

Returns:

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

convertTickLabelSkipModeToString

@Concealed
protected java.lang.String convertTickLabelSkipModeToString(int value)

For internal use only. Application developers should not use this

Converts Tick Label Skip Mode Integer constants to String constants. This is used by get/setXML().

convertTickLabelSkipModeToInt

@Concealed
protected int convertTickLabelSkipModeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts Tick Label Skip Mode String constants to Integer constants. This is used by get/setXML().

getComponentName

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

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

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 XML on this TickLabel object

resetStyle

@Concealed
public void resetStyle()

Overrides:

resetStyle in class BaseText

For internal use only. Application developers should not use this