oracle.dss.gauge
Class CommonGauge

java.lang.Object
  oracle.dss.dataView.CommonDataview
      oracle.dss.gauge.CommonGauge

All Implemented Interfaces:

DataviewAttributes, DataviewCommon, DataviewConstants, ImageView, GaugeAttributes, GaugeConstants, GaugeSetAttributes, oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, oracle.dss.util.persistence.CatLinkNode, oracle.dss.util.persistence.CatNode, oracle.dss.util.persistence.contract.AggregableContract, oracle.dss.util.persistence.contract.CustomXMLContract, oracle.dss.util.persistence.contract.OptionalContract, oracle.dss.util.persistence.Persistable, oracle.dss.util.persistence.SimplePersistable, oracle.dss.util.persistence.StringXMLizable

public class CommonGauge
extends CommonDataview
implements GaugeConstants, ImageView, oracle.dss.util.persistence.Persistable

Entry-point for the Gauge bean. This class, together with internal gauge rendering logic, will be common to further implementations of the gauge bean, such as thick and rich-client versions.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.dss.dataView.CommonDataview

CommonDataview.NullObject

Nested classes/interfaces inherited from interface oracle.dss.gauge.GaugeConstants

GaugeConstants.HorizontalAlignment

Field Summary

static java.lang.String	a_abBottomLabel
static java.lang.String	a_aBottomLabel
static java.lang.String	a_abTopLabel
static java.lang.String	a_abValue
static java.lang.String	a_angleExtent
static java.lang.String	a_aTopLabel
static java.lang.String	a_aValue
static java.lang.String	a_bBottomLabel
static java.lang.String	a_bTopLabel
static java.lang.String	a_bValue
static java.lang.String	a_content
static java.lang.String	a_customLayout
static java.lang.String	a_gauge
static java.lang.String	a_gaugeType
static java.lang.String	a_gsalignment
static java.lang.String	a_gscolcount
static java.lang.String	a_gsdirection
static java.lang.String	a_indicatorBarFillColor
static java.lang.String	a_indicatorType
static java.lang.String	a_ledStyle
static java.lang.String	a_majorTickColor
static java.lang.String	a_majorTickCount
static java.lang.String	a_minLength
static java.lang.String	a_minorTickColor
static java.lang.String	a_minorTickCount
static java.lang.String	a_numberType
static java.lang.String	a_specularHighlight
static java.lang.String	a_tdMaxValue
static java.lang.String	a_tdStyle
static java.lang.String	a_thresholdColor
static java.lang.String	a_thresholdMaxValue
static java.lang.String	a_useThresholdFillColor
static java.lang.String	ADA_SCREEN_READER_MODE
protected static int	ATTR_STYLE_MAXID
static java.lang.String	cl_none
static java.lang.String	cl_outer_frame
static java.lang.String	cl_title_separator
protected static int	DEFAULT_MAP_ATTRCOUNT Used to default the size of new HashMaps
protected static int	DEFAULT_MAP_GSATTRCOUNT
static java.lang.String	DIAL_NAME
protected static java.lang.String	DS_COLUMN Used in creating data maps to determine column of the map entry relative to its DataSource.
protected static java.lang.String	DS_ROW Used in creating data maps to determine row of the map entry relative to its DataSource.
static java.lang.String	dst_bottomlabel
static java.lang.String	dst_maximum
static java.lang.String	dst_metric
static java.lang.String	dst_minimum
static java.lang.String	dst_threshold
static java.lang.String	dst_toplabel
static java.lang.String	gsa_bottom
static java.lang.String	gsa_bottomleft
static java.lang.String	gsa_bottomright
static java.lang.String	gsa_center
static java.lang.String	gsa_left
static java.lang.String	gsa_none
static java.lang.String	gsa_right
static java.lang.String	gsa_top
static java.lang.String	gsa_topleft
static java.lang.String	gsa_topright
static java.lang.String	gsc_auto
static java.lang.String	gsd_across
static java.lang.String	gsd_down
static java.lang.String	LABELGAUGE_NAME
static java.lang.String	LED_NAME
protected static int	LEGEND_ITEM_GAP
protected javax.swing.event.EventListenerList	listenerList
static java.lang.String	ls_arrow String representation used to indicate arrow-style LED gauges in XML.
static java.lang.String	ls_custom String representation used to indicate custom-style LED gauges in XML.
static java.lang.String	ls_dot String representation used to indicate dot-style LED gauges in XML.
static java.lang.String	ls_kpi String representation used to indicate KPI-style LED gauges in XML.
static java.lang.String	ls_rectangle String representation used to indicate rectangular LED gauges in XML.
static java.lang.String	ls_square String representation used to indicate square LED gauges in XML.
static java.lang.String	ls_triangle String representation used to indicate triangle-style LED gauges in XML.
protected java.util.Hashtable	m_context
protected boolean	m_metaDateSpanSupported
protected boolean	m_metaDateSupported
protected boolean	m_metaDrillParentDateSpanSupported
protected boolean	m_metaDrillParentDateSupported
protected boolean	m_metaDrillSupported
protected static java.lang.String	m_version
protected static int	MARKER_DIAMETER
protected static int	MARKER_TEXT_GAP
static java.lang.String	METRIC_COLUMN
static java.lang.String	METRIC_ROW
static int	MODE_SKIN
static int	MODE_USER
static java.lang.String	NAME_BOTTOMLABEL
static java.lang.String	NAME_DATASPECIFICATION
static java.lang.String	NAME_GAUGE
static java.lang.String	NAME_GAUGEFONT
static java.lang.String	NAME_GAUGEFRAME
static java.lang.String	NAME_GAUGESETBACKGROUND
static java.lang.String	NAME_GAUGESETTITLE
static java.lang.String	NAME_INDICATOR
static java.lang.String	NAME_INDICATORBAR
static java.lang.String	NAME_INDICATORBASE
static java.lang.String	NAME_LEGENDAREA
static java.lang.String	NAME_LEGENDTEXT
static java.lang.String	NAME_LEGENDTITLE
static java.lang.String	NAME_LOWERLABELFRAME
static java.lang.String	NAME_METRIC_VALUE
static java.lang.String	NAME_METRICLABEL
static java.lang.String	NAME_PLOTAREA
static java.lang.String	NAME_SFX
static java.lang.String	NAME_THRESHOLD
static java.lang.String	NAME_TICKLABEL
static java.lang.String	NAME_TICKMARK
static java.lang.String	NAME_TOOLTIPS
static java.lang.String	NAME_TOPLABEL
static java.lang.String	NAME_UPPERLABELFRAME
static java.lang.String	NAME_VENNDATA
static java.lang.String	NAME_VENNELEMENT
static java.lang.String	nt_number
static java.lang.String	nt_percent
static int	RECALC_STATE_DATA
static int	RECALC_STATE_PROPERTIES
static int	RECALC_STATE_READY
static java.lang.String	sh_off
static java.lang.String	sh_on
static java.lang.String	STATUSMETER_NAME
static java.lang.String	tc_increments
static java.lang.String	tc_majortick
static java.lang.String	tc_metric
static java.lang.String	tc_minmax
static java.lang.String	tc_none
static java.lang.String	tc_threshold
static java.lang.String	tds_pie
static java.lang.String	tds_ring
static java.lang.String	tds_segments
static java.lang.String	veid_a
static java.lang.String	veid_ab
static java.lang.String	veid_b
static java.lang.String	VENN_NAME
static java.lang.String	VERTICALSTATUSMETER_NAME

Fields inherited from class oracle.dss.dataView.CommonDataview

a_animationDownColor, a_animationDuration, a_animationIndicators, a_animationOnDataChange, a_animationOnDisplay, a_animationUpColor, a_interactivityBehavior, a_visualEffects, ad_auto, ad_none, adc_auto, adc_none, adc_on, ai_all, ai_none, fontList, m_attrs, m_dataUnformattedSupported, m_description, m_dvStrings, m_eh, m_htmlPagingControlAutosubmit, m_htmlPagingControlWidth, m_layerMetadataLabelTypes, m_layermetaLonglabelSupported, m_layermetaMediumlabelSupported, m_layermetaNameSupported, m_layermetaShortlabelSupported, m_layermetaViewStyleSupported, m_localName, m_memberMetadataLabelTypes, m_metaLonglabelSupported, m_metaMediumlabelSupported, m_metaShortlabelSupported, m_metaValueSupported, m_metaViewStyleSupported, m_method_fillRelationalDataArrays, m_method_setDescription, m_method_setLocalName, m_method_setName, m_name, m_pagingControlPosition, m_pagingVisible, m_thickView, m_validate, m_viewXML, m_waitDataForRows, ve_auto, ve_bevel, ve_glow, ve_none, ve_shadow

Fields inherited from interface oracle.dss.gauge.GaugeConstants

a_horizontalAlignment, CSP_BEVELED_CIRCLE, CSP_FULL_CIRCLE, CSP_ROUNDED_RECTANGLE, DIAL, GAUGE, GAUGE_TYPE, GSA_BOTTOM, GSA_BOTTOMLEFT, GSA_BOTTOMRIGHT, GSA_CENTER, GSA_LEFT, GSA_NONE, GSA_RIGHT, GSA_TOP, GSA_TOPLEFT, GSA_TOPRIGHT, GSALIGNMENT_MAX, GSALIGNMENT_MIN, GSC_AUTO, GSCOLCOUNT_MAX, GSD_ACROSS, GSD_DOWN, GSDIRECTION_MAX, GSDIRECTION_MIN, ID_BACKGROUND, ID_BOTTOMLABEL, ID_ELEMENTA, ID_ELEMENTB, ID_GAUGEFRAME, ID_GAUGESETBACKGROUND, ID_GAUGESETTITLE, ID_INDICATOR, ID_INDICATORBAR, ID_INDICATORBASE, ID_INTERSECTIONAB, ID_LEGENDAREA, ID_LEGENDTEXT, ID_LEGENDTITLE, ID_LOWERLABELFRAME, ID_LOWERREFLECTION, ID_METRICLABEL, ID_OVERLAY, ID_PLOTAREA, ID_THRESHOLD, ID_TICKLABEL, ID_TICKMARK, ID_TITLESEPARATOR, ID_TOOLTIPS, ID_TOPLABEL, ID_UPPERLABELFRAME, LABELGAUGE, LED, OFFCENTER_DISTANCE, STATUSMETER, SVG_MODE_BASIC, SVG_MODE_DRILLING, SVG_MODE_FONT_EMBEDDING, SVG_MODE_FULL, SVG_MODE_NO_HEADER, SVG_MODE_SHAPE_ATTRIBUTES, SVG_MODE_TOOLTIPS, TYPE_MAX, TYPE_MIN, UNDEFINED, VENN, VERTICALSTATUSMETER

Fields inherited from interface oracle.dss.gauge.GaugeSetAttributes

GAUGESET_ALIGNMENT, GAUGESET_COLUMNCOUNT, GAUGESET_DIRECTION, GAUGESET_TITLE_FONT, GAUGESET_TITLE_FONT_COLOR, GAUGESET_TITLE_TEXT, GRAPHIC_ANTIALIASING, GSBACKGROUND_BORDERCOLOR, GSBACKGROUND_FILLCOLOR, GSBACKGROUND_SFX, LEGEND_AREA_BORDERCOLOR, LEGEND_AREA_FILLCOLOR, LEGEND_AREA_POSITION, LEGEND_AREA_SFX, LEGEND_AREA_VISIBLE, LEGEND_TEXT_FONT, LEGEND_TEXT_FONT_COLOR, LEGEND_TEXT_MIN_LENGTH, LEGEND_TEXT_NUMBER_TYPE, LEGEND_TITLE_FONT, LEGEND_TITLE_FONT_COLOR, LEGEND_TITLE_TEXT, LEGEND_TITLE_VISIBLE, TEXT_ANTIALIASING, TOOLTIP_FONT, TOOLTIP_FONT_COLOR, TOOLTIP_HORIZONTAL_ALIGNMENT

Fields inherited from interface oracle.dss.gauge.GaugeAttributes

