public class ReferenceObject extends BaseGraphComponent
Modifier and Type | Field and Description |
---|---|
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 |
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
m_jsfHashMap
Constructor and Description |
---|
ReferenceObject(CommonGraph graph) |
Modifier and Type | Method and Description |
---|---|
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) |
convertAssociationToInt, convertFillPatternToString, convertGradientDirectionToString, convertHorizontalAlignmentToInt, convertHorizontalAlignmentToString, convertLineStyleToInt, convertLineStyleToString, convertLocationToInt, convertTextRotationtToInt, convertTickStyleToInt, convertTypeToInt, convertVerticalAlignmentToInt, convertVerticalAlignmentToString, hexStringToInt, toHexString
getNonstyleXML, getStyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML
protected SFX m_sfx
protected java.lang.Object m_value
protected int m_display
protected java.lang.String m_elementName
protected boolean[] m_legend
public static final boolean d_referenceLineVisible
public static final int d_referenceLineWidth
public static final int d_referenceLineStyle
public static final double d_referenceLineValue
public static final boolean d_referenceLineDisplayedInLegend
public ReferenceObject(CommonGraph graph)
graph
- The graph that this object belongs to.public boolean selectObject(int series, int group)
selectObject
in class BaseGraphComponent
series
- Any integer.group
- Any integer.true
if successful, false
if not.public int getType()
BaseGraphComponent.RO_LINE
,
BaseGraphComponent.RO_AREA
public void setType(int type)
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.BaseGraphComponent.RO_LINE
,
BaseGraphComponent.RO_AREA
public int getLocation()
BaseGraphComponent.RO_FRONT
,
BaseGraphComponent.RO_BACK
public void setLocation(int location)
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.BaseGraphComponent.RO_FRONT
,
BaseGraphComponent.RO_BACK
public int getAssociation()
GraphConstants.Y1AXIS
,
GraphConstants.Y2AXIS
,
GraphConstants.X1AXIS
,
GraphConstants.SERIES
public void setAssociation(int component)
component
- Constant that identifies the component this reference
object is associated with. By default it is associated
with the Y1AXIS.GraphConstants.Y1AXIS
,
GraphConstants.Y2AXIS
,
GraphConstants.X1AXIS
,
GraphConstants.SERIES
public int getSeries()
public void setSeries(int series)
series
- The zero-based number of the series that this reference
object is associated with. By default it is associated
with the first series.public java.awt.Color getColor()
public void setColor(java.awt.Color newColor)
newColor
- The color for the reference object. The default
is Red (0xffcc0000)public int getLineWidth()
public void setLineWidth(int width)
width
- The width for the reference line in pixels.
The default line width is single pixel.public int getLineStyle()
BaseGraphComponent.LS_SOLID
,
BaseGraphComponent.LS_DASH
,
BaseGraphComponent.LS_DOTTED
,
BaseGraphComponent.LS_DASH_DOT
public void setLineStyle(int style)
style
- The style of the line. By default the line style
is LS_SOLIDBaseGraphComponent.LS_SOLID
,
BaseGraphComponent.LS_DASH
,
BaseGraphComponent.LS_DOTTED
,
BaseGraphComponent.LS_DASH_DOT
public java.lang.String getText()
public void setText(java.lang.String str)
str
- The text of the reference object.public java.lang.String getShortDesc()
public void setShortDesc(java.lang.String shortDesc)
shortDesc
- The text of the reference object.public boolean isDisplayedInLegend()
true
if the specified reference object
appears in the legend,
false
if it does not.public void setDisplayedInLegend(boolean visible)
visible
- true
to display the object in the legend,
false
to remove it from the legend.public java.lang.Object getLineValue()
public void setLineValue(java.lang.Object value)
value
- The value at which to display the reference object.
This Object will be of type Number when reference object
is of type "Line".public java.lang.Object getLowValue()
public void setLowValue(java.lang.Object value)
value
- The low value of the reference area.public java.lang.Object getHighValue()
public void setHighValue(java.lang.Object value)
value
- The high value of the reference area.public SFX getSFX()
SFX
object for this exceptional riser.
This allows you to retrieve and specify attributes for special effects.SFX
object for this exceptional riser.public int getID()
protected java.lang.String getComponentName()
getComponentName
in class BaseComponentXML
protected oracle.dss.util.xml.ObjectNode getXML(boolean allProperties, boolean allOverriddenProperties)
protected void setReferenceLineXML(oracle.dss.util.xml.ObjectNode referenceNode)
public void setXML(oracle.dss.util.xml.ObjectNode referenceNode, java.util.HashMap map)
setXML
in class BaseComponentXML
public void setXML(oracle.dss.util.xml.ObjectNode referenceNode)
setXML
in class BaseComponentXML