Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

oracle.dss.graph
Class ReferenceObject

java.lang.Object
  extended by oracle.dss.dataView.BaseComponentXML
      extended by oracle.dss.graph.BaseGraphComponent
          extended by oracle.dss.graph.ReferenceObject

public class ReferenceObject
extends BaseGraphComponent

The class for reference objects of Data axes and Series. The objects could be a reference lines and/or a reference areas. One can define unlimited number of reference objects (lines or areas) for a given axis and/or a given series. The reference objects will be of constant value in release R11. In the future, lines could be based on different data values associated with different periods of time, and be of any supported type, such as stepped or smooth.


Field Summary
static boolean d_referenceLineDisplayedInLegend
           
static int d_referenceLineStyle
           
static double d_referenceLineValue
           
static boolean d_referenceLineVisible
           
static int d_referenceLineWidth
           
protected  int m_display
           
protected  java.lang.String m_elementName
           
protected  boolean[] m_legend
           
protected  SFX m_sfx
           
protected  java.lang.Object m_value
           
 
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_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_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
ReferenceObject(CommonGraph graph)
           
 
Method Summary
 int getAssociation()
          Retrieves a constant that identifies the component this reference object is associated with.
 java.awt.Color getColor()
          Retrieves the color of the reference object.
protected  java.lang.String getComponentName()
           
 java.lang.Object getHighValue()
          Retrieves the high value of the reference Area.
 int getID()
          Retrieves the ID of this ReferenceObject.
 int getLineStyle()
          Retrieves the style of the line.
 java.lang.Object getLineValue()
          Retrieves the value at which the reference line is displayed.
 int getLineWidth()
          Retrieves the width of the reference line in pixels.
 int getLocation()
          Returns the location of the reference object.
 java.lang.Object getLowValue()
          Retrieves the low value of the reference Area.
 int getSeries()
          Retrieves the series this reference object is associated with.
 SFX getSFX()
          Retrieves the SFX object for this exceptional riser.
 java.lang.String getShortDesc()
          Retrieves the short description for the reference object.
 java.lang.String getText()
          Retrieves the text for the reference object.
 int getType()
          Returns the type of the reference object.
protected  oracle.dss.util.xml.ObjectNode getXML(boolean allProperties, boolean allOverriddenProperties)
           
 boolean isDisplayedInLegend()
          Indicates whether the reference object appears in the legend.
 boolean selectObject(int series, int group)
          Selects the reference line on the graph.
 void setAssociation(int component)
          Specifies a constant that represents the component this reference object is associated with.
 void setColor(java.awt.Color newColor)
          Specifies the color of the reference object.
 void setDisplayedInLegend(boolean visible)
          Specifies whether to display the reference object in the legend.
 void setHighValue(java.lang.Object value)
          Specifies the high value of the reference area.
 void setLineStyle(int style)
          Specifies the style of the line.
 void setLineValue(java.lang.Object value)
          Specifies the value at which the reference line is displayed.
 void setLineWidth(int width)
          Specifies the width of the reference line in pixels.
 void setLocation(int location)
          Specifies the location of the reference object.
 void setLowValue(java.lang.Object value)
          Specifies the low value of the reference area.
protected  void setReferenceLineXML(oracle.dss.util.xml.ObjectNode referenceNode)
           
 void setSeries(int series)
          Specifies the series this reference object is associated with.
 void setShortDesc(java.lang.String shortDesc)
          Specifies the short description for the reference object.
 void setText(java.lang.String str)
          Specifies the text of the reference object.
 void setType(int type)
          Specifies the type of the reference object.
 void setXML(oracle.dss.util.xml.ObjectNode referenceNode)
           
 void setXML(oracle.dss.util.xml.ObjectNode referenceNode, java.util.HashMap map)
           
 
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, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_sfx

protected SFX m_sfx
For internal use only. Application developers should not use this

m_value

protected java.lang.Object m_value
For internal use only. Application developers should not use this

m_display

protected int m_display
For internal use only. Application developers should not use this

m_elementName

protected java.lang.String m_elementName
For internal use only. Application developers should not use this

m_legend

protected boolean[] m_legend
For internal use only. Application developers should not use this

d_referenceLineVisible

public static final boolean d_referenceLineVisible
See Also:
Constant Field Values
For internal use only. Application developers should not use this

d_referenceLineWidth

public static final int d_referenceLineWidth
See Also:
Constant Field Values
For internal use only. Application developers should not use this

d_referenceLineStyle

public static final int d_referenceLineStyle
See Also:
Constant Field Values
For internal use only. Application developers should not use this

d_referenceLineValue

public static final double d_referenceLineValue
See Also:
Constant Field Values
For internal use only. Application developers should not use this

d_referenceLineDisplayedInLegend

public static final boolean d_referenceLineDisplayedInLegend
See Also:
Constant Field Values
For internal use only. Application developers should not use this
Constructor Detail

ReferenceObject