ANGLE_EXTENT, BACKGROUND_BORDERCOLOR, BACKGROUND_FILLCOLOR, BACKGROUND_SFX, BOTTOM_LABEL, BOTTOM_LABEL_COLOR, BOTTOM_LABEL_FONT, BOTTOM_LABEL_POSITION, BOTTOM_LABEL_TEXT, BOTTOM_LABEL_VISIBLE, CL_MAX, CL_MIN, CL_NONE, CL_OUTER_FRAME, CL_TITLE_SEPARATOR, CS_BOTTOMLABELBOUNDS, CS_GAUGEFRAME, CS_INDICATOR, CS_INDICATORBASE, CS_INDICATORCENTER, CS_LEDFILLAREA, CS_LOWERLABELFRAME, CS_METRICLABELBOUNDS, CS_MINORTICKMARK, CS_PLOTAREA, CS_PLOTAREABOUNDS, CS_THRESHOLDFILLAREA, CS_TICKMARK, CS_TICKMARKPATH, CS_TOPLABELBOUNDS, CS_UPPERLABELFRAME, CUSTOM_LAYOUT, CUSTOM_SHAPES_PATH, DATAVIEW_END, ELEMENTA_BORDERCOLOR, ELEMENTA_BOTTOMLABEL, ELEMENTA_FILLCOLOR, ELEMENTA_SFX, ELEMENTA_TOPLABEL, ELEMENTA_VALUE, ELEMENTB_BORDERCOLOR, ELEMENTB_BOTTOMLABEL, ELEMENTB_FILLCOLOR, ELEMENTB_SFX, ELEMENTB_TOPLABEL, ELEMENTB_VALUE, GAUGEFRAME_BORDERCOLOR, GAUGEFRAME_FILLCOLOR, GAUGEFRAME_SFX, GAUGEFRAME_VISIBLE, ID_GAUGE, INDICATOR_BAR_BORDERCOLOR, INDICATOR_BAR_FILLCOLOR, INDICATOR_BAR_SFX, INDICATOR_BASE_BORDERCOLOR, INDICATOR_BASE_FILLCOLOR, INDICATOR_BASE_SFX, INDICATOR_BASE_VISIBLE, INDICATOR_BORDERCOLOR, INDICATOR_FILLCOLOR, INDICATOR_SFX, INDICATOR_TYPE, INDICATOR_TYPE_MAX, INDICATOR_TYPE_MIN, INDICATOR_USE_THRESHOLD_FILLCOLOR, INTERSECTIONAB_BORDERCOLOR, INTERSECTIONAB_BOTTOMLABEL, INTERSECTIONAB_FILLCOLOR, INTERSECTIONAB_SFX, INTERSECTIONAB_TOPLABEL, INTERSECTIONAB_VALUE, IT_FILL, IT_LINE, IT_NEEDLE, LED_STYLE, LED_STYLE_CALLBACK, LEDSTYLE_MAX, LEDSTYLE_MIN, LEGENDTEXT_NUMBER_TYPE, LEGENDTEXT_VIEWFORMAT, LINK, LOCALE, LOWLBLFRAME_BORDERCOLOR, LOWLBLFRAME_FILLCOLOR, LOWLBLFRAME_SFX, LOWLBLFRAME_VISIBLE, LP_ABOVE_GAUGE, LP_BELOW_GAUGE, LP_INSIDE_GAUGE, LP_INSIDE_GAUGE_LEFT, LP_INSIDE_GAUGE_RIGHT, LP_MAX, LP_MIN, LP_NONE, LP_WITH_BOTTOM_LABEL, LS_ARROW, LS_CUSTOM, LS_DOT, LS_KPI, LS_RECTANGLE, LS_SQUARE, LS_TRIANGLE, MAJORTICK_COLOR, MAJORTICK_COUNT, MAX_VALUE, METADATA_POINT_OF_ROTATION, METRIC, METRIC_LABEL_BACKCOLOR, METRIC_LABEL_COLOR, METRIC_LABEL_FONT, METRIC_LABEL_NUMBER_TYPE, METRIC_LABEL_POSITION, METRIC_LABEL_VIEWFORMAT, MIN_VALUE, MINORTICK_COLOR, MINORTICK_COUNT, NAME_ELEMENTA, NAME_ELEMENTB, NAME_INTERSECTIONAB, NODATA_LABEL, NT_NUMBER, NT_PERCENT, NUMBER_TYPE_MAX, NUMBER_TYPE_MIN, PLOTAREA_BORDERCOLOR, PLOTAREA_FILLCOLOR, PLOTAREA_SFX, PLOTAREA_USE_THRESHOLD_FILLCOLOR, SFX_BEVEL_ANGLE, SFX_BEVEL_BLURX, SFX_BEVEL_BLURY, SFX_BEVEL_DISTANCE, SFX_BEVEL_HIGHLIGHT_COLOR, SFX_BEVEL_QUALITY, SFX_BEVEL_SHADOW_COLOR, SFX_BEVEL_STRENGTH, SFX_BEVEL_TYPE, SFX_END_POINT, SFX_FILL_TYPE, SFX_GLOW_BLURX, SFX_GLOW_BLURY, SFX_GLOW_COLOR, SFX_GLOW_INNER, SFX_GLOW_KNOCKOUT, SFX_GLOW_QUALITY, SFX_GLOW_STRENGTH, SFX_GRADIENT_CENTER, SFX_GRADIENT_DIRECTION, SFX_GRADIENT_REVERSED, SFX_MOUSE_TRANSPARENT, SFX_NUM_STOPS, SFX_SHADOW_ANGLE, SFX_SHADOW_BLURX, SFX_SHADOW_BLURY, SFX_SHADOW_COLOR, SFX_SHADOW_DISTANCE, SFX_SHADOW_HIDE, SFX_SHADOW_INNER, SFX_SHADOW_KNOCKOUT, SFX_SHADOW_QUALITY, SFX_SHADOW_STRENGTH, SFX_START_POINT, SFX_STOP_COLORS, SFX_STOP_POSITIONS, SFX_VISUAL_EFFECTS, SH_OFF, SH_ON, SPECULAR_HIGHLIGHT, TC_INCREMENTS, TC_MAJORTICK, TC_METRIC, TC_MIN_MAX, TC_NONE, TC_THRESHOLD, TD_STYLE, TDS_MAX, TDS_MIN, TDS_PIE_FILL, TDS_RING_FILL, TDS_SEGMENTS, THRESHOLD_ATTRIBUTES, THRESHOLD_BORDERCOLOR, THRESHOLD_FILLCOLOR, THRESHOLD_SFX, THRESHOLD_TEXT, THRESHOLD_VALUES, TICK_CONTENT_MAX, TICK_CONTENT_MIN, TICK_LABEL_NUMBER_TYPE, TICKLABEL_COLOR, TICKLABEL_CONTENT, TICKLABEL_FONT, TICKLABEL_POSITION, TICKLABEL_POSITION_MAX, TICKLABEL_POSITION_MIN, TICKLABEL_VIEWFORMAT, TICKMARK_CONTENT, TLP_EXTERIOR, TLP_INTERIOR, TOOLTIP_TEXT, TOP_LABEL, TOP_LABEL_COLOR, TOP_LABEL_FONT, TOP_LABEL_POSITION, TOP_LABEL_TEXT, TOP_LABEL_VISIBLE, UPLBLFRAME_BORDERCOLOR, UPLBLFRAME_FILLCOLOR, UPLBLFRAME_SFX, UPLBLFRAME_VISIBLE

Fields inherited from interface oracle.dss.dataView.DataviewConstants

AD_AUTO, AD_MAX, AD_MIN, AD_NONE, ADC_AUTO, ADC_MAX, ADC_MIN, ADC_NONE, ADC_ON, AI_ALL, AI_MAX, AI_MIN, AI_NONE, ANIMATION_DOWN_COLOR, ANIMATION_DURATION, ANIMATION_INDICATORS, ANIMATION_ON_DATA_CHANGE, ANIMATION_ON_DISPLAY, ANIMATION_UP_COLOR, DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, FORMAT_MANAGER_NAME, FT_COLOR, FT_GRADIENT, FT_PATTERN, FT_TEXTURE, GD_CUSTOM_LINEAR, GD_CUSTOM_RADIAL, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_OFF_CENTER, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, PAGE_CONTROL, page_header, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, PAGING_CONTROL_EAST_OF_VIEW, PAGING_CONTROL_SOUTH_OF_VIEW, PAGING_CONTROL_WEST_OF_VIEW, RESET_EVERYTHING, RESET_EVERYTHING_CUSTOM, RESET_EVERYTHING_NOT_DATASOURCE, RESET_EVERYTHING_ORIGINAL, RESET_MAX, RESET_MIN, RESET_NONE, RESET_XML_PROPERTIES, RESET_XML_PROPERTIES_CUSTOM, RESET_XML_PROPERTIES_ORIGINAL, STYLE_MANAGER_NAME, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, TOOLTIP_NAME, VE_AUTO, VE_BEVEL, VE_GLOW, VE_MAX, VE_MIN, VE_NONE, VE_SFX_MAX, VE_SFX_MIN, VE_SHADOW, VIEW_FORMAT_NAME, VIEW_STYLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GAUGE, VIEW_TYPE_GRAPH, VIEW_TYPE_PAGINGCONTROL, VIEW_TYPE_TABLE, VISUAL_EFFECTS

Fields inherited from interface oracle.dss.dataView.ImageView

a_imageHeight, a_imageWidth, SVG_HEADERS_ALL, SVG_HEADERS_NONE, SVG_MODE_BASIC, SVG_MODE_DATA_SCROLLING, SVG_MODE_DATA_ZOOMING, SVG_MODE_DRILLING, SVG_MODE_FONT_EMBEDDING, SVG_MODE_FULL, SVG_MODE_METADATA, SVG_MODE_NO_HEADER, SVG_MODE_SHAPE_ATTRIBUTES, SVG_MODE_TIME_AXIS_EVENT, SVG_MODE_TOOLTIPS

Constructor Summary

CommonGauge()

