oracle.dss.graph
Class SliceLabel

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

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, Formattable, ViewFormatCallback, Visible, BaseViewFormatCallback

public class SliceLabel
extends BaseText
implements Visible, FontAttribute, Formattable, ViewFormatCallback, DataviewFontAttribute

Describes a slice of a pie in a pie or ring graph. Each slice represents a data value.

Field Summary

protected ViewFormat

m_viewFormat

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_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_majorTickStep, a_majorTickStepAutomatic, a_markerColor, a_markerShape, a_markerSize, a_markersPerRowAutomatic, a_markerTextAngleDefault, a_markerTextPlace, a_markerTextRadiusDefault, a_markerType, a_minorIncrement, 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_sharePanelProperties, 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, 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_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, ro_area, RO_AREA, ro_back, RO_BACK, ro_front, RO_FRONT, ro_line, RO_LINE, 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

SliceLabel(CommonGraph graph)

Method Summary

static int	convertTextTypeToInt(java.lang.String string)
void	formatChanged(int attributeId, java.lang.String attributeName, java.lang.Object oldValue, java.lang.Object newValue)
protected java.lang.String	getComponentName()
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 for the rectangle of this label.
int	getTextType() Retrieves a text type for this label.
ViewFormat	getViewFormat() Retrieves a ViewFormat object for this label.
boolean	isVisible() Indicates whether slice labels appear in the graph.
protected void	resetStyle()
void	resetToDefault()
boolean	selectObject(int series, int group) Selects the label for an individual slice.
void	setNonstyleXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset)
protected void	setObjectId(oracle.dss.graph.pfj.draw.IdentObj id)
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
void	setTextRotation(int rotate) Specifies the rotation of rectangle of this label.
void	setTextType(int i) Specifies a text type of this label.
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for this label.
void	setVisible(boolean yesNo) Specifies whether slice labels appear in the graph.

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

Methods inherited from interface oracle.dss.dataView.FontAttribute

getFont, setFont

Methods inherited from interface oracle.dss.dataView.DataviewFontAttribute

getDataviewFont

Field Detail

m_viewFormat

protected ViewFormat m_viewFormat

For internal use only. Application developers should not use this

Constructor Detail

SliceLabel

public SliceLabel(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 slice labels in the graph.

selectObject

public boolean selectObject(int series,
                            int group)

Selects the label for an individual slice.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - The series of the slice label that you want to select.

group - The group of the slice label that you want to select.

Returns:

true if successful, false if not.

getTextType

public int getTextType()

Retrieves a text type for this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Returns:

A constant that represents a text type for this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT, BaseGraphComponent.LD_TEXT_VALUE

setTextType

public void setTextType(int i)

Specifies a text type of this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Parameters:

i - A constant that represents a text type of this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT, BaseGraphComponent.LD_TEXT_VALUE

getTextRotation

public int getTextRotation()

Retrieves the rotation for the rectangle of this label. The constants are listed in the See Also section.

Returns:

A constant that represents the rotation for the rectangle of this label.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270

setTextRotation

public void setTextRotation(int rotate)

Specifies the rotation of rectangle of this label.

Parameters:

rotate - A constant that represents the rotation of the rectangle of this label.
Note 1: For funnel graph, the text rotation can be 0-360 degress.
Note 2: For pie graph, only the constants in see also section 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

getViewFormat

public ViewFormat getViewFormat()

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

Specified by:

getViewFormat in interface Formattable

Returns:

A ViewFormat object for this label.

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

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

Specified by:

setViewFormat in interface Formattable

Parameters:

viewFormat - A ViewFormat object for this label.

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 slice labels appear in the graph.

Specified by:

isVisible in interface Visible

Returns:

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

setVisible

public void setVisible(boolean yesNo)

Specifies whether slice labels appear in the graph.

Specified by:

setVisible in interface Visible

Parameters:

yesNo - true to display slice labels, false to hide them.

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.

setObjectId

protected void setObjectId(oracle.dss.graph.pfj.draw.IdentObj id)

For internal use only. Application developers should not use this

Sets the object id that corresponds to the current component being used.

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 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 SliceLabel 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 SliceLabel from XML

convertTextTypeToInt

public static int convertTextTypeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts text type String constants to Integer constants. This is used by get/setXML().

resetStyle

protected void resetStyle()

Overrides:

resetStyle in class BaseText

For internal use only. Application developers should not use this

reset style properties