public ReferenceObject(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 the reference line on the graph. Because references lines 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.

getType

public int getType()
Returns the type of the reference object.

Returns:
Constant that identifies the type of the reference object Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.RO_LINE, BaseGraphComponent.RO_AREA

setType

public void setType(int type)
Specifies the type of the reference object.

Parameters:
type - Constant that identifies the type of the reference object. By default object is of type reference line Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.RO_LINE, BaseGraphComponent.RO_AREA

getLocation

public int getLocation()
Returns the location of the reference object.

Returns:
Constant that identifies the location of the reference object Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.RO_FRONT, BaseGraphComponent.RO_BACK

setLocation

public void setLocation(int location)
Specifies the location of the reference object.

Parameters:
type - Constant that identifies the location of the reference object. By default object is located at the back Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.RO_FRONT, BaseGraphComponent.RO_BACK

getAssociation

public int getAssociation()
Retrieves a constant that identifies the component this reference object is associated with. The component is either an axis, or a series.

Returns:
Constant that identifies the component this reference object is associated with.
See Also:
GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES

setAssociation

public void setAssociation(int component)
Specifies a constant that represents the component this reference object is associated with.

Parameters:
component - Constant that identifies the component this reference object is associated with. By default it is associated with the Y1AXIS.
See Also:
GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES

getSeries

public int getSeries()
Retrieves the series this reference object is associated with.

Returns:
The zero-based number of the series that this reference object is associated with.

setSeries

public void setSeries(int series)
Specifies the series this reference object is associated with.

Parameters:
series - The zero-based number of the series that this reference object is associated with. By default it is associated with the first series.

getColor

public java.awt.Color getColor()
Retrieves the color of the reference object.

Returns:
The color of the specified reference object.

setColor

public void setColor(java.awt.Color newColor)
Specifies the color of the reference object.

Parameters:
newColor - The color for the reference object. The default is Red (0xffcc0000)

getLineWidth

public int getLineWidth()
Retrieves the width of the reference line in pixels. Not relevant to reference areas.

Returns:
The width of the reference line in pixels.

setLineWidth

public void setLineWidth(int width)
Specifies the width of the reference line in pixels. Not relevant to reference areas.

Parameters:
width - The width for the reference line in pixels. The default line width is single pixel.

getLineStyle

public int getLineStyle()
Retrieves the style of the line. Not relevant to reference areas.

Returns:
A constant that represents the line style of the specified reference line. Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

setLineStyle

public void setLineStyle(int style)
Specifies the style of the line. Not relevant to reference areas.

Parameters:
style - The style of the line. By default the line style is LS_SOLID
See Also:
BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

getText

public java.lang.String getText()
Retrieves the text for the reference object. This text will appear as a Legend text for this reference object.

Returns:
The text for the reference object.

setText

public void setText(java.lang.String str)
Specifies the text of the reference object. This text will appear as a Legend text for this reference object.

Parameters:
str - The text of the reference object.

getShortDesc

public java.lang.String getShortDesc()
Retrieves the short description for the reference object. This text will appear as an alternative text for tooltip

Returns:
The text for the reference object.

setShortDesc

public void setShortDesc(java.lang.String shortDesc)
Specifies the short description for the reference object. This text will appear as an alternative text for tooltip

Parameters:
shortDesc - The text of the reference object.

isDisplayedInLegend

public boolean isDisplayedInLegend()
Indicates whether the reference object appears in the legend.

Returns:
true if the specified reference object appears in the legend, false if it does not.

setDisplayedInLegend

public void setDisplayedInLegend(boolean visible)
Specifies whether to display the reference object in the legend.

Parameters:
visible - true to display the object in the legend, false to remove it from the legend.

getLineValue

public java.lang.Object getLineValue()
Retrieves the value at which the reference line is displayed. Not relevant to reference areas.

Returns:
An object representing the value at which the reference object is displayed along the axis. This Object will be of type Number when reference object is of type "Line".

setLineValue

public void setLineValue(java.lang.Object value)
Specifies the value at which the reference line is displayed. Not relevant to reference areas.

Parameters:
value - The value at which to display the reference object. This Object will be of type Number when reference object is of type "Line".

getLowValue

public java.lang.Object getLowValue()
Retrieves the low value of the reference Area. Not relevant to reference lines.

Returns:
An object representing the low value of the reference area

setLowValue

public void setLowValue(java.lang.Object value)
Specifies the low value of the reference area.

Parameters:
value - The low value of the reference area.

getHighValue

public java.lang.Object getHighValue()
Retrieves the high value of the reference Area. Not relevant to reference lines.

Returns:
An object representing the high value of the reference area

setHighValue

public void setHighValue(java.lang.Object value)
Specifies the high value of the reference area.

Parameters:
value - The high value of the reference area.

getSFX

public SFX getSFX()
Retrieves the SFX object for this exceptional riser. This allows you to retrieve and specify attributes for special effects.

Returns:
The SFX object for this exceptional riser.

getID

public int getID()
Retrieves the ID of this ReferenceObject.

Returns:
ID of this ReferenceObject.

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.

getXML

protected oracle.dss.util.xml.ObjectNode getXML(boolean allProperties,
                                                boolean allOverriddenProperties)
For internal use only. Application developers should not use this
Retrieves style properties of this component to XML returns whether style is overridden

setReferenceLineXML

protected void setReferenceLineXML(oracle.dss.util.xml.ObjectNode referenceNode)
For internal use only. Application developers should not use this
Sets properties of this component from XML

setXML

public void setXML(oracle.dss.util.xml.ObjectNode referenceNode,
                   java.util.HashMap map)
Overrides:
setXML in class BaseComponentXML
For internal use only. Application developers should not use this
Sets properties of this component from XML

setXML

public void setXML(oracle.dss.util.xml.ObjectNode referenceNode)
Overrides:
setXML in class BaseComponentXML
For internal use only. Application developers should not use this
Sets style properties of this component from XML

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

Copyright © 1997, 2013, Oracle. All rights reserved.