CommonGauge(java.util.Locale locale, ThickGauge gauge)

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a PropertyChangeListener to this CommonGauge instance
void	clearOverrideFlags()
void	clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
static int	convertCustomLayoutToInt(java.lang.String type)
static java.lang.String	convertCustomLayoutToString(int type)
static int	convertGaugeSetAlignmentToInt(java.lang.String align)
static java.lang.String	convertGaugeSetAlignmentToString(int align)
static int	convertGaugeSetColCountToInt(java.lang.String colCount)
static java.lang.String	convertGaugeSetColCountToString(int colCount)
static int	convertGaugeSetDirectionToInt(java.lang.String value)
static java.lang.String	convertGaugeSetDirectionToString(int value)
static int	convertGaugeTypeToInt(java.lang.String type)
static java.lang.String	convertGaugeTypeToString(int type) Generates a String representation of a gauge type constant.
static int	convertLEDStyleToInt(java.lang.String style) Generates a String representation of an LED style constant.
static java.lang.String	convertLEDStyleToString(int style) Generates a String representation of an LED style constant.
static int	convertNumberTypeToInt(java.lang.String type)
static java.lang.String	convertNumberTypeToString(int type)
static int	convertSpecularHighlightToInt(java.lang.String style)
static java.lang.String	convertSpecularHighlightToString(int style)
static int	convertTDStyleToInt(java.lang.String style)
static java.lang.String	convertTDStyleToString(int style)
static int	convertTickContentToInt(java.lang.String contentStr)
static java.lang.String	convertTickContentToString(int content) Converts a tick content property to its string representation.
protected GaugeExportXMLWriter	createExportXMLWriter(java.io.OutputStream os, java.lang.String charEnc)
protected GaugeExportXMLWriter	createExportXMLWriter(java.io.Writer writer, java.lang.String charEnc)
protected LocalXMLDataSource	createLocalGridDataSource(oracle.dss.util.xml.ObjectNode node)
protected LocalXMLDataSource	createLocalRelationalDataSource(oracle.dss.util.xml.ContainerNode node)
protected void	createPropertyOverrideFlags()
java.util.BitSet	createPropertyOverrideFlags(int maxID)
protected GaugeSVGWriter	createSVGWriter(java.io.OutputStream os, java.lang.String charEnc)
protected GaugeSVGWriter	createSVGWriter(java.io.Writer writer, java.lang.String charEnc)
void	exportToFlash(java.io.OutputStream os, boolean renderDynamic, boolean showDrawing) Deprecated. exportToXML should be used instead
void	exportToPNG(java.io.OutputStream os) Exports a snapshot of the gauge set to the PNG file.
void	exportToPNGWithException(java.io.OutputStream os) Exports a snapshot of the gauge set to the PNG file.
void	exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the SVG file.
void	exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc)
void	exportToSWFWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the view to a SWF file.
void	exportToXMLWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the XML file.
void	exportToXMLWithException(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the page that is currently displayed to the XML file.
protected void	fillLinkArrays(int colCount, int rowCount, java.lang.Object[] colLabels, java.lang.Object[] rowLabels, java.util.Hashtable dataValLinks)
protected void	firePropertyChange(java.lang.Object obj, java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
protected javax.swing.event.EventListenerList	getAlertListenerList()
java.lang.String	getAlternativeText(ComponentHandle handle)
int	getAngleExtent() This method gets the angular extent of the dial gauge's plotArea.
java.awt.Color	getAnimationDownColor()
int	getAnimationDuration()
int	getAnimationIndicators()
int	getAnimationOnDataChange()
int	getAnimationOnDisplay()
java.awt.Color	getAnimationUpColor()
java.lang.Object	getAttribute(java.lang.String name)
BottomLabel	getBottomLabel()
int	getColCount()
java.lang.String	getColumnLabel(int col)
int	getCustomLayout() This method gets the CustomLayout setting of the gauge.
java.lang.String	getCustomShapesPath() This method gets the path to the Custom Shapes definition file.
DataSpecification	getDataSpecification() Retrieves the DataSpecification for this bean.
DataviewTitles	getDataviewFootnote() Retrieves the footnote for this view.
DataviewTitles	getDataviewSubtitle() Retrieves the subtitle for this view.
DataviewTitles	getDataviewTitle() Retrieves the title for this view.
int[]	getDrillParameters(ComponentHandle handle)
ElementA	getElementA()
ElementB	getElementB()
java.lang.String	getErrorIntlString(java.lang.String key, java.util.ResourceBundle rBundle) Get the error messages from jclient bundle.
java.lang.String	getFlashGaugeLCID()
GaugeBackground	getGaugeBackground()
ComponentHandle	getGaugeComponentHandle(int objID, int row, int column)
int	getGaugeCount()
boolean	getGaugeFontXML(oracle.dss.util.xml.ObjectNode node, java.awt.Font font, java.awt.Font defFont, java.awt.Color color, java.awt.Color defColor)
GaugeFrame	getGaugeFrame()
protected static java.util.ResourceBundle	getGaugeResourceBundle(java.util.Locale loc)
int	getGaugeSetAlignment() This method gets the alignment of gauges in the gauge set.
java.lang.Object	getGaugeSetAttribute(java.lang.String name)
GaugeSetBackground	getGaugeSetBackground()
int	getGaugeSetColumnCount() This method gets the number of columns used to layout the gauges in a gauge set.
int	getGaugeSetDirection() This method gets the layout direction of gauges in the gauge set.
GaugeSetTitle	getGaugeSetTitle() Retrieves the GaugeSetTitle component.
int	getGaugeType() Returns the type of gauges to be generated by this instance of the Gauge bean.
java.util.Enumeration	getImagemapEnumeration(int filter) Retrieves the enumeration of specific kinds of components that are currently in use and visible on the gauge.
java.awt.Dimension	getImageSize() This method gets the size of the gauge set.
Indicator	getIndicator() Get the indicator, which is used to specify the style of the indicator
IntersectionAB	getIntersectionAB()
java.lang.String	getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
int	getLEDStyle() Returns the style of LED gauge to be generated by this instance of the Gauge bean.
LEDStyleCallback	getLEDStyleCallback() Gets the callback to use when rendering custom LEDs.
LegendArea	getLegendArea()
LegendText	getLegendText()
LegendTitle	getLegendTitle()
LowerLabelFrame	getLowerLabelFrame()
MetricLabel	getMetricLabel()
int	getMode()
protected oracle.dss.util.xml.ObjectNode	getObjectNode(boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getObjectNode(java.lang.String objName, boolean allProperties, java.lang.String version)
java.awt.Dimension	getOptimalGaugeSize(java.awt.Dimension maxSize) This method uses the current attributes set on this gauge bean to determine the minimal size a gauge should be in this gauge set.
oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)
oracle.dss.util.persistence.AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this Dataview aggregates.
PlotArea	getPlotArea()
int	getRecalcState() Returns the current scope of work needed during a recalculation of gauge layout.
int	getRowCount()
java.lang.String	getRowLabel(int row)
ComponentHandle	getSelectedObject()
int	getSpecularHighlight() Retrieves the SpecularHighlight property value.
int	getSvgHeaders() Determine whether headers are included in exported SVG.
java.util.List	getSvgScriptIdList()
SVGWriterProvider	getSVGWriterProvider()
Threshold	getThreshold() Get the threshold, which is used to specify the style of the threshold
int	getThresholdDialStyle() Returns the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.
TickLabel	getTickLabel()
TickMark	getTickMark()
ToolTips	getToolTips() Retrieves the tooltip component, in order to set the font format in the tooltip.
java.lang.String	getToolTipText(java.awt.event.MouseEvent e)
TopLabel	getTopLabel()
UpperLabelFrame	getUpperLabelFrame()
protected DataviewXML	getViewXML()
int	getVisualEffects() This method gets the VisualEffects setting of the gauge.
java.lang.String	getXMLAsString() Retrieves the XML representation of this Dataview.
void	initialize(java.util.Hashtable env)
boolean	isGraphicAntialiasing() Retrieves the GraphicAntialiasing property value.
protected boolean	isMetadataDateSpanSupported()
protected boolean	isMetadataDrillParentDateSpanSupported()
protected boolean	isMetadataDrillParentDateSupported()
protected boolean	isMetadataDrillSupported()
protected boolean	isStyleOverrideFlag(int attrID)
boolean	isTextAntialiasing() Retrieves the TextAntialiasing property value.
protected boolean	isUserOverrideFlag(int attrID)
boolean	isXMLValidated() Indicates whether the Dataview validates XML against its DTD.
protected boolean	prepareGaugeEngines()
protected void	processAlertEvent(int eventID)
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Gauge, from an instance of InputStream.
void	refreshData()
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Remove ViewFocusListener from presentation engine.
boolean	renderGauges(GaugeExportXMLWriter writer, int mode)
boolean	renderGauges(GaugeSVGWriter writer, int mode)
boolean	renderGauges(java.awt.Graphics2D g) This method renders the gauges in this gauge set onto the given instance of Graphics.
void	renderLegend(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.Rectangle outerBounds)
protected java.awt.geom.Rectangle2D	renderLegendArea(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.Rectangle outerBounds)
protected void	renderLegendItems(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.geom.Rectangle2D legendFrame)
protected void	renderLegendTitle(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.geom.Rectangle2D legendFrame)
protected void	resetToDefault(int reset, java.lang.String version)
boolean	selectObject(java.awt.event.MouseEvent e)
protected void	setAlertListenerList(javax.swing.event.EventListenerList list)
void	setAngleExtent(int extent) This method sets the angular extent of the dial gauge's plotArea.
void	setAnimationDownColor(java.awt.Color color)
void	setAnimationDuration(int duration)
void	setAnimationIndicators(int type)
void	setAnimationOnDataChange(int type)
void	setAnimationOnDisplay(int type)
void	setAnimationUpColor(java.awt.Color color)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setContext()
void	setCustomLayout(int layout) This method sets the CustomLayout setting of the gauge.
void	setCustomShapesPath(java.lang.String path) This method sets the path to the Custom Shapes definition file.
void	setCustomShapesStreams(java.io.InputStream svgStream, java.io.InputStream xmlStream)
void	setDataAccess(DataAccess dataAccess)
void	setDataDirector(DataDirector dataDirector)
void	setDataSpecification(DataSpecification dataSpec) Sets the DataSpecification for this bean, assuming it is relevant to the current DataSource.
void	setDVTResources(DVTResources res) Specifies Wrapped RichBundle
void	setFlashGaugeLCID(java.lang.String id)
void	setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node, java.lang.String attrName)
void	setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node, java.lang.String attrName, java.util.HashMap map)
void	setGaugeSetAlignment(int alignment) This method sets the alignment of gauges in the gauge set.
void	setGaugeSetAttribute(java.lang.String name, java.lang.Object value)
void	setGaugeSetColumnCount(int columns) This method sets the number of columns used to layout the gauges in a gauge set.
void	setGaugeSetDirection(int direction) This method sets the layout direction of gauges in the gauge set.
void	setGaugeType(int type) Sets the type of gauges to be generated by this instance of the Common Gauge.
void	setGraphicAntialiasing(boolean value) Specifies the value of GraphicAntialiasing.
boolean	setGridData(java.lang.Object[] specs, java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
void	setImageSize(java.awt.Dimension size) This method sets the size of the gauge set.
void	setLayerMetaLongLabelSupported(boolean supported)
void	setLEDStyle(int style) Sets the style of LED gauges to be generated by this instance of the Common Gauge.
void	setLEDStyleCallback(LEDStyleCallback callback) Sets the callback to use when rendering custom LEDs.
void	setLocale(java.util.Locale loc) Specifies the Locale for this Gauge.
void	setMaxValue(double value) Sets the maximum value of the gauge
void	setMetadataDateSpanSupported(boolean supported)
void	setMetadataDrillParentDateSpanSupported(boolean supported)
void	setMetadataDrillParentDateSupported(boolean supported)
void	setMetadataDrillSupported(boolean supported)
void	setMetadataLabelFlag(boolean metadataFlag)
void	setMetricValue(double value) Sets the metric value of a gauge
void	setMetricValues(java.util.List<java.lang.Double> data) Sets multiple metric values of the gauge using a list, displaying multiple indicators in a gauge
void	setMinValue(double value) Sets the minimum value of the gauge
void	setMode(int mode)
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
protected void	setPropertyOverrideFlags(int attrID)
void	setRecalcState(int state)
void	setRecalcState(int state, boolean clear)
boolean	setSelectedObject(int compID, int row, int column) Selects the components of the given type in the gauge identified by the given row and column.
void	setSpecularHighlight(int style) Sets the specularHighlight option for a LED gauge.
void	setStylePath(java.lang.String stylePath)
void	setSvgHeaders(int headers) Set whether headers are included in exported SVG.
void	setSVGWriterProvider(SVGWriterProvider provider)
boolean	setTabularData(java.lang.Object[] specs, java.util.List tableRows) Specifies data for the GaugeBean, from a list of arrays.
void	setTextAntialiasing(boolean value) Specifies the value of TextAntialiasing.
void	setThresholdDialStyle(int style) Sets the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.
void	setThresholdValues(java.util.List<java.lang.Double> data) Sets the threshold values of the gauge.
void	setVisualEffects(int effects) This method sets the VisualEffects setting of the gauge.
protected void	setXML(oracle.dss.util.xml.ObjectNode node, int reset)
void	setXML(java.lang.String xml, java.util.HashMap map)
boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Gauge, from a String.
boolean	setXMLAsString(java.lang.String xml)
void	setXMLValidated(boolean validate) Specifies whether this Gauge validates XML against its DTD.
protected void	updateResourceBundle()
void	writeImagemapXML(java.io.OutputStream os, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph.
void	writeImagemapXML(java.io.PrintWriter out, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph.
void	writeXML(java.io.OutputStream stream, boolean allProperties) Writes XML for this Dataview to an output stream.

Methods inherited from class oracle.dss.dataView.CommonDataview

addErrorHandler, clearStyleModified, clearWaitDataForAllRows, convertAnimationIndicatorsToInt, convertAnimationIndicatorsToString, convertAnimationOnDataChangeToInt, convertAnimationOnDataChangeToString, convertAnimationOnDisplayToInt, convertAnimationOnDisplayToString, convertComponentTypeToInteger, convertComponentTypeToString, convertVisualEffectsToInt, convertVisualEffectsToString, dataFormatChanged, dataStyleChanged, fillRelationalDataArrays, getDataAccess, getDataDirector, getDataSource, getDataviewResourceBundle, getDescription, getErrorHandler, getFlashPlayerDownloadMessageHTML, getFontList, getHTMLPagingControlWidth, getIntlString, getLayerMetadataLabelType, getLayerMetadataLabelType, getLocale, getLocalName, getMemberMetadataLabelType, getMemberMetadataLabelType, getModel, getName, getObjectNode, getPagingControlPosition, getThickDataview, getTokenSubstitution, getVersion, getViewType, getWaitData, getWaitDataForRow, getXML, getZoomFactor, isDataUnformattedSupported, isDataViewFormatSupported, isDrillingEnabled, isDrillingSupported, isEdgeValid, isHTMLPagingControlAutosubmit, isLayerMetadataLabelTypeSupported, isLayerMetaLongLabelSupported, isLayerMetaMediumLabelSupported, isLayerMetaNameSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isLogTabularMissingDataWarning, isMemberMetadataLabelTypeSupported, isMetadataDateSupported, isMetadataLongLabelSupported, isMetadataMediumLabelSupported, isMetadataShortLabelSupported, isMetadataValueSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, isStyleModified, isStyleOverrideMode, isUserOverrideMode, metadataStyleChanged, removeErrorHandler, repaint, scaleFont, setDataSource, setDataUnformattedSupported, setDescription, setDrillingEnabled, setGridData, setGridData, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setLayerMetadataLabelType, setLayerMetaMediumLabelSupported, setLayerMetaNameSupported, setLayerMetaShortLabelSupported, setLayerMetaViewStyleSupported, setLocalName, setLocalXMLDataSource, setMemberMetadataLabelType, setMemberMetadataLabelType, setMetadataDateSupported, setMetadataLongLabelSupported, setMetadataMediumLabelSupported, setMetadataShortLabelSupported, setMetadataValueSupported, setMetadataViewStyleSupported, setModel, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPropertyOverrideFlags, setStyleOverrideMode, setTabularData, setTabularData, setThickDataview, setTokenSubstitution, setUserOverrideMode, setViewXML, setWaitDataForRow

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.ImageView

getFlashPlayerDownloadMessageHTML, setTabularData

Methods inherited from interface oracle.dss.dataView.DataviewAttributes

getHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isPagingControlVisible, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPosition, setPagingControlVisible

Methods inherited from interface oracle.dss.presutil.CommonViewAttributes

getDescription, getLocalName, getName, setDescription, setLocalName, setName

Methods inherited from interface oracle.dss.dataView.DataviewCommon

dataFormatChanged, dataStyleChanged, getDataSource, getErrorHandler, getFontList, getHTMLPagingControlWidth, getIntlString, getLayerMetadataLabelType, getLocale, getMemberMetadataLabelType, getModel, getTokenSubstitution, getViewType, getWaitDataForRow, getZoomFactor, isDataUnformattedSupported, isDataViewFormatSupported, isHTMLPagingControlAutosubmit, isLayerMetadataLabelTypeSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isMemberMetadataLabelTypeSupported, isMetadataShortLabelSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, metadataStyleChanged, repaint, scaleFont, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setPagingControlVisible, setPropertyOverrideFlags, setTokenSubstitution, setWaitDataForRow

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.util.persistence.SimplePersistable

setPersistableAttributes

Field Detail

DS_ROW

protected static final java.lang.String DS_ROW

Used in creating data maps to determine row of the map entry relative to its DataSource.

See Also:

Constant Field Values

DS_COLUMN

protected static final java.lang.String DS_COLUMN

Used in creating data maps to determine column of the map entry relative to its DataSource.

See Also:

Constant Field Values

m_version

protected static final java.lang.String m_version

See Also:

Constant Field Values

For internal use only. Application developers should not use this

current Gauge XML version number

m_context

protected java.util.Hashtable m_context

For internal use only. Application developers should not use this

A context that can contains XMLContext. User can also use this context to pass more information to its objects.

listenerList

protected javax.swing.event.EventListenerList listenerList

m_metaDateSupported

protected boolean m_metaDateSupported

For internal use only. Application developers should not use this

m_metaDrillParentDateSupported

protected boolean m_metaDrillParentDateSupported

For internal use only. Application developers should not use this

m_metaDrillParentDateSpanSupported

protected boolean m_metaDrillParentDateSpanSupported

For internal use only. Application developers should not use this

m_metaDateSpanSupported

protected boolean m_metaDateSpanSupported

For internal use only. Application developers should not use this

m_metaDrillSupported

protected boolean m_metaDrillSupported

For internal use only. Application developers should not use this

RECALC_STATE_READY

public static final int RECALC_STATE_READY

See Also:

Constant Field Values

RECALC_STATE_PROPERTIES

public static final int RECALC_STATE_PROPERTIES

See Also:

Constant Field Values

RECALC_STATE_DATA

public static final int RECALC_STATE_DATA

See Also:

Constant Field Values

DEFAULT_MAP_ATTRCOUNT

protected static final int DEFAULT_MAP_ATTRCOUNT

Used to default the size of new HashMaps

See Also:

Constant Field Values

DEFAULT_MAP_GSATTRCOUNT

protected static final int DEFAULT_MAP_GSATTRCOUNT

See Also:

Constant Field Values

NAME_GAUGE

public static final java.lang.String NAME_GAUGE

See Also:

Gauge, Constant Field Values

For internal use only. Application developers should not use this

Element name: Gauge. The main gauge node..

NAME_GAUGEFRAME

public static final java.lang.String NAME_GAUGEFRAME

See Also:

GaugeFrame, Constant Field Values

For internal use only. Application developers should not use this

Element name: GaugeFrame. The frame behind the gauge.

NAME_TICKLABEL

public static final java.lang.String NAME_TICKLABEL

See Also:

TickLabel, Constant Field Values

For internal use only. Application developers should not use this

Element name: TickLabel. The tick label of the gauge.

NAME_TICKMARK

public static final java.lang.String NAME_TICKMARK

See Also:

TickMark, Constant Field Values

For internal use only. Application developers should not use this

Element name: TickMark. The tickmark of the gauge.

NAME_TOOLTIPS

public static final java.lang.String NAME_TOOLTIPS

See Also:

ToolTips, Constant Field Values

For internal use only. Application developers should not use this

Element name: ToolTips. The tooltip of the gauge.

NAME_INDICATOR

public static final java.lang.String NAME_INDICATOR

See Also:

Indicator, Constant Field Values

For internal use only. Application developers should not use this

Element name: Indicator. The indicator of the gauge.

NAME_INDICATORBAR

public static final java.lang.String NAME_INDICATORBAR

See Also:

Indicator, Constant Field Values

For internal use only. Application developers should not use this

Element name: IndicatorBar. The indicatorBar of the statusmeter gauge.

NAME_INDICATORBASE

public static final java.lang.String NAME_INDICATORBASE

See Also:

Indicator, Constant Field Values

For internal use only. Application developers should not use this

Element name: IndicatorBase. The indicatorBase of the dial gauge.

NAME_THRESHOLD

public static final java.lang.String NAME_THRESHOLD

See Also:

Threshold, Constant Field Values

For internal use only. Application developers should not use this

Element name: Threshold. The threshold of the gauge.

NAME_METRIC_VALUE

public static final java.lang.String NAME_METRIC_VALUE

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Element name: Value. The value(s) of the gauge.

NAME_GAUGESETTITLE

public static final java.lang.String NAME_GAUGESETTITLE

See Also:

GaugeSetTitle, Constant Field Values

For internal use only. Application developers should not use this

Element name: GaugeSetTitle. Title of the Gauge Set.

NAME_TOPLABEL

public static final java.lang.String NAME_TOPLABEL

See Also:

TopLabel, Constant Field Values

For internal use only. Application developers should not use this

Element name: TopLabel. The top label of the gauge.

NAME_BOTTOMLABEL

public static final java.lang.String NAME_BOTTOMLABEL

See Also:

BottomLabel, Constant Field Values

For internal use only. Application developers should not use this

Element name: BottomLabel. The bottom label of the gauge.

NAME_PLOTAREA

public static final java.lang.String NAME_PLOTAREA

See Also:

BottomLabel, Constant Field Values

For internal use only. Application developers should not use this

Element name: BottomLabel. The bottom label of the gauge.

NAME_SFX

public static final java.lang.String NAME_SFX

See Also:

SFX, Constant Field Values

For internal use only. Application developers should not use this

Element name: SFX. An SFX definition for a component.

NAME_METRICLABEL

public static final java.lang.String NAME_METRICLABEL

See Also:

MetricLabel, Constant Field Values

For internal use only. Application developers should not use this

Element name: MetricLabel. The metric label of the gauge.

NAME_UPPERLABELFRAME

public static final java.lang.String NAME_UPPERLABELFRAME

See Also:

UpperLabelFrame, Constant Field Values

For internal use only. Application developers should not use this

Element name: UpperLabelFrame. The frame behind the upper labels of this gauge.

NAME_LOWERLABELFRAME

public static final java.lang.String NAME_LOWERLABELFRAME

See Also:

LowerLabelFrame, Constant Field Values

For internal use only. Application developers should not use this

Element name: LowerLabelFrame. The frame behind the lower labels of this gauge.

NAME_LEGENDAREA

public static final java.lang.String NAME_LEGENDAREA

See Also:

LegendArea, Constant Field Values

For internal use only. Application developers should not use this

Element name: LegendArea. The Gauge legend.

NAME_LEGENDTEXT

public static final java.lang.String NAME_LEGENDTEXT

See Also:

LegendText, Constant Field Values

For internal use only. Application developers should not use this

Element name: LegendText. Text elements in the Gauge legend.

NAME_LEGENDTITLE

public static final java.lang.String NAME_LEGENDTITLE

See Also:

LegendTitle, Constant Field Values

For internal use only. Application developers should not use this

Element name: LegendTitle. Title of the Gauge legend.

NAME_VENNELEMENT

public static final java.lang.String NAME_VENNELEMENT

See Also:

CommonDataview.getXML(java.lang.String, boolean), Constant Field Values

For internal use only. Application developers should not use this

Element name: VennElement.

NAME_VENNDATA

public static final java.lang.String NAME_VENNDATA

See Also:

CommonDataview.getXML(java.lang.String, boolean), Constant Field Values

For internal use only. Application developers should not use this

Element name: VennData.

NAME_GAUGEFONT

public static final java.lang.String NAME_GAUGEFONT

See Also:

CommonDataview.getXML(java.lang.String, boolean), Constant Field Values

For internal use only. Application developers should not use this

Element name: GaugeAttributes.

NAME_GAUGESETBACKGROUND

public static final java.lang.String NAME_GAUGESETBACKGROUND

See Also:

CommonDataview.getXML(java.lang.String, boolean), Constant Field Values

For internal use only. Application developers should not use this

Element name: GaugeSetBackground.

NAME_DATASPECIFICATION

public static final java.lang.String NAME_DATASPECIFICATION

See Also:

CommonDataview.getXML(java.lang.String, boolean), Constant Field Values

For internal use only. Application developers should not use this

Element name: DataSpecification.

a_gauge

public static final java.lang.String a_gauge

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gaugeType

public static final java.lang.String a_gaugeType

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_ledStyle

public static final java.lang.String a_ledStyle

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_specularHighlight

public static final java.lang.String a_specularHighlight

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_tdStyle

public static final java.lang.String a_tdStyle

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_angleExtent

public static final java.lang.String a_angleExtent

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_tdMaxValue

public static final java.lang.String a_tdMaxValue

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_customLayout

public static final java.lang.String a_customLayout

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gsalignment

public static final java.lang.String a_gsalignment

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gscolcount

public static final java.lang.String a_gscolcount

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gsdirection

public static final java.lang.String a_gsdirection

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_numberType

public static final java.lang.String a_numberType

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_minLength

public static final java.lang.String a_minLength

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_content

public static final java.lang.String a_content

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_majorTickCount

public static final java.lang.String a_majorTickCount

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_majorTickColor

public static final java.lang.String a_majorTickColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_minorTickCount

public static final java.lang.String a_minorTickCount

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_minorTickColor

public static final java.lang.String a_minorTickColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_indicatorType

public static final java.lang.String a_indicatorType

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_indicatorBarFillColor

public static final java.lang.String a_indicatorBarFillColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_useThresholdFillColor

public static final java.lang.String a_useThresholdFillColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_thresholdColor

public static final java.lang.String a_thresholdColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_aValue

public static final java.lang.String a_aValue

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_aTopLabel

public static final java.lang.String a_aTopLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_aBottomLabel

public static final java.lang.String a_aBottomLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_abValue

public static final java.lang.String a_abValue

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_abTopLabel

public static final java.lang.String a_abTopLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_abBottomLabel

public static final java.lang.String a_abBottomLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_bValue

public static final java.lang.String a_bValue

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_bTopLabel

public static final java.lang.String a_bTopLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

a_bBottomLabel

public static final java.lang.String a_bBottomLabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

For Venn diagram gauge

DIAL_NAME

public static final java.lang.String DIAL_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state dial gauges in XML.

STATUSMETER_NAME

public static final java.lang.String STATUSMETER_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state status meter gauges in XML.

LED_NAME

public static final java.lang.String LED_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state LED gauges in XML.

VENN_NAME

public static final java.lang.String VENN_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state Venn diagram gauges in XML.

VERTICALSTATUSMETER_NAME

public static final java.lang.String VERTICALSTATUSMETER_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state status meter gauges in XML.

LABELGAUGE_NAME

public static final java.lang.String LABELGAUGE_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to state label gauges in XML.

ls_dot

public static final java.lang.String ls_dot

String representation used to indicate dot-style LED gauges in XML.

See Also:

Constant Field Values

ls_kpi

public static final java.lang.String ls_kpi

String representation used to indicate KPI-style LED gauges in XML.

See Also:

Constant Field Values

ls_arrow

public static final java.lang.String ls_arrow

String representation used to indicate arrow-style LED gauges in XML.

See Also:

Constant Field Values

ls_triangle

public static final java.lang.String ls_triangle

String representation used to indicate triangle-style LED gauges in XML.

See Also:

Constant Field Values

ls_custom

public static final java.lang.String ls_custom

String representation used to indicate custom-style LED gauges in XML.

See Also:

Constant Field Values

ls_rectangle

public static final java.lang.String ls_rectangle

String representation used to indicate rectangular LED gauges in XML.

See Also:

Constant Field Values

ls_square

public static final java.lang.String ls_square

String representation used to indicate square LED gauges in XML.

See Also:

Constant Field Values

tds_pie

public static final java.lang.String tds_pie

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tds_ring

public static final java.lang.String tds_ring

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tds_segments

public static final java.lang.String tds_segments

See Also:

Constant Field Values

For internal use only. Application developers should not use this

sh_on

public static final java.lang.String sh_on

See Also:

Constant Field Values

For internal use only. Application developers should not use this

String representation used to indicate specular highlight in XML.

sh_off

public static final java.lang.String sh_off

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_none

public static final java.lang.String gsa_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_topleft

public static final java.lang.String gsa_topleft

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_top

public static final java.lang.String gsa_top

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_topright

public static final java.lang.String gsa_topright

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_right

public static final java.lang.String gsa_right

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_bottomright

public static final java.lang.String gsa_bottomright

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_bottom

public static final java.lang.String gsa_bottom

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_bottomleft

public static final java.lang.String gsa_bottomleft

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_left

public static final java.lang.String gsa_left

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsa_center

public static final java.lang.String gsa_center

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsc_auto

public static final java.lang.String gsc_auto

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsd_across

public static final java.lang.String gsd_across

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gsd_down

public static final java.lang.String gsd_down

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_none

public static final java.lang.String tc_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_minmax

public static final java.lang.String tc_minmax

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_increments

public static final java.lang.String tc_increments

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_majortick

public static final java.lang.String tc_majortick

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_threshold

public static final java.lang.String tc_threshold

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_metric

public static final java.lang.String tc_metric

See Also:

Constant Field Values

For internal use only. Application developers should not use this

nt_number

public static final java.lang.String nt_number

See Also:

Constant Field Values

For internal use only. Application developers should not use this

nt_percent

public static final java.lang.String nt_percent

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_metric

public static final java.lang.String dst_metric

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_minimum

public static final java.lang.String dst_minimum

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_maximum

public static final java.lang.String dst_maximum

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_threshold

public static final java.lang.String dst_threshold

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_toplabel

public static final java.lang.String dst_toplabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

dst_bottomlabel

public static final java.lang.String dst_bottomlabel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

veid_a

public static final java.lang.String veid_a

See Also:

Constant Field Values

For internal use only. Application developers should not use this

veid_b

public static final java.lang.String veid_b

See Also:

Constant Field Values

For internal use only. Application developers should not use this

veid_ab

public static final java.lang.String veid_ab

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_thresholdMaxValue

public static final java.lang.String a_thresholdMaxValue

See Also:

Constant Field Values

cl_none

public static final java.lang.String cl_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

cl_title_separator

public static final java.lang.String cl_title_separator

See Also:

Constant Field Values

For internal use only. Application developers should not use this

cl_outer_frame

public static final java.lang.String cl_outer_frame

See Also:

Constant Field Values

For internal use only. Application developers should not use this

MODE_USER

public static final int MODE_USER

See Also:

Constant Field Values

For internal use only. Application developers should not use this

MODE_SKIN

public static final int MODE_SKIN

See Also:

Constant Field Values

For internal use only. Application developers should not use this

METRIC_ROW

public static final java.lang.String METRIC_ROW

See Also:

Constant Field Values

For internal use only. Application developers should not use this

METRIC_COLUMN

public static final java.lang.String METRIC_COLUMN

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ATTR_STYLE_MAXID

protected static final int ATTR_STYLE_MAXID

See Also:

Constant Field Values

MARKER_TEXT_GAP

protected static int MARKER_TEXT_GAP

MARKER_DIAMETER

protected static int MARKER_DIAMETER

LEGEND_ITEM_GAP

protected static int LEGEND_ITEM_GAP

ADA_SCREEN_READER_MODE

public static final java.lang.String ADA_SCREEN_READER_MODE

See Also:

Constant Field Values

Constructor Detail

CommonGauge

public CommonGauge()

CommonGauge

public CommonGauge(java.util.Locale locale,
                   ThickGauge gauge)

For internal use only. Application developers should not use this

Method Detail

getGaugeSetBackground

public GaugeSetBackground getGaugeSetBackground()

getGaugeSetTitle

public GaugeSetTitle getGaugeSetTitle()

Retrieves the GaugeSetTitle component. The GaugeSetTitle can be used to specify the font and text for the title of the gauge set.

Returns:

the GaugeSetTitle component belonging to this gauge

getGaugeBackground

public GaugeBackground getGaugeBackground()

getGaugeFrame

public GaugeFrame getGaugeFrame()

getPlotArea

public PlotArea getPlotArea()

getTickLabel

public TickLabel getTickLabel()

getTickMark

public TickMark getTickMark()

setMetricValue

public void setMetricValue(double value)

Sets the metric value of a gauge

Parameters:

value - The metric value to put in the gauge

setMetricValues

public void setMetricValues(java.util.List<java.lang.Double> data)

Sets multiple metric values of the gauge using a list, displaying multiple indicators in a gauge

Parameters:

data - A list of metric values to put in the gauge

setThresholdValues

public void setThresholdValues(java.util.List<java.lang.Double> data)

Sets the threshold values of the gauge. At least one value for the threshold.

Parameters:

data - A list of threshold values to put in the gauge

setMinValue

public void setMinValue(double value)

Sets the minimum value of the gauge

Parameters:

value - Min value of the gauge

setMaxValue

public void setMaxValue(double value)

Sets the maximum value of the gauge

Parameters:

value - Max value of the gauge

getIndicator

public Indicator getIndicator()

Get the indicator, which is used to specify the style of the indicator

Returns:

Indicator

getToolTips

public ToolTips getToolTips()

Retrieves the tooltip component, in order to set the font format in the tooltip. Only works for Flash image format.

Returns:

The tooltip component.

getThreshold

public Threshold getThreshold()

Get the threshold, which is used to specify the style of the threshold

Returns:

Threshold

getTopLabel

public TopLabel getTopLabel()

getBottomLabel

public BottomLabel getBottomLabel()

getMetricLabel

public MetricLabel getMetricLabel()

getUpperLabelFrame

public UpperLabelFrame getUpperLabelFrame()

getLowerLabelFrame

public LowerLabelFrame getLowerLabelFrame()

getLegendArea

public LegendArea getLegendArea()

getLegendText

public LegendText getLegendText()

getLegendTitle

public LegendTitle getLegendTitle()

getElementA

public ElementA getElementA()

Returns:

Instance of ElementA

For internal use only. Application developers should not use this

Returns the element A component.

getElementB

public ElementB getElementB()

Returns:

Instance of ElementB

For internal use only. Application developers should not use this

Returns the element B component.

getIntersectionAB

public IntersectionAB getIntersectionAB()

Returns:

Instance of IntersectionAB

For internal use only. Application developers should not use this

Returns the IntersectionAB component.

getGaugeSetAlignment

public int getGaugeSetAlignment()

This method gets the alignment of gauges in the gauge set.

Returns:

Integer representing the alignment followed when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_ALIGNMENT_.

setGaugeSetAlignment

public void setGaugeSetAlignment(int alignment)

This method sets the alignment of gauges in the gauge set.

Parameters:

alignment - Integer representing the alignment followed when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_ALIGNMENT_.

getGaugeSetColumnCount

public int getGaugeSetColumnCount()

This method gets the number of columns used to layout the gauges in a gauge set.

Returns:

Integer representing the means by which gauges are laid out in a gauge set. Valid values are numbers greater than or equal to 1 and constants in this class starting with GAUGESET_COLUMNS_.

setGaugeSetColumnCount

public void setGaugeSetColumnCount(int columns)

This method sets the number of columns used to layout the gauges in a gauge set.

Parameters:

columns - Integer representing the means by which gauges are laid out in a gauge set. Valid values are numbers greater than or equal to 1 and constants in this class starting with GAUGESET_COLUMNS_.

getGaugeSetDirection

public int getGaugeSetDirection()

This method gets the layout direction of gauges in the gauge set.

Returns:

integer representing the direction used when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_DIRECTION_.

setGaugeSetDirection

public void setGaugeSetDirection(int direction)

This method sets the layout direction of gauges in the gauge set.

Parameters:

direction - Integer representing the direction used when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_DIRECTION_.

getAngleExtent

public int getAngleExtent()

This method gets the angular extent of the dial gauge's plotArea.

Returns:

Integer representing the angular extent of the dial gauge plotArea

setAngleExtent

public void setAngleExtent(int extent)

This method sets the angular extent of the dial gauge's plotArea.

Parameters:

extent - the angular extent of the dial gauge plotArea

getCustomShapesPath

public java.lang.String getCustomShapesPath()

This method gets the path to the Custom Shapes definition file.

Returns:

String

setCustomShapesPath

public void setCustomShapesPath(java.lang.String path)

This method sets the path to the Custom Shapes definition file.

Parameters:

path -

getVisualEffects

public int getVisualEffects()

This method gets the VisualEffects setting of the gauge. When set to VE_OFF, effects such as reflections, shadows, and bevels are not drawn.

Returns:

integer representing the level of visual effects displayed on the gauge.

setVisualEffects

public void setVisualEffects(int effects)

This method sets the VisualEffects setting of the gauge. When set to VE_OFF, effects such as reflections, shadows, and bevels are not drawn.

Parameters:

effects - representing the level of visual effects displayed on the gauge.

getCustomLayout

public int getCustomLayout()

This method gets the CustomLayout setting of the gauge.

Returns:

integer representing the custom layout selections displayed on the gauge.

setCustomLayout

public void setCustomLayout(int layout)

This method sets the CustomLayout setting of the gauge.

Parameters:

layout - representing the custom layout selections displayed on the gauge.

getAnimationOnDataChange

public int getAnimationOnDataChange()

setAnimationOnDataChange

public void setAnimationOnDataChange(int type)

getAnimationIndicators

public int getAnimationIndicators()

setAnimationIndicators

public void setAnimationIndicators(int type)

getAnimationDuration

public int getAnimationDuration()

setAnimationDuration

public void setAnimationDuration(int duration)

getAnimationOnDisplay

public int getAnimationOnDisplay()

setAnimationOnDisplay

public void setAnimationOnDisplay(int type)

getAnimationUpColor

public java.awt.Color getAnimationUpColor()

setAnimationUpColor

public void setAnimationUpColor(java.awt.Color color)

getAnimationDownColor

public java.awt.Color getAnimationDownColor()

setAnimationDownColor

public void setAnimationDownColor(java.awt.Color color)

setDVTResources

public void setDVTResources(DVTResources res)

Description copied from interface: ImageView

Specifies Wrapped RichBundle

Specified by:

setDVTResources in interface ImageView

For internal use only. Application developers should not use this

Specifies Wrapped RichBundle

convertNumberTypeToInt

public static int convertNumberTypeToInt(java.lang.String type)

For internal use only. Application developers should not use this

Converts Number Type String constants to Integer constants. This is used by get/setXML() and ADF code.

convertNumberTypeToString

public static java.lang.String convertNumberTypeToString(int type)

Parameters:

type - Number type identifier

For internal use only. Application developers should not use this

Converts Number Type String constants to Integer constants. This is used by get/setXML() and ADF code.

getGaugeType

public int getGaugeType()

Returns the type of gauges to be generated by this instance of the Gauge bean.

Returns:

type Integer representing the type of gauges to be generated by this common gauge. Valid values are constants in the GaugeType class beginning with TYPE_.

setGraphicAntialiasing

public void setGraphicAntialiasing(boolean value)

Specifies the value of GraphicAntialiasing.

Parameters:

value - true or false

isGraphicAntialiasing

public boolean isGraphicAntialiasing()

Retrieves the GraphicAntialiasing property value.

Returns:

values true or false

setTextAntialiasing

public void setTextAntialiasing(boolean value)

Specifies the value of TextAntialiasing.

Parameters:

value - Valid values are true or false

isTextAntialiasing

public boolean isTextAntialiasing()

Retrieves the TextAntialiasing property value.

Returns:

values are true or false

setGaugeType

public void setGaugeType(int type)

Sets the type of gauges to be generated by this instance of the Common Gauge.

Parameters:

type - Integer representing the type of gauges to be generated by this common gauge. Valid values are constants in the Gauge class: DIAL, STATUSMETER, and LED.

getSpecularHighlight

public int getSpecularHighlight()

Retrieves the SpecularHighlight property value.

Returns:

values are Integer constants beginning with SH_

setSpecularHighlight

public void setSpecularHighlight(int style)

Sets the specularHighlight option for a LED gauge.

Parameters:

style - Integer representing the specularHighlight option for LS_DOT style LED gauges. Valid values are constants in the GaugeAttributes class beginning with SH_.

setCustomShapesStreams

public void setCustomShapesStreams(java.io.InputStream svgStream,
                                   java.io.InputStream xmlStream)

For internal use only. Application developers should not use this

This method sets the input streams for the Custom Shapes definition files.

convertGaugeTypeToInt

public static int convertGaugeTypeToInt(java.lang.String type)

Parameters:

type - Integer representation of a gauge type

For internal use only. Application developers should not use this

Converts Gauge type String constants to Integer constants. This is used by get/setXML() and the ADF Faces Gauge tag library class.

convertGaugeTypeToString

public static java.lang.String convertGaugeTypeToString(int type)

Generates a String representation of a gauge type constant. This method takes a gauge type constant and produces a String that is appropriate to use as an attribute value when you use the BI Beans persistence service and search for gauges that have a particular gauge type.

For example:

 //pmMyFolder is the PersistenceManager for MyFolder
 BasicAttributes _attrs = new BasicAttributes();
 _attrs.put(PSRConstants.Attributes.OBJECT_TYPE, PSRConstants.GAUGE);
 _attrs.put(Gauge.GAUGE_TYPE, Gauge.convertGaugeTypeToString(Gauge.DIAL));
 

Parameters:

type - The gauge type constant that you want to convert.

Returns:

String representation of current gauge type

getLEDStyle

public int getLEDStyle()

Returns the style of LED gauge to be generated by this instance of the Gauge bean.

Returns:

style Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with LS_.

setLEDStyle

public void setLEDStyle(int style)

Sets the style of LED gauges to be generated by this instance of the Common Gauge.

Parameters:

style - Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with LS_.

getThresholdDialStyle

public int getThresholdDialStyle()

Returns the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.

Returns:

style Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with TDS_.

setThresholdDialStyle

public void setThresholdDialStyle(int style)

Sets the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.

Parameters:

style - Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with TDS_.

getLEDStyleCallback

public LEDStyleCallback getLEDStyleCallback()

Gets the callback to use when rendering custom LEDs.

Returns:

Instance of LEDStyleCallback

setLEDStyleCallback

public void setLEDStyleCallback(LEDStyleCallback callback)

Sets the callback to use when rendering custom LEDs.

Parameters:

callback - Instance of LEDStyleCallback

convertLEDStyleToInt

public static int convertLEDStyleToInt(java.lang.String style)

Generates a String representation of an LED style constant. This method takes a LED style constant and produces a String that is appropriate to use as an attribute value when you use the BI Beans persistence service and search for gauges that have a particular LED style.

For example:

 //pmMyFolder is the PersistenceManager for MyFolder
 BasicAttributes _attrs = new BasicAttributes();
 _attrs.put(PSRConstants.Attributes.OBJECT_TYPE, PSRConstants.GAUGE);
 _attrs.put(Gauge.GRAPH_TYPE, Gauge.convertGaugeTypeToString(Gauge.DIAL));
 

Parameters:

style - String representation of the LED style

Returns:

Integer representing the converted LED style

convertLEDStyleToString

public static java.lang.String convertLEDStyleToString(int style)

Generates a String representation of an LED style constant. This method takes a LED style constant and produces a String that is appropriate to use as an attribute value when you use the BI Beans persistence service and search for gauges that have a particular LED style.

Parameters:

style - String representation of the LED style

Returns:

A String for the LED style.

convertSpecularHighlightToInt

public static int convertSpecularHighlightToInt(java.lang.String style)

For internal use only. Application developers should not use this

convertSpecularHighlightToString

public static java.lang.String convertSpecularHighlightToString(int style)

For internal use only. Application developers should not use this

convertTDStyleToInt

public static int convertTDStyleToInt(java.lang.String style)

For internal use only. Application developers should not use this

convertTDStyleToString

public static java.lang.String convertTDStyleToString(int style)

For internal use only. Application developers should not use this

convertCustomLayoutToInt

public static int convertCustomLayoutToInt(java.lang.String type)

For internal use only. Application developers should not use this

convertCustomLayoutToString

public static java.lang.String convertCustomLayoutToString(int type)

For internal use only. Application developers should not use this

setDataAccess

public void setDataAccess(DataAccess dataAccess)

Overrides:

setDataAccess in class CommonDataview

setDataDirector

public void setDataDirector(DataDirector dataDirector)

Overrides:

setDataDirector in class CommonDataview

getDataSpecification

public DataSpecification getDataSpecification()

Retrieves the DataSpecification for this bean.

Returns:

The DataSpecification for this bean. If a beans data specification has not been set for this view, this method returns null.

setDataSpecification

public void setDataSpecification(DataSpecification dataSpec)

Sets the DataSpecification for this bean, assuming it is relevant to the current DataSource.

Parameters:

dataSpec - The DataSpecification for this bean.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this Gauge.

Overrides:

setLocale in class CommonDataview

Parameters:

loc - The Locale for this Gauge.

getGaugeFontXML

public boolean getGaugeFontXML(oracle.dss.util.xml.ObjectNode node,
                               java.awt.Font font,
                               java.awt.Font defFont,
                               java.awt.Color color,
                               java.awt.Color defColor)

Parameters:

node - Instance of ObjectNode on which to set properties

font - Instance of font from which to get properties

defFont - Instance of font representing the default

Returns:

True if node was modified, False otherwise

For internal use only. Application developers should not use this

Sets XML on this component.

setGaugeFontXML

public void setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node,
                            java.lang.String attrName)

Parameters:

node - Instance of BaseObjectNode containing the XML

attrName - Name of font attribute in GaugeAttributes

For internal use only. Application developers should not use this

Sets XML on this component.

setGaugeFontXML

public void setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node,
                            java.lang.String attrName,
                            java.util.HashMap map)

Parameters:

node - Instance of BaseObjectNode containing the XML

attrName - Name of font attribute in GaugeAttributes

map - Instance of HashMap

For internal use only. Application developers should not use this

Sets XML on this component, optionally setting attributes onto given map if provided.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Description copied from class: CommonDataview

Retrieves the footnote for this view.

Specified by:

getDataviewFootnote in interface DataviewCommon

Overrides:

getDataviewFootnote in class CommonDataview

Returns:

The footnote for this view.

For internal use only. Application developers should not use this

Retrieves the footnote for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Description copied from class: CommonDataview

Retrieves the subtitle for this view.

Specified by:

getDataviewSubtitle in interface DataviewCommon

Overrides:

getDataviewSubtitle in class CommonDataview

Returns:

The subtitle for this view.

For internal use only. Application developers should not use this

Retrieves the subtitle for this view.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Description copied from class: CommonDataview

Retrieves the title for this view.

Specified by:

getDataviewTitle in interface DataviewCommon

Overrides:

getDataviewTitle in class CommonDataview

Returns:

The title for this view.

For internal use only. Application developers should not use this

Retrieves the title for this view.

getGaugeComponentHandle

public ComponentHandle getGaugeComponentHandle(int objID,
                                               int row,
                                               int column)

Parameters:

column - integer representing the column of the gauge in which this component resides

row - integer representing the row of the gauge in which this component resides

objID - integer representing the ID of the component

Returns:

ComponentHandle subcomponent information in the gauge

For internal use only. Application developers should not use this

This method creates an instance of ComponentHandle with identification information for the Gauge Component

getAlternativeText

public java.lang.String getAlternativeText(ComponentHandle handle)

Specified by:

getAlternativeText in interface ImageView

For internal use only. Application developers should not use this

returns alternative text for drill related components

getDrillParameters

public int[] getDrillParameters(ComponentHandle handle)

Specified by:

getDrillParameters in interface ImageView

For internal use only. Application developers should not use this

Returns drill parameters for a given component The return value will be null if component is not drillable Otherwise, an integer array will be returned, where: index 0 - Edge parameter index 1 - Layer parameter index 2 - Slice parameter

getSelectedObject

public ComponentHandle getSelectedObject()

Returns:

Instance of DrawableObject

For internal use only. Application developers should not use this

Returns the currently selected object.

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent e)

isXMLValidated

public boolean isXMLValidated()

Indicates whether the Dataview validates XML against its DTD.

Overrides:

isXMLValidated in class CommonDataview

Returns:

true if the Dataview validates XML, false if the Dataview applies XML without validation.

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws oracle.dss.util.xml.BIIOException,
                      oracle.dss.util.xml.BISAXException,
                      oracle.dss.util.xml.BIParseException

Applies XML to this Gauge, from a String. This method reads the XML from xmlString and applies its attribute settings and/or data to this Gauge. The reset parameter determines how much of the Gauge to reset before applying XML. In general, you can:

• Apply the XML to the current Gauge without resetting anything to default values
• Reset property values only, leaving registered listeners
• Reset property values and remove any listeners that have been registered with this Gauge

Resetting returns property values in the Gauge to their defaults.

Parameters:

xmlString - The XML to apply to this Gauge.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Gauge, false if an IO exception occurs.

Throws:

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws oracle.dss.util.xml.BIIOException,
                       oracle.dss.util.xml.BISAXException,
                       oracle.dss.util.xml.BIParseException

Applies XML to this Gauge, from an instance of InputStream. This method reads the XML from stream and applies its attribute settings to this Gauge. The reset parameter determines how much of the Gauge to reset before applying XML. In general, you can:

• Apply the XML to the current Gauge without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Gauge

Resetting returns property values in the Gauge to the default values for the version that is specified in the XML.

Parameters:

stream - The XML to apply to this Gauge.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Gauge, false if an IO exception occurs.

Throws:

oracle.dss.util.xml.BIIOException - If an error occurs in reading stream.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

selectObject

public boolean selectObject(java.awt.event.MouseEvent e)

Parameters:

e - Instance of MouseEvent

Returns:

True if the click successfully selected an object, False

For internal use only. Application developers should not use this

Processes a selection event via mouse click

setSelectedObject

public boolean setSelectedObject(int compID,
                                 int row,
                                 int column)

Selects the components of the given type in the gauge identified by the given row and column. When row and column are -1, all components of the given type in all gauges are selected.

Parameters:

column - Integer representing the column

row - Integer representing the row

compID - Type of component to select. Valid values are constants beginning with ID_ in the Gauge class.

Returns:

True if the object(s) were selected, False if the object(s) couldn't be selected

setGridData

public boolean setGridData(java.lang.Object[] specs,
                           java.lang.Object[] columnLabels,
                           java.lang.Object[] rowLabels,
                           java.lang.Object[][] data)

Parameters:

specs - Array of Objects indicating the order in which the data appears in the columnLabels parameter. Each object should be one of the constants in the GaugeAttributes class.

columnLabels - labels for the columns of data; typically Strings

rowLabels - labels for the rows of data; typically Strings

data - values to be plotted in the graph, indexed first by column, then by row; typically Doubles and Date in case of TimeSeries graphs

Returns:

true if data is successfully set on the graph, false otherwise

For internal use only. Application developers should not use this

Set data on the Graph. Data is provided in grid form, where the number of rows and columns are known ahead of time.

setTabularData

public boolean setTabularData(java.lang.Object[] specs,
                              java.util.List tableRows)

Specifies data for the GaugeBean, from a list of arrays. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

The data specification parameter should be an array of Objects, mapping how the data values are organized in the data list. Valid values in this array can be taken from one of the valid constants in GaugeAttributes that refer to data-related components in a gauge, such as METRIC, MINIMUM, MAXIMUM, and THRESHOLD. You can also append an index to the THRESHOLD keyword in case you need to include columns in a different order, i.e. THRESHOLD1. Column labels, displayed at the top of a gauge, and row labels, displayed at the bottom of a gauge, are always positioned as the first and second elements of each row but are not included in the tableRows argument.

The list of arrays containing data must conform to the specification outlined in the specs parameter. The number of entries in the list should equal the number of gauges to display.

The following table shows a set of data to pass to the gauge bean through this method:

	All Channels
	Sales	Quota	Target
Boston	12	11	13
Chicago	14	14	17
Phoenix	8	10	12
New York	21	16	20

The specification array would look like this if you wanted the column labels to appear at the top of each gauge and the row labels to appear at the bottom of each gauge, and you didn't specify min or max values:

 Object[] specs = {DataSpecification.METRIC, 
                   DataSpecification.THRESHOLD, 
                   DataSpecification.THRESHOLD 
                  }; 
 

This would tell the Gauge bean to expect the metric and 2 threshold values in the first three elements of each row array element. Given this specification, the data list for the data above would look something like this:

 
 String[] colLabels = new String[] { "Sales", "Quota", "Target" };
 String[] rowLabels = new String[] { "Boston", "Chicago", "Phoenix", "New York" };
 double[][] values = new double[][] { {12, 14, 8, 21}, {11, 14, 10, 16}, {13, 17, 12, 20} };
 
 // add the arrays to a List
 List gaugeData = new ArrayList();
 for (int c = 0; c < colLabels.length; c++) {
     for (int r = 0; r < rowLabels.length; r++) {
         gaugeData.add(new Object[] { colLabels[c], rowLabels[r], 
                                 new Double(values[c][r]) });
     }
 }

 // pass the List to this method
 gaugeBean.setTabularData(specs, gaugeData);
 

The tabular data provided above would result in a gauge set with four gauges running vertically to best match the layout of the original grid.

Parameters:

specs - Array of Objects indicating the order in which the data appears in the tableRows parameter. Each object should be one of the constants in the GaugeAttributes class.

tableRows - List of data to plot in the gauge bean.

Returns:

true if data is successfully set on the gauge bean, false if there is a data problem.

exportToPNG

public void exportToPNG(java.io.OutputStream os)

Exports a snapshot of the gauge set to the PNG file.

Specified by:

exportToPNG in interface ImageView

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

See Also:

exportToPNGWithException(java.io.OutputStream)

exportToPNGWithException

public void exportToPNGWithException(java.io.OutputStream os)
                              throws oracle.dss.graph.pfj.png.PNGInvalidParameterException,
                                     oracle.dss.graph.pfj.png.PNGException

Exports a snapshot of the gauge set to the PNG file.

Specified by:

exportToPNGWithException in interface ImageView

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

Throws:

oracle.dss.graph.pfj.png.PNGInvalidParameterException

oracle.dss.graph.pfj.png.PNGException

See Also:

exportToPNG(java.io.OutputStream)

setSVGWriterProvider

public void setSVGWriterProvider(SVGWriterProvider provider)

Specified by:

setSVGWriterProvider in interface ImageView

Parameters:

provider - Instance of SVGWriterProvider used to create an SVGWriter instance

For internal use only. Application developers should not use this

Set the provider used to create an SVG writer for exporting to SVG.

getSVGWriterProvider

public SVGWriterProvider getSVGWriterProvider()

Specified by:

getSVGWriterProvider in interface ImageView

Returns:

Instance of SVGWriterProvider used to create an SVGWriter instance

For internal use only. Application developers should not use this

Get the provider used to create an SVG writer for exporting to SVG.

setSvgHeaders

public void setSvgHeaders(int headers)

Set whether headers are included in exported SVG. Valid constants are defined in GraphConstants and begin with SVG_HEADERS_. The default value is SVG_HEADERS_ALL.

Specified by:

setSvgHeaders in interface ImageView

Parameters:

headers - constant indicating whether to include headers in exported SVG

getSvgHeaders

public int getSvgHeaders()

Determine whether headers are included in exported SVG.

Specified by:

getSvgHeaders in interface ImageView

Returns:

constant indicating whether to include headers in exported SVG

getSvgScriptIdList

public java.util.List getSvgScriptIdList()

Specified by:

getSvgScriptIdList in interface ImageView

Returns:

list of SVG script node ids

For internal use only. Application developers should not use this

Get the list of SVG script node ids.

exportToSVG

public void exportToSVG(java.io.OutputStream os,
                        int mode,
                        java.lang.String charEnc)

Exports a snapshot of the page that is currently displayed to the SVG file.

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToSVG in interface ImageView

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

exportToFlash

@Deprecated
public void exportToFlash(java.io.OutputStream os,
                                     boolean renderDynamic,
                                     boolean showDrawing)

Deprecated. exportToXML should be used instead

This is the main method that initiates flash rendering.It creates the SWFDocument which is the primary flash document.

Specified by:

exportToFlash in interface ImageView

Parameters:

os - the OutputStream associated with the flash file

renderDynamic - Flag indicating if the rendering is dynamic or static.

showDrawing - Only applicable for static charts and indicates if the drawing of the chart should be shown.

exportToSVGWithException

public void exportToSVGWithException(java.io.OutputStream os,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the page that is currently displayed to the SVG file.

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToSVGWithException in interface ImageView

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

exportToSVG

public void exportToSVG(java.io.Writer writer,
                        int mode,
                        java.lang.String charEnc)

Exports a snapshot of the page that is currently displayed to the SVG file.

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToSVG in interface ImageView

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

exportToSVGWithException

public void exportToSVGWithException(java.io.Writer writer,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Specified by:

exportToSVGWithException in interface ImageView

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the page that is currently displayed to the SVG file.

Before it exports to SVG, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

exportToXMLWithException

public void exportToXMLWithException(java.io.OutputStream os,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the page that is currently displayed to the XML file.

Before it exports to XML, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToXMLWithException in interface ImageView

Parameters:

os - The OutputStream to write XML to.

mode - specifies what to include in XML; currently not used

charEnc - character encoding to use for XML

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

exportToXMLWithException

public void exportToXMLWithException(java.io.Writer writer,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the page that is currently displayed to the XML file.

Before it exports to XML, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToXMLWithException in interface ImageView

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in XML; currently not used

charEnc - character encoding to use for XML

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

exportToSWFWithException

public void exportToSWFWithException(java.io.OutputStream os,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the view to a SWF file. This method first exports the view to XML, and then injects the XML into the SWF.

Before it exports to XML, this method calls the DataAccess.forceFetch method to fetch all of the data on the current logical page. Depending on the value of the ScaleFontSizeForGIF property, this method may scale font sizes in the exported file.

Specified by:

exportToSWFWithException in interface ImageView

Parameters:

os - The OutputStream to write the SWF to.

mode - specifies what to include in SWF; currently not used

charEnc - character encoding to use

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

refreshData

public void refreshData()

Specified by:

refreshData in interface ImageView

For internal use only. Application developers should not use this

Refreshes the gauge display.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Parameters:

name - String representation of the attribute name to retrieve.

Returns:

Object containing the value of the property given.

For internal use only. Application developers should not use this

This method provides a single means of retrieving attribute values of gauge components. Valid constants for the name parameter can be found in the GaugeAttributes interface. When in the user hashmap mode, this method first searches for a value from the user defined properties hashmap, then from the skinning properties hashmap.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Parameters:

name - String representation of the attribute name to set.

value - Object containing the value of the property.

For internal use only. Application developers should not use this

This method provides a single means of setting attribute values on all gauges. Valid constants for the name parameter can be found in the GaugeAttributes interface.

getGaugeCount

public int getGaugeCount()

Returns:

Number of gauges in this gauge set or NO_DATA_AVAILABLE if there is no data available in the gauge bean at this time.

For internal use only. Application developers should not use this

This method returns the number of gauges in this bean gauge set based on the data applied to the bean.

getGaugeSetAttribute

public java.lang.Object getGaugeSetAttribute(java.lang.String name)

Parameters:

name - String representation of the gauge set attribute name to retrieve.

Returns:

Object containing the value of the attribute.

For internal use only. Application developers should not use this

This method provides a single means of retrieving gauge set attribute values. Valid constants for the name parameter can be found in the CommonGauge class and begin with GS. When in the user hashmap mode, this method first searches for a value from the user defined properties hashmap, then from the skinning properties hashmap.

setGaugeSetAttribute

public void setGaugeSetAttribute(java.lang.String name,
                                 java.lang.Object value)

Parameters:

name - String representation of the gauge set attribute to set.

value - Object containing the value of the attribute.

For internal use only. Application developers should not use this

This method provides a single means of setting gauge set attributes. Valid constants for the name parameter can be found in the CommonGauge class and begin with GS.

getMode

public int getMode()

Returns:

int The current HashMap mode

For internal use only. Application developers should not use this

setMode

public void setMode(int mode)

Parameters:

mode - int constant representing the HashMap to operate upon. Valid constants begin with MODE_

For internal use only. Application developers should not use this

This method determines which HashMap the getAttribute and setAttribute methods operate upon.

getOptimalGaugeSize

public java.awt.Dimension getOptimalGaugeSize(java.awt.Dimension maxSize)

This method uses the current attributes set on this gauge bean to determine the minimal size a gauge should be in this gauge set. The return value can be used to optimize the space allocated to the Graphics object supplied to the render method.

The size returned from this method is used when exporting the gauge set to a PNG image with the exportToPNG method.

Parameters:

maxSize - Dimensions to use in determining optimal gauge size.

Returns:

Instance of Dimension containing the size of the largest gauge in this gauge set.

See Also:

exportToPNG(java.io.OutputStream)

getImageSize

public java.awt.Dimension getImageSize()

This method gets the size of the gauge set. This size is used when exporting the gauge set to a PNG image with the exportToPNG method.

Specified by:

getImageSize in interface ImageView

Returns:

Dimension Instance of Dimension containing the size of this gauge set.

setImageSize

public void setImageSize(java.awt.Dimension size)

This method sets the size of the gauge set. This size is used when exporting the gauge set to a PNG image with the exportToPNG method.

Specified by:

setImageSize in interface ImageView

Parameters:

size - Instance of Dimension containing the size of this gauge set.

getRowCount

public int getRowCount()

For internal use only. Application developers should not use this

Returns the number of rows as obtained from the dataSource

getColCount

public int getColCount()

For internal use only. Application developers should not use this

Returns the number of columns as obtained from the datatSource

getFlashGaugeLCID

public java.lang.String getFlashGaugeLCID()

For internal use only. Application developers should not use this

setFlashGaugeLCID

public void setFlashGaugeLCID(java.lang.String id)

For internal use only. Application developers should not use this

getRowLabel

public java.lang.String getRowLabel(int row)

For internal use only. Application developers should not use this

Gets the label for the specified row

getColumnLabel

public java.lang.String getColumnLabel(int col)

For internal use only. Application developers should not use this

Gets the label for the specified row

prepareGaugeEngines

protected boolean prepareGaugeEngines()

Returns:

True if the gauge components could be prepared successfully, False if they could not.

For internal use only. Application developers should not use this

This method triggers the preparation of all components in all of the gauges in this gauge set.

renderGauges

public boolean renderGauges(java.awt.Graphics2D g)

This method renders the gauges in this gauge set onto the given instance of Graphics.

Parameters:

g - Instance of Graphics to use

Returns:

True if the gauge components rendered successfully, False if they could not.

renderGauges

public boolean renderGauges(GaugeSVGWriter writer,
                            int mode)

Parameters:

mode - Integer controlling the content of the SVG

writer - Instance of GaugeSVGWriter to use

Returns:

True if the gauge components rendered successfully, False if they could not.

For internal use only. Application developers should not use this

This method renders the gauges in this gauge set onto the given instance of GaugeSVGWriter.

renderGauges

public boolean renderGauges(GaugeExportXMLWriter writer,
                            int mode)

Parameters:

mode - Integer controlling the content of the XML

writer - Instance of GaugeSVGWriter to use

Returns:

True if the gauge components rendered successfully, False if they could not.

For internal use only. Application developers should not use this

This method renders the gauges in this gauge set onto the given instance of GaugeExportXMLWriter.

renderLegend

public void renderLegend(GaugeRenderer renderer,
                         java.awt.Graphics2D g2d,
                         java.awt.Rectangle outerBounds)

For internal use only. Application developers should not use this

renderLegendArea

protected java.awt.geom.Rectangle2D renderLegendArea(GaugeRenderer renderer,
                                                     java.awt.Graphics2D g2d,
                                                     java.awt.Rectangle outerBounds)

renderLegendTitle

protected void renderLegendTitle(GaugeRenderer renderer,
                                 java.awt.Graphics2D g2d,
                                 java.awt.geom.Rectangle2D legendFrame)

renderLegendItems

protected void renderLegendItems(GaugeRenderer renderer,
                                 java.awt.Graphics2D g2d,
                                 java.awt.geom.Rectangle2D legendFrame)

createSVGWriter

protected GaugeSVGWriter createSVGWriter(java.io.OutputStream os,
                                         java.lang.String charEnc)

Parameters:

os - OutputStream to write to

charEnc - character encoding

Returns:

GaugeSVGWriter to use to export to SVG

For internal use only. Application developers should not use this

Create the SVG writer used to export to SVG. Subclasses can override this method to create subclasses of the GaugeSVGWriter.

createSVGWriter

protected GaugeSVGWriter createSVGWriter(java.io.Writer writer,
                                         java.lang.String charEnc)

Parameters:

writer - Writer to write to

charEnc - character encoding

Returns:

GaugeSVGWriter to use to export to SVG

For internal use only. Application developers should not use this

Create the SVG writer used to export to SVG. Subclasses can override this method to create subclasses of the GaugeSVGWriter.

createExportXMLWriter

protected GaugeExportXMLWriter createExportXMLWriter(java.io.OutputStream os,
                                                     java.lang.String charEnc)

Parameters:

os - OutputStream to write to

charEnc - character encoding

Returns:

GaugeExportXMLWriter to use to export to XML

For internal use only. Application developers should not use this

Create the XML writer used to export to XML. Subclasses can override this method to create subclasses of the GaugeExportXMLWriter.

createExportXMLWriter

protected GaugeExportXMLWriter createExportXMLWriter(java.io.Writer writer,
                                                     java.lang.String charEnc)

Parameters:

writer - Writer to write to

charEnc - character encoding

Returns:

GaugeExportXMLWriter to use to export to XML

For internal use only. Application developers should not use this

Create the XML writer used to export to XML. Subclasses can override this method to create subclasses of the GaugeExportXMLWriter.

getImagemapEnumeration

public java.util.Enumeration getImagemapEnumeration(int filter)

Retrieves the enumeration of specific kinds of components that are currently in use and visible on the gauge. The enumeration provides an ImagemapComponent object for each gauge object. Each ImagemapComponent object contains the ComponentHandle and the Polygon for that gauge component. The ComponentHandle contains information about the component, and the Polygon contains information about the component's position on the gauge.

Specified by:

getImagemapEnumeration in interface ImageView

Parameters:

filter - One or more bitwise values specifying the kinds of gauge components to enumerate. Valid values are constants in this class beginning with MAP_.

Returns:

Enumeration of the specified kinds of gauge components.

See Also:

DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_TITLES, ImagemapComponent

writeImagemapXML

public void writeImagemapXML(java.io.OutputStream os,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph. The kinds of information that this method writes are the series (if applicable), the group (if applicable) and the placement of the component or components. The constants for filter are defined in this class and begin with MAP_.

Parameters:

os - The output stream where XML will be written.

filter - The kinds of graph components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_DATATEXT, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_LEGEND, DataviewConstants.MAP_ORDINALLABELS, DataviewConstants.MAP_TITLES

writeImagemapXML

public void writeImagemapXML(java.io.PrintWriter out,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the graph. The kinds of information that this method writes are the series (if applicable), the group (if applicable) and the placement of the component or components. The constants for filter are defined in this class and begin with MAP_.

Parameters:

out - The print writer where XML will be written.

filter - The kinds of graph components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_DATATEXT, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_LEGEND, DataviewConstants.MAP_ORDINALLABELS, DataviewConstants.MAP_TITLES

writeXML

public void writeXML(java.io.OutputStream stream,
                     boolean allProperties)

Writes XML for this Dataview to an output stream. The XML can include values for all of the properties in the Dataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

stream - The output stream to which to write the XML.

allProperties - true to write out XML for all properties, false to write out XML only for properties whose values are different from the default property values.

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether this Gauge validates XML against its DTD. By default, the table does not validate the XML. If there is a parsing error in the XML, then the Dataview ignores the badly formed XML. If you want readXML and setXML to throw a BIParseException if they encounter XML that cannot be parsed, then pass true to this method.

Overrides:

setXMLValidated in class CommonDataview

Parameters:

validate - true to have XML validated, false to have the Dataview ignore invalid XML.

See Also:

setXML(java.lang.String, int)

resetToDefault

protected void resetToDefault(int reset,
                              java.lang.String version)

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

version - the Gauge XML version number, as stored in XML

For internal use only. Application developers should not use this

Reset the properties of the Gauge to their default values for the specified Gauge XML version. If the version is invalid, then default values for the latest Gauge XML version are used.

setMetadataLabelFlag

public void setMetadataLabelFlag(boolean metadataFlag)

For internal use only. Application developers should not use this

Sets the metadataFlag to true

setLayerMetaLongLabelSupported

public void setLayerMetaLongLabelSupported(boolean supported)

Overrides:

setLayerMetaLongLabelSupported in class CommonDataview

For internal use only. Application developers should not use this

set the flag for LAYER_METADATA_LONGLABEL type true or false

setMetadataDrillSupported

public void setMetadataDrillSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILLSTATE type true or false

isMetadataDrillSupported

protected boolean isMetadataDrillSupported()

Returns:

true if METADATA_DRILLSTATE is supported, else false

For internal use only. Application developers should not use this

setMetadataDrillParentDateSupported

public void setMetadataDrillParentDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

isMetadataDrillParentDateSupported

protected boolean isMetadataDrillParentDateSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

setMetadataDrillParentDateSpanSupported

public void setMetadataDrillParentDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

isMetadataDrillParentDateSpanSupported

protected boolean isMetadataDrillParentDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

setMetadataDateSpanSupported

public void setMetadataDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

isMetadataDateSpanSupported

protected boolean isMetadataDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

createLocalGridDataSource

protected LocalXMLDataSource createLocalGridDataSource(oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Create a LocalXMLDataSource based on data contained in the XML LocalGridData element.

createLocalRelationalDataSource

protected LocalXMLDataSource createLocalRelationalDataSource(oracle.dss.util.xml.ContainerNode node)

For internal use only. Application developers should not use this

Create a LocalXMLDataSource based on data contained in the XML LocalRelationalData element.

fillLinkArrays

protected void fillLinkArrays(int colCount,
                              int rowCount,
                              java.lang.Object[] colLabels,
                              java.lang.Object[] rowLabels,
                              java.util.Hashtable dataValLinks)

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName,
                                                       boolean allProperties,
                                                       java.lang.String version)

Overrides:

getObjectNode in class CommonDataview

For internal use only. Application developers should not use this

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)

For internal use only. Application developers should not use this

getViewXML

protected DataviewXML getViewXML()

Overrides:

getViewXML in class CommonDataview

For internal use only. Application developers should not use this

setXML

protected void setXML(oracle.dss.util.xml.ObjectNode node,
                      int reset)

For internal use only. Application developers should not use this

Called by public version of setXML to apply an ObjectNode containing XML to this Gauge instance.

setStylePath

public void setStylePath(java.lang.String stylePath)
                  throws java.io.IOException,
                         oracle.dss.util.xml.BIIOException,
                         oracle.dss.util.xml.BISAXException,
                         oracle.dss.util.xml.BIParseException

Specified by:

setStylePath in interface ImageView

Parameters:

stylePath - The path of the XML to set as a style on this gauge.

Throws:

java.io.IOException - If there is a problem loading the specified XML file.

oracle.dss.util.xml.BIIOException - If there is a problem reading the XML file.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is incorrect, or if the XML is not valid according to the DTD that is specified in the XML.

For internal use only. Application developers should not use this

Applies a style to this gauge based on the specified XML file. This method also sets the StylePath property.

Gauge uses the getResourceAsStream method of its ClassLoader to look for the style XML file. The search order is described in the documentation for java.lang.ClassLoader.

The standard styles are packaged in bipres.jar under /oracle/dss/gauge/styles/.

processAlertEvent

protected void processAlertEvent(int eventID)

Parameters:

eventID - id associated with that event

For internal use only. Application developers should not use this

Process the Alert events

getAlertListenerList

protected javax.swing.event.EventListenerList getAlertListenerList()

For internal use only. Application developers should not use this

setAlertListenerList

protected void setAlertListenerList(javax.swing.event.EventListenerList list)

For internal use only. Application developers should not use this

convertTickContentToInt

public static int convertTickContentToInt(java.lang.String contentStr)

Parameters:

contentStr - String-based representation of tick content property

Returns:

Tick content property value

For internal use only. Application developers should not use this

Converts a tick content property from its string representation to an integer value. Valid for TICKLABEL_CONTENT and TICKMARKS_DISPLAYED properties.

convertTickContentToString

public static java.lang.String convertTickContentToString(int content)

Converts a tick content property to its string representation. Valid for TICKLABEL_CONTENT and TICKMARKS_DISPLAYED properties.

Parameters:

content - Tick content property value

Returns:

String-based representation of tick content property

convertGaugeSetAlignmentToInt

public static int convertGaugeSetAlignmentToInt(java.lang.String align)

Parameters:

align - String-based representation of gaugeset alignment property

Returns:

Gaugeset alignment property value

For internal use only. Application developers should not use this

Converts a gauge set alignment constant from its string representation to an integer value

convertGaugeSetAlignmentToString

public static java.lang.String convertGaugeSetAlignmentToString(int align)

Parameters:

align - Gaugeset alignment property value

Returns:

String-based representation of gaugeset alignment property

For internal use only. Application developers should not use this

Converts a gauge set alignment constant to its string representation.

convertGaugeSetColCountToInt

public static int convertGaugeSetColCountToInt(java.lang.String colCount)

Parameters:

colCount - String-based representation of gaugeset column count property

Returns:

Gaugeset column count property value

For internal use only. Application developers should not use this

Converts a gauge set column count constant from its string representation to an integer value

convertGaugeSetColCountToString

public static java.lang.String convertGaugeSetColCountToString(int colCount)

Parameters:

colCount - Gaugeset column count property value

Returns:

String-based representation of gaugeset column count property

For internal use only. Application developers should not use this

Converts a gauge set column count constant to its string representation.

convertGaugeSetDirectionToInt

public static int convertGaugeSetDirectionToInt(java.lang.String value)

Parameters:

value - String-based representation of gaugeset direction property

Returns:

Gaugeset direction property value

For internal use only. Application developers should not use this

Converts a gauge set direction constant from its string representation to an integer value

convertGaugeSetDirectionToString

public static java.lang.String convertGaugeSetDirectionToString(int value)

Parameters:

value - Gaugeset direction property value

Returns:

String-based representation of gaugeset direction property

For internal use only. Application developers should not use this

Converts a gauge set direction constant to its string representation.

getRecalcState

public int getRecalcState()

Returns the current scope of work needed during a recalculation of gauge layout. Internal use only.

Returns:

State of recalc needed; valid values are constants in this class beginning with RECALC_STATE_.

For internal use only. Application developers should not use this

setRecalcState

public void setRecalcState(int state)

Parameters:

state -

For internal use only. Application developers should not use this

setRecalcState

public void setRecalcState(int state,
                           boolean clear)

Parameters:

state -

clear - true to clear the current value

For internal use only. Application developers should not use this

getIntlString

public java.lang.String getIntlString(java.lang.String key,
                                      java.util.ResourceBundle rBundle)

Specified by:

getIntlString in interface DataviewCommon

Overrides:

getIntlString in class CommonDataview

Parameters:

key -

rBundle -

Returns:

For internal use only. Application developers should not use this

getErrorIntlString

public java.lang.String getErrorIntlString(java.lang.String key,
                                           java.util.ResourceBundle rBundle)

Get the error messages from jclient bundle. Error messages are not skinnable.

For internal use only. Application developers should not use this

updateResourceBundle

protected void updateResourceBundle()

Overrides:

updateResourceBundle in class CommonDataview

getGaugeResourceBundle

protected static java.util.ResourceBundle getGaugeResourceBundle(java.util.Locale loc)
                                                          throws java.util.MissingResourceException

Throws:

java.util.MissingResourceException

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws oracle.dss.util.persistence.BIPersistenceException

Specified by:

setXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, int), setXML(java.lang.String, int)

For internal use only. Application developers should not use this

Specifies the XML representation of this Graph. The persistence service calls this method when the view is restored from the BI Beans Catalog. This method does not reset any properties before applying the XML to this Graph.

Application developers should not call this method. To load XML from a file, call setXML or readXML.

setXML

public void setXML(java.lang.String xml,
                   java.util.HashMap map)

For internal use only. Application developers should not use this

This method is called from adf faces UIGauge.

getXMLAsString

public java.lang.String getXMLAsString()

Retrieves the XML representation of this Dataview. This method is called by the persistence service when you save the Dataview to the BI Beans Catalog.

This method calls getXML(false), so the XML that is stored in the Catalog has only property values that are different from the default values.

Application developers should not call this method. To create a file that has the XML for this Dataview, call the writeXML method or the getXML method.

Specified by:

getXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this Dataview.

See Also:

CommonDataview.getXML(java.lang.String, boolean), writeXML(java.io.OutputStream, boolean)

initialize

public void initialize(java.util.Hashtable env)

Specified by:

initialize in interface oracle.dss.util.persistence.SimplePersistable

For internal use only. Application developers should not use this

setContext

public void setContext()

For internal use only. Application developers should not use this

set the context

getPersistableAttributes

public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)

Specified by:

getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

oldAttrs - a PersistableAttributes value that represents the searchable attributes set by the user application.

Returns:

PersistableAttributes which represent the searchable properties of the graph (the ones passed into the method augmented by graph-specific properties).

For internal use only. Application developers should not use this

Reterun a structure consisting of PeristableAttibutes (i.e. search attributes associated with this graph) which are used for searching for this graph in the database.

getPersistableComponents

public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()

Description copied from class: CommonDataview

Retrieves the persistable components that this Dataview aggregates. Dataview objects aggregate the data source that defines the data that view displays.

The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Specified by:

getPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Overrides:

getPersistableComponents in class CommonDataview

Returns:

AggregateInfo[] which represents the components associated with the graph.

For internal use only. Application developers should not use this

Retrieves the persistable components that this graph aggregates. These aggregates will be

setPersistableComponents

public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)

Specified by:

setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Overrides:

setPersistableComponents in class CommonDataview

Parameters:

persistables - a AggregateInfo[] value that represents the components to assign to the graph.

For internal use only. Application developers should not use this

Specifies the components associated with the graph

createPropertyOverrideFlags

protected void createPropertyOverrideFlags()

For internal use only. Application developers should not use this

Create Overridden flags

clearOverrideFlags

public void clearOverrideFlags()

For internal use only. Application developers should not use this

Clear properties override flags

createPropertyOverrideFlags

public java.util.BitSet createPropertyOverrideFlags(int maxID)

Specified by:

createPropertyOverrideFlags in interface DataviewCommon

Overrides:

createPropertyOverrideFlags in class CommonDataview

For internal use only. Application developers should not use this

create a property overridden flags

clearPropertyOverrideFlag

public void clearPropertyOverrideFlag(int attrID,
                                      java.util.BitSet overrideFlags)

Overrides:

clearPropertyOverrideFlag in class CommonDataview

For internal use only. Application developers should not use this

clear a property's override flag

setPropertyOverrideFlags

protected void setPropertyOverrideFlags(int attrID)

For internal use only. Application developers should not use this

set a property is overridden

isStyleOverrideFlag

protected boolean isStyleOverrideFlag(int attrID)

For internal use only. Application developers should not use this

isUserOverrideFlag

protected boolean isUserOverrideFlag(int attrID)

For internal use only. Application developers should not use this

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Add a PropertyChangeListener to this CommonGauge instance

Parameters:

l - reference to a PropertyChangeListenerr

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Remove ViewFocusListener from presentation engine.

Parameters:

l - reference to a ViewFocusListener

firePropertyChange

protected void firePropertyChange(java.lang.Object obj,
                                  java.lang.String propName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Parameters:

obj - the Object which has the getter/setter for this property

propName - String: the name of the property (minus get/set)

oldValue - Object: the previous value of the property

newValue - Object: the new value of the property

For internal use only. Application developers should not use this

Handle a property change for the entire bean.