|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.dataView.CommonDataview
oracle.dss.gauge.CommonGauge
public class CommonGauge
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.DefaultAttributeFormatter, 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_across |
static java.lang.String |
a_angleExtent |
static java.lang.String |
a_arrow String representation used to indicate arrow-style LED gauges in XML. |
static java.lang.String |
a_aTopLabel |
static java.lang.String |
a_aValue |
static java.lang.String |
a_bBottomLabel |
static java.lang.String |
a_bottom |
static java.lang.String |
a_bottomLeft |
static java.lang.String |
a_bottomRight |
static java.lang.String |
a_bTopLabel |
static java.lang.String |
a_bValue |
static java.lang.String |
a_center |
static java.lang.String |
a_content |
static java.lang.String |
a_custom String representation used to indicate custom-style LED gauges in XML. |
static java.lang.String |
a_customLayout |
static java.lang.String |
a_dial |
static java.lang.String |
a_dot String representation used to indicate dot-style LED gauges in XML. |
static java.lang.String |
a_down |
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_increments |
static java.lang.String |
a_indicatorBarFillColor |
static java.lang.String |
a_indicatorType |
static java.lang.String |
a_kpi String representation used to indicate KPI-style LED gauges in XML. |
static java.lang.String |
a_labelGauge |
static java.lang.String |
a_led |
static java.lang.String |
a_ledStyle |
static java.lang.String |
a_left |
static java.lang.String |
a_majorIncrement |
static java.lang.String |
a_majorTick |
static java.lang.String |
a_majorTickColor |
static java.lang.String |
a_majorTickCount |
static java.lang.String |
a_metric |
static java.lang.String |
a_minLength |
static java.lang.String |
a_minMax |
static java.lang.String |
a_minorIncrement |
static java.lang.String |
a_minorTickColor |
static java.lang.String |
a_minorTickCount |
static java.lang.String |
a_none |
static java.lang.String |
a_number |
static java.lang.String |
a_numberType |
static java.lang.String |
a_outerFrame |
static java.lang.String |
a_percent |
static java.lang.String |
a_pieFill |
static java.lang.String |
a_rectangle String representation used to indicate rectangular LED gauges in XML. |
static java.lang.String |
a_right |
static java.lang.String |
a_ringFill |
static java.lang.String |
a_segments |
static java.lang.String |
a_specularHighlight |
static java.lang.String |
a_square String representation used to indicate custom-style LED gauges in XML. |
static java.lang.String |
a_statusMeter |
static java.lang.String |
a_tdMaxValue |
static java.lang.String |
a_tdStyle |
static java.lang.String |
a_threshold |
static java.lang.String |
a_thresholdColor |
static java.lang.String |
a_thresholdMaxValue |
static java.lang.String |
a_titleSeparator |
static java.lang.String |
a_top |
static java.lang.String |
a_topLeft |
static java.lang.String |
a_topRight |
static java.lang.String |
a_triangle String representation used to indicate triangle-style LED gauges in XML. |
static java.lang.String |
a_useThresholdFillColor |
static java.lang.String |
a_venn |
static java.lang.String |
a_verticalStatusMeter |
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_INDEX Used in creating data maps to determine gauge position in a flat list of a grid of gauges. |
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 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.OutputStream os, int mode, java.lang.String charEnc, java.lang.String id) 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 |
exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc, java.lang.String id) 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.OutputStream os, int mode, java.lang.String charEnc, java.lang.String id) 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 |
exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc, java.lang.String id) |
void |
exportToSWFWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Deprecated. use the BI Publisher Flash Processor directly |
void |
exportToSWFWithException(java.lang.String swfPath, java.io.OutputStream os, int mode, java.lang.String charEnc) Deprecated. use the BI Publisher Flash Processor directly |
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() Deprecated. |
int |
getAnimationDuration() Returns the duration of gauge animations, in milliseconds. |
int |
getAnimationIndicators() Deprecated. |
int |
getAnimationOnDataChange() Returns the type of animation that will be performed on data change. |
int |
getAnimationOnDisplay() Returns the type of animation that will be performed on initial display. |
java.awt.Color |
getAnimationUpColor() Deprecated. |
java.lang.Object |
getAttribute(java.lang.String name) |
BottomLabel |
getBottomLabel() Returns the BottomLabel component, which is used to specify the text and properties for the bottom label of the gauge. |
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. |
CustomToolTipCallback |
getCustomToolTipCallback() Retrieves the CustomToolTipCallback that this Gauge uses to get text for tooltips. |
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() Returns the GaugeBackground component, which is used to specify the properties for the background of the gauge. |
ComponentHandle |
getGaugeComponentHandle(int objID, int row, int column) |
ComponentHandle |
getGaugeComponentHandle(int objID, int index, 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() Returns the GaugeFrame component, which is used to specify the properties for the frame that surrounds the dial gauge. |
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() Returns the GaugeSetBackground component, which is used to specify the properties for the background of the gauge set. |
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() Returns the GaugeSetTitle component, which is used to specify the properties and text for the gauge set title. |
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() Returns the Indicator component, which is used to specify the properties for the dial and led gauge indicators. |
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() Returns the LegendArea component, which is used to specify the appearance of the legend. |
LegendText |
getLegendText() Returns the LegendText component, which is used to specify the appearance of the legend text. |
LegendTitle |
getLegendTitle() Returns the LegendTitle component, which is used to specify the text and appearance of the legend title. |
LowerLabelFrame |
getLowerLabelFrame() Returns the LowerLabelFrame component, which is used to specify the appearance of the frame that contains the bottom label. |
MetricLabel |
getMetricLabel() Returns the MetricLabel component, which is used to specify the text and properties for the metric label of the gauge. |
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() Returns the PlotArea component, which is used to specify the properties for the plot area of the gauge. |
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() Returns the Threshold component, which is used to specify the properties for the gauge thresholds. |
int |
getThresholdDialStyle() Returns the style of Threshold Dial gauge to be generated by this instance of the Gauge bean. |
TickLabel |
getTickLabel() Returns the TickLabel component, which is used to specify the properties for the tick labels on dial and statusmeter gauges. |
TickMark |
getTickMark() Returns the TickMark component, which is used to specify the properties for the tick marks on dial and statusmeter gauges. |
ToolTips |
getToolTips() Returns the ToolTips component, which is used to specify the formatting for the gauge tooltips. |
java.lang.String |
getToolTipText(java.awt.event.MouseEvent e) |
TopLabel |
getTopLabel() Returns the TopLabel component, which is used to specify the text and properties for the top label of the gauge. |
UpperLabelFrame |
getUpperLabelFrame() Returns the UpperLabelFrame component, which is used to specify the appearance of the frame that contains the top label. |
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 . |
GaugeXMLWriterCallback |
getXMLWriterCallback() Specifies a callback used for providing additional information while rendering Flash XML content. |
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) Deprecated. |
void |
setAnimationDuration(int duration) Specifies the duration of gauge animations, in milliseconds. |
void |
setAnimationIndicators(int type) Deprecated. |
void |
setAnimationOnDataChange(int type) Specifies the type of animation that will be performed on data change. |
void |
setAnimationOnDisplay(int type) Specifies the type of animation that will be performed on initial display. |
void |
setAnimationUpColor(java.awt.Color color) Deprecated. |
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 |
setCustomToolTipCallback(CustomToolTipCallback callback) Specifies the CustomToolTipCallback that will provide tooltip text to this Gauge . |
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) Specifies 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) Specifies the metric value for the gauge. |
void |
setMetricValues(java.util.List<java.lang.Double> data) Specifies multiple metric values of the gauge using a list, displaying multiple indicators in a gauge |
void |
setMinValue(double value) Specifies 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) Specifies 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. |
void |
setXMLWriterCallback(GaugeXMLWriterCallback callback) Returns a callback used for providing additional information while rendering Flash XML content. |
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 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.presutil.CommonViewAttributes |
---|
getDescription, getLocalName, getName, setDescription, setLocalName, setName |
Methods inherited from interface oracle.dss.rules.ComponentTypeConverter |
---|
convertComponentTypeToInteger, convertComponentTypeToString |
Methods inherited from interface oracle.dss.util.persistence.SimplePersistable |
---|
setPersistableAttributes |
Field Detail |
---|
protected static final java.lang.String DS_ROW
DataSource
.
protected static final java.lang.String DS_COLUMN
DataSource
.
protected static final java.lang.String DS_INDEX
protected static final java.lang.String m_version
protected java.util.Hashtable m_context
protected javax.swing.event.EventListenerList listenerList
protected boolean m_metaDateSupported
protected boolean m_metaDrillParentDateSupported
protected boolean m_metaDrillParentDateSpanSupported
protected boolean m_metaDateSpanSupported
protected boolean m_metaDrillSupported
public static final int RECALC_STATE_READY
public static final int RECALC_STATE_PROPERTIES
public static final int RECALC_STATE_DATA
protected static final int DEFAULT_MAP_ATTRCOUNT
protected static final int DEFAULT_MAP_GSATTRCOUNT
public static final java.lang.String NAME_GAUGE
Gauge
, Constant Field ValuesGauge
. The main gauge node..public static final java.lang.String NAME_GAUGEFRAME
GaugeFrame
, Constant Field ValuesGaugeFrame
. The frame behind the gauge.public static final java.lang.String NAME_TICKLABEL
TickLabel
, Constant Field ValuesTickLabel
. The tick label of the gauge.public static final java.lang.String NAME_TICKMARK
TickMark
, Constant Field ValuesTickMark
. The tickmark of the gauge.public static final java.lang.String NAME_TOOLTIPS
ToolTips
, Constant Field ValuesToolTips
. The tooltip of the gauge.public static final java.lang.String NAME_INDICATOR
Indicator
, Constant Field ValuesIndicator
. The indicator of the gauge.public static final java.lang.String NAME_INDICATORBAR
Indicator
, Constant Field ValuesIndicatorBar
. The indicatorBar of the statusmeter gauge.public static final java.lang.String NAME_INDICATORBASE
Indicator
, Constant Field ValuesIndicatorBase
. The indicatorBase of the dial gauge.public static final java.lang.String NAME_THRESHOLD
Threshold
, Constant Field ValuesThreshold
. The threshold of the gauge.public static final java.lang.String NAME_METRIC_VALUE
Value
. The value(s) of the gauge.public static final java.lang.String NAME_GAUGESETTITLE
GaugeSetTitle
, Constant Field ValuesGaugeSetTitle
. Title of the Gauge Set.public static final java.lang.String NAME_TOPLABEL
TopLabel
, Constant Field ValuesTopLabel
. The top label of the gauge.public static final java.lang.String NAME_BOTTOMLABEL
BottomLabel
, Constant Field ValuesBottomLabel
. The bottom label of the gauge.public static final java.lang.String NAME_PLOTAREA
BottomLabel
, Constant Field ValuesBottomLabel
. The bottom label of the gauge.public static final java.lang.String NAME_SFX
SFX
, Constant Field ValuesSFX
. An SFX definition for a component.public static final java.lang.String NAME_METRICLABEL
MetricLabel
, Constant Field ValuesMetricLabel
. The metric label of the gauge.public static final java.lang.String NAME_UPPERLABELFRAME
UpperLabelFrame
, Constant Field ValuesUpperLabelFrame
. The frame behind the upper labels of this gauge.public static final java.lang.String NAME_LOWERLABELFRAME
LowerLabelFrame
, Constant Field ValuesLowerLabelFrame
. The frame behind the lower labels of this gauge.public static final java.lang.String NAME_LEGENDAREA
LegendArea
, Constant Field ValuesLegendArea
. The Gauge legend.public static final java.lang.String NAME_LEGENDTEXT
LegendText
, Constant Field ValuesLegendText
. Text elements in the Gauge legend.public static final java.lang.String NAME_LEGENDTITLE
LegendTitle
, Constant Field ValuesLegendTitle
. Title of the Gauge legend.public static final java.lang.String NAME_VENNELEMENT
CommonDataview.getXML(java.lang.String, boolean)
, Constant Field ValuesVennElement
.public static final java.lang.String NAME_VENNDATA
CommonDataview.getXML(java.lang.String, boolean)
, Constant Field ValuesVennData
.public static final java.lang.String NAME_GAUGEFONT
CommonDataview.getXML(java.lang.String, boolean)
, Constant Field ValuesGaugeAttributes
.public static final java.lang.String NAME_GAUGESETBACKGROUND
CommonDataview.getXML(java.lang.String, boolean)
, Constant Field ValuesGaugeSetBackground
.public static final java.lang.String NAME_DATASPECIFICATION
CommonDataview.getXML(java.lang.String, boolean)
, Constant Field ValuesDataSpecification
.public static final java.lang.String a_gauge
public static final java.lang.String a_gaugeType
public static final java.lang.String a_ledStyle
public static final java.lang.String a_specularHighlight
public static final java.lang.String a_tdStyle
public static final java.lang.String a_angleExtent
public static final java.lang.String a_tdMaxValue
public static final java.lang.String a_customLayout
public static final java.lang.String a_gsalignment
public static final java.lang.String a_gscolcount
public static final java.lang.String a_gsdirection
public static final java.lang.String a_numberType
public static final java.lang.String a_minLength
public static final java.lang.String a_content
public static final java.lang.String a_majorTickCount
public static final java.lang.String a_majorTickColor
public static final java.lang.String a_minorTickCount
public static final java.lang.String a_majorIncrement
public static final java.lang.String a_minorIncrement
public static final java.lang.String a_minorTickColor
public static final java.lang.String a_indicatorType
public static final java.lang.String a_indicatorBarFillColor
public static final java.lang.String a_useThresholdFillColor
public static final java.lang.String a_thresholdColor
public static final java.lang.String a_aValue
public static final java.lang.String a_aTopLabel
public static final java.lang.String a_aBottomLabel
public static final java.lang.String a_abValue
public static final java.lang.String a_abTopLabel
public static final java.lang.String a_abBottomLabel
public static final java.lang.String a_bValue
public static final java.lang.String a_bTopLabel
public static final java.lang.String a_bBottomLabel
public static final java.lang.String DIAL_NAME
public static final java.lang.String STATUSMETER_NAME
public static final java.lang.String LED_NAME
public static final java.lang.String VENN_NAME
public static final java.lang.String VERTICALSTATUSMETER_NAME
public static final java.lang.String LABELGAUGE_NAME
public static final java.lang.String a_dial
public static final java.lang.String a_statusMeter
public static final java.lang.String a_led
public static final java.lang.String a_venn
public static final java.lang.String a_verticalStatusMeter
public static final java.lang.String a_labelGauge
public static final java.lang.String ls_dot
public static final java.lang.String ls_kpi
public static final java.lang.String ls_arrow
public static final java.lang.String ls_triangle
public static final java.lang.String ls_custom
public static final java.lang.String ls_rectangle
public static final java.lang.String ls_square
public static final java.lang.String a_dot
public static final java.lang.String a_kpi
public static final java.lang.String a_arrow
public static final java.lang.String a_triangle
public static final java.lang.String a_custom
public static final java.lang.String a_rectangle
public static final java.lang.String a_square
public static final java.lang.String tds_pie
public static final java.lang.String tds_ring
public static final java.lang.String tds_segments
public static final java.lang.String a_pieFill
public static final java.lang.String a_ringFill
public static final java.lang.String a_segments
public static final java.lang.String sh_on
public static final java.lang.String sh_off
public static final java.lang.String gsa_none
public static final java.lang.String gsa_topleft
public static final java.lang.String gsa_top
public static final java.lang.String gsa_topright
public static final java.lang.String gsa_right
public static final java.lang.String gsa_bottomright
public static final java.lang.String gsa_bottom
public static final java.lang.String gsa_bottomleft
public static final java.lang.String gsa_left
public static final java.lang.String gsa_center
public static final java.lang.String gsc_auto
public static final java.lang.String gsd_across
public static final java.lang.String gsd_down
public static final java.lang.String a_topLeft
public static final java.lang.String a_top
public static final java.lang.String a_topRight
public static final java.lang.String a_right
public static final java.lang.String a_bottomRight
public static final java.lang.String a_bottom
public static final java.lang.String a_bottomLeft
public static final java.lang.String a_left
public static final java.lang.String a_center
public static final java.lang.String a_across
public static final java.lang.String a_down
public static final java.lang.String tc_none
public static final java.lang.String tc_minmax
public static final java.lang.String tc_increments
public static final java.lang.String tc_majortick
public static final java.lang.String tc_threshold
public static final java.lang.String tc_metric
public static final java.lang.String a_none
public static final java.lang.String a_minMax
public static final java.lang.String a_increments
public static final java.lang.String a_majorTick
public static final java.lang.String a_threshold
public static final java.lang.String a_metric
public static final java.lang.String nt_number
public static final java.lang.String nt_percent
public static final java.lang.String a_number
public static final java.lang.String a_percent
public static final java.lang.String dst_metric
public static final java.lang.String dst_minimum
public static final java.lang.String dst_maximum
public static final java.lang.String dst_threshold
public static final java.lang.String dst_toplabel
public static final java.lang.String dst_bottomlabel
public static final java.lang.String veid_a
public static final java.lang.String veid_b
public static final java.lang.String veid_ab
public static final java.lang.String a_thresholdMaxValue
public static final java.lang.String cl_none
public static final java.lang.String cl_title_separator
public static final java.lang.String cl_outer_frame
public static final java.lang.String a_titleSeparator
public static final java.lang.String a_outerFrame
public static final int MODE_USER
public static final int MODE_SKIN
public static final java.lang.String METRIC_ROW
public static final java.lang.String METRIC_COLUMN
protected static final int ATTR_STYLE_MAXID
protected static int MARKER_TEXT_GAP
protected static int MARKER_DIAMETER
protected static int LEGEND_ITEM_GAP
public static final java.lang.String ADA_SCREEN_READER_MODE
Constructor Detail |
---|
public CommonGauge()
public CommonGauge(java.util.Locale locale, ThickGauge gauge)
Method Detail |
---|
public GaugeSetBackground getGaugeSetBackground()
GaugeSetBackground
component, which is used to specify the properties for the background of the gauge set.public GaugeSetTitle getGaugeSetTitle()
GaugeSetTitle
component, which is used to specify the properties and text for the gauge set title.public GaugeBackground getGaugeBackground()
GaugeBackground
component, which is used to specify the properties for the background of the gauge.public GaugeFrame getGaugeFrame()
GaugeFrame
component, which is used to specify the properties for the frame that surrounds the dial gauge.public PlotArea getPlotArea()
PlotArea
component, which is used to specify the properties for the plot area of the gauge.public TickLabel getTickLabel()
TickLabel
component, which is used to specify the properties for the tick labels on dial and statusmeter gauges.public TickMark getTickMark()
TickMark
component, which is used to specify the properties for the tick marks on dial and statusmeter gauges.public void setMetricValue(double value)
public void setMetricValues(java.util.List<java.lang.Double> data)
data
- A list of metric values to put in the gaugepublic void setThresholdValues(java.util.List<java.lang.Double> data)
data
- A list of threshold values to put in the gaugepublic void setMinValue(double value)
value
- Min value of the gaugepublic void setMaxValue(double value)
value
- Max value of the gaugepublic Indicator getIndicator()
Indicator
component, which is used to specify the properties for the dial and led gauge indicators.public ToolTips getToolTips()
ToolTips
component, which is used to specify the formatting for the gauge tooltips.public Threshold getThreshold()
Threshold
component, which is used to specify the properties for the gauge thresholds.public TopLabel getTopLabel()
TopLabel
component, which is used to specify the text and properties for the top label of the gauge.public BottomLabel getBottomLabel()
BottomLabel
component, which is used to specify the text and properties for the bottom label of the gauge.public MetricLabel getMetricLabel()
MetricLabel
component, which is used to specify the text and properties for the metric label of the gauge.public UpperLabelFrame getUpperLabelFrame()
UpperLabelFrame
component, which is used to specify the appearance of the frame that contains the top label. The presence of the UpperLabelFrame
is affected by the customLayout
of the gauge.setCustomLayout(int)
public LowerLabelFrame getLowerLabelFrame()
LowerLabelFrame
component, which is used to specify the appearance of the frame that contains the bottom label.public LegendArea getLegendArea()
LegendArea
component, which is used to specify the appearance of the legend.public LegendText getLegendText()
LegendText
component, which is used to specify the appearance of the legend text.public LegendTitle getLegendTitle()
LegendTitle
component, which is used to specify the text and appearance of the legend title.public ElementA getElementA()
ElementA
public ElementB getElementB()
ElementB
public IntersectionAB getIntersectionAB()
IntersectionAB
public int getGaugeSetAlignment()
public void setGaugeSetAlignment(int alignment)
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_.public int getGaugeSetColumnCount()
public void setGaugeSetColumnCount(int columns)
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_.public int getGaugeSetDirection()
public void setGaugeSetDirection(int direction)
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_.public int getAngleExtent()
public void setAngleExtent(int extent)
extent
- the angular extent of the dial gauge plotAreapublic java.lang.String getCustomShapesPath()
public void setCustomShapesPath(java.lang.String path)
path
-public int getVisualEffects()
public void setVisualEffects(int effects)
effects
- representing the level of visual effects displayed on the gauge.public int getCustomLayout()
public void setCustomLayout(int layout)
layout
- representing the custom layout selections displayed on the gauge.public int getAnimationOnDataChange()
ADC_
.public void setAnimationOnDataChange(int type)
ADC_
.
@Deprecated
public int getAnimationIndicators()
@Deprecated
public void setAnimationIndicators(int type)
public int getAnimationDuration()
public void setAnimationDuration(int duration)
public int getAnimationOnDisplay()
ADC_
.public void setAnimationOnDisplay(int type)
ADC_
.
@Deprecated
public java.awt.Color getAnimationUpColor()
@Deprecated
public void setAnimationUpColor(java.awt.Color color)
@Deprecated
public java.awt.Color getAnimationDownColor()
@Deprecated
public void setAnimationDownColor(java.awt.Color color)
public void setDVTResources(DVTResources res)
ImageView
setDVTResources
in interface ImageView
public static int convertNumberTypeToInt(java.lang.String type)
public static java.lang.String convertNumberTypeToString(int type)
type
- Number type identifierpublic int getGaugeType()
GaugeType
class beginning with TYPE_.public void setGraphicAntialiasing(boolean value)
value
- true or falsepublic boolean isGraphicAntialiasing()
public void setTextAntialiasing(boolean value)
value
- Valid values are true or falsepublic boolean isTextAntialiasing()
public void setGaugeType(int type)
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.public int getSpecularHighlight()
public void setSpecularHighlight(int style)
style
- Integer representing the specularHighlight option for LS_DOT style LED gauges. Valid values are constants in the GaugeAttributes
class beginning with SH_.public void setCustomShapesStreams(java.io.InputStream svgStream, java.io.InputStream xmlStream)
public static int convertGaugeTypeToInt(java.lang.String type)
type
- Integer representation of a gauge typepublic static java.lang.String convertGaugeTypeToString(int type)
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));
type
- The gauge type constant that you want to convert.String
representation of current gauge typepublic int getLEDStyle()
Gauge
class beginning with LS_.public void setLEDStyle(int style)
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_.public int getThresholdDialStyle()
Gauge
class beginning with TDS_.public void setThresholdDialStyle(int style)
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_.public LEDStyleCallback getLEDStyleCallback()
LEDStyleCallback
public void setLEDStyleCallback(LEDStyleCallback callback)
callback
- Instance of LEDStyleCallback
public static int convertLEDStyleToInt(java.lang.String style)
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));
style
- String representation of the LED stylepublic static java.lang.String convertLEDStyleToString(int style)
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.style
- String representation of the LED styleString
for the LED style.public static int convertSpecularHighlightToInt(java.lang.String style)
public static java.lang.String convertSpecularHighlightToString(int style)
public static int convertTDStyleToInt(java.lang.String style)
public static java.lang.String convertTDStyleToString(int style)
public static int convertCustomLayoutToInt(java.lang.String type)
public static java.lang.String convertCustomLayoutToString(int type)
public void setDataAccess(DataAccess dataAccess)
setDataAccess
in class CommonDataview
public void setDataDirector(DataDirector dataDirector)
setDataDirector
in class CommonDataview
public DataSpecification getDataSpecification()
DataSpecification
for this bean.DataSpecification
for this bean. If a beans data specification has not been set for this view, this method returns null
.public void setDataSpecification(DataSpecification dataSpec)
DataSpecification
for this bean, assuming it is relevant to the current DataSource
.dataSpec
- The DataSpecification
for this bean.public void setLocale(java.util.Locale loc)
Locale
for this Gauge
.setLocale
in class CommonDataview
loc
- The Locale
for this Gauge
.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)
node
- Instance of ObjectNode on which to set propertiesfont
- Instance of font from which to get propertiesdefFont
- Instance of font representing the defaultTrue
if node was modified, False
otherwisepublic void setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node, java.lang.String attrName)
node
- Instance of BaseObjectNode containing the XMLattrName
- Name of font attribute in GaugeAttributespublic void setGaugeFontXML(oracle.dss.util.xml.BaseObjectNode node, java.lang.String attrName, java.util.HashMap map)
node
- Instance of BaseObjectNode containing the XMLattrName
- Name of font attribute in GaugeAttributesmap
- Instance of HashMap
public DataviewTitles getDataviewFootnote()
CommonDataview
getDataviewFootnote
in interface DataviewCommon
getDataviewFootnote
in class CommonDataview
public DataviewTitles getDataviewSubtitle()
CommonDataview
getDataviewSubtitle
in interface DataviewCommon
getDataviewSubtitle
in class CommonDataview
public DataviewTitles getDataviewTitle()
CommonDataview
getDataviewTitle
in interface DataviewCommon
getDataviewTitle
in class CommonDataview
public ComponentHandle getGaugeComponentHandle(int objID, int row, int column)
column
- integer representing the column of the gauge in which this component residesrow
- integer representing the row of the gauge in which this component residesobjID
- integer representing the ID of the componentpublic ComponentHandle getGaugeComponentHandle(int objID, int index, int row, int column)
column
- integer representing the column of the gauge in which this component residesrow
- integer representing the row of the gauge in which this component residesobjID
- integer representing the ID of the componentindex
- index of the componentpublic java.lang.String getAlternativeText(ComponentHandle handle)
getAlternativeText
in interface ImageView
public int[] getDrillParameters(ComponentHandle handle)
getDrillParameters
in interface ImageView
public ComponentHandle getSelectedObject()
DrawableObject
public java.lang.String getToolTipText(java.awt.event.MouseEvent e)
public boolean isXMLValidated()
Dataview
validates XML against its DTD.isXMLValidated
in class CommonDataview
true
if the Dataview
validates XML, false
if the Dataview
applies XML without validation.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
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:
Gauge
without resetting anything to default valuesGauge
Resetting returns property values in the Gauge
to their defaults.
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.true
if the XML is successfully applied to this Gauge
, false
if an IO exception occurs.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.DataviewConstants.RESET_NONE
, DataviewConstants.RESET_XML_PROPERTIES
, DataviewConstants.RESET_EVERYTHING
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
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:
Gauge
without resetting anything to default valuesGauge
Resetting returns property values in the Gauge
to the default values for the version that is specified in the XML.
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.true
if the XML is successfully applied to this Gauge
, false
if an IO exception occurs.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.DataviewConstants.RESET_NONE
, DataviewConstants.RESET_XML_PROPERTIES
, DataviewConstants.RESET_EVERYTHING
public boolean selectObject(java.awt.event.MouseEvent e)
e
- Instance of MouseEvent
True
if the click successfully selected an object, False
public boolean setSelectedObject(int compID, int row, int column)
column
- Integer representing the columnrow
- Integer representing the rowcompID
- Type of component to select. Valid values are constants beginning with ID_
in the Gauge
class.True
if the object(s) were selected, False
if the object(s) couldn't be selectedpublic boolean setGridData(java.lang.Object[] specs, java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
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 String
srowLabels
- labels for the rows of data; typically String
sdata
- values to be plotted in the graph, indexed first by column, then by row; typically Double
s and Date in case of TimeSeries graphstrue
if data is successfully set on the graph, false
otherwiseGraph
. Data is provided in grid form, where the number of rows and columns are known ahead of time.public boolean setTabularData(java.lang.Object[] specs, java.util.List tableRows)
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 aList
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 theList
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.
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.true
if data is successfully set on the gauge bean, false
if there is a data problem.public void exportToPNG(java.io.OutputStream os)
exportToPNG
in interface ImageView
os
- The OutputStream
that specifies the location and name of the PNG file.exportToPNGWithException(java.io.OutputStream)
public void exportToPNGWithException(java.io.OutputStream os) throws oracle.dss.graph.pfj.png.PNGInvalidParameterException, oracle.dss.graph.pfj.png.PNGException
exportToPNGWithException
in interface ImageView
os
- The OutputStream
that specifies the location and name of the PNG file.oracle.dss.graph.pfj.png.PNGInvalidParameterException
oracle.dss.graph.pfj.png.PNGException
exportToPNG(java.io.OutputStream)
public void setSVGWriterProvider(SVGWriterProvider provider)
setSVGWriterProvider
in interface ImageView
provider
- Instance of SVGWriterProvider
used to create an SVGWriter
instancegetXMLWriterCallback
getXMLWriterCallback
for a public alternative.public SVGWriterProvider getSVGWriterProvider()
getSVGWriterProvider
in interface ImageView
SVGWriterProvider
used to create an SVGWriter
instancegetXMLWriterCallback
getXMLWriterCallback
for a public alternative.public void setXMLWriterCallback(GaugeXMLWriterCallback callback)
CommonGauge
directly.public GaugeXMLWriterCallback getXMLWriterCallback()
CommonGauge
directly.public void setSvgHeaders(int headers)
setSvgHeaders
in interface ImageView
headers
- constant indicating whether to include headers in exported SVGpublic int getSvgHeaders()
getSvgHeaders
in interface ImageView
public java.util.List getSvgScriptIdList()
getSvgScriptIdList
in interface ImageView
public void exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc)
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.
exportToSVG
in interface ImageView
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 SVGpublic void exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc, java.lang.String id)
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.
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 SVGid
- for passing in a string as an id for the gauge
@Deprecated
public void exportToFlash(java.io.OutputStream os,
boolean renderDynamic,
boolean showDrawing)
exportToFlash
in interface ImageView
os
- the OutputStream associated with the flash filerenderDynamic
- 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.public void exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
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.
exportToSVGWithException
in interface ImageView
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 SVGjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredpublic void exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc, java.lang.String id) throws java.io.IOException, java.lang.Exception
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.
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 SVGid
- for passing in a string as an id for the gaugejava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredpublic void exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc)
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.
exportToSVG
in interface ImageView
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 SVGpublic void exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc, java.lang.String id)
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.
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 SVGid
- for passing in a string as an id for the gaugepublic void exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
exportToSVGWithException
in interface ImageView
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 SVGjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredBefore 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.
public void exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc, java.lang.String id) throws java.io.IOException, java.lang.Exception
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 SVGid
- for passing in a string as an id for the gaugejava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredBefore 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.
public void exportToXMLWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
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.
exportToXMLWithException
in interface ImageView
os
- The OutputStream
to write XML to.mode
- specifies what to include in XML; currently not usedcharEnc
- character encoding to use for XMLjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredpublic void exportToXMLWithException(java.io.Writer writer, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
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.
exportToXMLWithException
in interface ImageView
writer
- The Writer
to write SVG to.mode
- specifies what to include in XML; currently not usedcharEnc
- character encoding to use for XMLjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurred
@Deprecated
public void exportToSWFWithException(java.io.OutputStream os,
int mode,
java.lang.String charEnc)
throws java.io.IOException,
java.lang.Exception
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.
exportToSWFWithException
in interface ImageView
os
- The OutputStream
to write the SWF to.mode
- specifies what to include in SWF; currently not usedcharEnc
- character encoding to usejava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurred
@Deprecated
public void exportToSWFWithException(java.lang.String swfPath,
java.io.OutputStream os,
int mode,
java.lang.String charEnc)
throws java.io.IOException,
java.lang.Exception
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.
swfPath
- the path to the SWF for this viewos
- The OutputStream
to write the SWF to.mode
- specifies what to include in SWF; currently not usedcharEnc
- character encoding to usejava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredpublic void refreshData()
refreshData
in interface ImageView
public java.lang.Object getAttribute(java.lang.String name)
name
- String representation of the attribute name to retrieve.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.public void setAttribute(java.lang.String name, java.lang.Object value)
name
- String representation of the attribute name to set.value
- Object containing the value of the property.GaugeAttributes
interface.public int getGaugeCount()
NO_DATA_AVAILABLE
if there is no data available in the gauge bean at this time.public java.lang.Object getGaugeSetAttribute(java.lang.String name)
name
- String representation of the gauge set attribute name to retrieve.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.public void setGaugeSetAttribute(java.lang.String name, java.lang.Object value)
name
- String representation of the gauge set attribute to set.value
- Object containing the value of the attribute.CommonGauge
class and begin with GS
.public int getMode()
public void setMode(int mode)
mode
- int constant representing the HashMap to operate upon. Valid constants begin with MODE_public java.awt.Dimension getOptimalGaugeSize(java.awt.Dimension maxSize)
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.
maxSize
- Dimensions to use in determining optimal gauge size.Dimension
containing the size of the largest gauge in this gauge set.exportToPNG(java.io.OutputStream)
public java.awt.Dimension getImageSize()
exportToPNG
method.getImageSize
in interface ImageView
Dimension
containing the size of this gauge set.public void setImageSize(java.awt.Dimension size)
exportToPNG
method.setImageSize
in interface ImageView
size
- Instance of Dimension
containing the size of this gauge set.public int getRowCount()
public int getColCount()
public java.lang.String getFlashGaugeLCID()
public void setFlashGaugeLCID(java.lang.String id)
public java.lang.String getRowLabel(int row)
public java.lang.String getColumnLabel(int col)
protected boolean prepareGaugeEngines()
True
if the gauge components could be prepared successfully, False
if they could not.public boolean renderGauges(java.awt.Graphics2D g)
Graphics
.g
- Instance of Graphics
to useTrue
if the gauge components rendered successfully, False
if they could not.public boolean renderGauges(GaugeSVGWriter writer, int mode)
mode
- Integer controlling the content of the SVGwriter
- Instance of GaugeSVGWriter
to useTrue
if the gauge components rendered successfully, False
if they could not.GaugeSVGWriter
.public boolean renderGauges(GaugeExportXMLWriter writer, int mode)
mode
- Integer controlling the content of the XMLwriter
- Instance of GaugeSVGWriter
to useTrue
if the gauge components rendered successfully, False
if they could not.GaugeExportXMLWriter
.public 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 renderLegendTitle(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.geom.Rectangle2D legendFrame)
protected void renderLegendItems(GaugeRenderer renderer, java.awt.Graphics2D g2d, java.awt.geom.Rectangle2D legendFrame)
protected GaugeSVGWriter createSVGWriter(java.io.OutputStream os, java.lang.String charEnc)
os
- OutputStream to write tocharEnc
- character encodingprotected GaugeSVGWriter createSVGWriter(java.io.Writer writer, java.lang.String charEnc)
writer
- Writer to write tocharEnc
- character encodingprotected GaugeExportXMLWriter createExportXMLWriter(java.io.OutputStream os, java.lang.String charEnc)
os
- OutputStream to write tocharEnc
- character encodingprotected GaugeExportXMLWriter createExportXMLWriter(java.io.Writer writer, java.lang.String charEnc)
writer
- Writer to write tocharEnc
- character encodingpublic java.util.Enumeration getImagemapEnumeration(int filter)
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.getImagemapEnumeration
in interface ImageView
filter
- One or more bitwise values specifying the kinds of gauge components to enumerate. Valid values are constants in this class beginning with MAP_.DataviewConstants.MAP_ALL
, DataviewConstants.MAP_DATA
, DataviewConstants.MAP_LABELS
, DataviewConstants.MAP_TITLES
, ImagemapComponent
public void writeImagemapXML(java.io.OutputStream os, int filter)
filter
are defined in this class and begin with MAP_.os
- The output stream where XML will be written.filter
- The kinds of graph components whose information you want to write in XML.getImagemapEnumeration(int)
, DataviewConstants.MAP_ALL
, DataviewConstants.MAP_DATA
, DataviewConstants.MAP_DATATEXT
, DataviewConstants.MAP_LABELS
, DataviewConstants.MAP_LEGEND
, DataviewConstants.MAP_ORDINALLABELS
, DataviewConstants.MAP_TITLES
public void writeImagemapXML(java.io.PrintWriter out, int filter)
filter
are defined in this class and begin with MAP_.out
- The print writer where XML will be written.filter
- The kinds of graph components whose information you want to write in XML.getImagemapEnumeration(int)
, DataviewConstants.MAP_ALL
, DataviewConstants.MAP_DATA
, DataviewConstants.MAP_DATATEXT
, DataviewConstants.MAP_LABELS
, DataviewConstants.MAP_LEGEND
, DataviewConstants.MAP_ORDINALLABELS
, DataviewConstants.MAP_TITLES
public void writeXML(java.io.OutputStream stream, boolean allProperties)
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.
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.public void setXMLValidated(boolean validate)
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.setXMLValidated
in class CommonDataview
validate
- true
to have XML validated, false
to have the Dataview
ignore invalid XML.setXML(java.lang.String, int)
protected void resetToDefault(int reset, java.lang.String version)
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 XMLpublic void setMetadataLabelFlag(boolean metadataFlag)
public void setLayerMetaLongLabelSupported(boolean supported)
setLayerMetaLongLabelSupported
in class CommonDataview
public void setMetadataDrillSupported(boolean supported)
protected boolean isMetadataDrillSupported()
public void setMetadataDrillParentDateSupported(boolean supported)
protected boolean isMetadataDrillParentDateSupported()
public void setMetadataDrillParentDateSpanSupported(boolean supported)
protected boolean isMetadataDrillParentDateSpanSupported()
public void setMetadataDateSpanSupported(boolean supported)
protected boolean isMetadataDateSpanSupported()
protected LocalXMLDataSource createLocalGridDataSource(oracle.dss.util.xml.ObjectNode node)
protected LocalXMLDataSource createLocalRelationalDataSource(oracle.dss.util.xml.ContainerNode node)
protected void fillLinkArrays(int colCount, int rowCount, java.lang.Object[] colLabels, java.lang.Object[] rowLabels, java.util.Hashtable dataValLinks)
protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName, boolean allProperties, java.lang.String version)
getObjectNode
in class CommonDataview
protected oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)
protected DataviewXML getViewXML()
getViewXML
in class CommonDataview
protected void setXML(oracle.dss.util.xml.ObjectNode node, int reset)
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
setStylePath
in interface ImageView
stylePath
- The path of the XML to set as a style on this gauge.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.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/
.
protected void processAlertEvent(int eventID)
eventID
- id associated with that eventprotected javax.swing.event.EventListenerList getAlertListenerList()
protected void setAlertListenerList(javax.swing.event.EventListenerList list)
public static int convertTickContentToInt(java.lang.String contentStr)
contentStr
- String-based representation of tick content propertypublic static java.lang.String convertTickContentToString(int content)
content
- Tick content property valuepublic static int convertGaugeSetAlignmentToInt(java.lang.String align)
align
- String-based representation of gaugeset alignment propertypublic static java.lang.String convertGaugeSetAlignmentToString(int align)
align
- Gaugeset alignment property valuepublic static int convertGaugeSetColCountToInt(java.lang.String colCount)
colCount
- String-based representation of gaugeset column count propertypublic static java.lang.String convertGaugeSetColCountToString(int colCount)
colCount
- Gaugeset column count property valuepublic static int convertGaugeSetDirectionToInt(java.lang.String value)
value
- String-based representation of gaugeset direction propertypublic static java.lang.String convertGaugeSetDirectionToString(int value)
value
- Gaugeset direction property valuepublic int getRecalcState()
RECALC_STATE_
.public void setRecalcState(int state)
state
-public void setRecalcState(int state, boolean clear)
state
-clear
- true to clear the current valuepublic java.lang.String getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
getIntlString
in interface DataviewCommon
getIntlString
in class CommonDataview
key
-rBundle
-public java.lang.String getErrorIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
protected void updateResourceBundle()
updateResourceBundle
in class CommonDataview
protected static java.util.ResourceBundle getGaugeResourceBundle(java.util.Locale loc) throws java.util.MissingResourceException
java.util.MissingResourceException
public boolean setXMLAsString(java.lang.String xml) throws oracle.dss.util.persistence.BIPersistenceException
setXMLAsString
in interface oracle.dss.util.persistence.StringXMLizable
xml
- The XML representation of the view.true
if the XML was successfully set, false
if not.oracle.dss.util.persistence.BIPersistenceException
- If a problem occurs in setting the XML.readXML(java.io.InputStream, int)
, setXML(java.lang.String, int)
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
.
public void setXML(java.lang.String xml, java.util.HashMap map)
public java.lang.String getXMLAsString()
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.
getXMLAsString
in interface oracle.dss.util.persistence.StringXMLizable
Dataview
.CommonDataview.getXML(java.lang.String, boolean)
, writeXML(java.io.OutputStream, boolean)
public void initialize(java.util.Hashtable env)
initialize
in interface oracle.dss.util.persistence.SimplePersistable
public void setContext()
public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)
getPersistableAttributes
in interface oracle.dss.util.persistence.SimplePersistable
oldAttrs
- a PersistableAttributes
value that represents the searchable attributes set by the user application.PersistableAttributes
which represent the searchable properties of the graph (the ones passed into the method augmented by graph-specific properties).PeristableAttibutes
(i.e. search attributes associated with this graph) which are used for searching for this graph in the database.public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()
CommonDataview
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.
getPersistableComponents
in interface oracle.dss.util.persistence.contract.AggregableContract
getPersistableComponents
in class CommonDataview
AggregateInfo[]
which represents the components associated with the graph.public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
setPersistableComponents
in interface oracle.dss.util.persistence.contract.AggregableContract
setPersistableComponents
in class CommonDataview
persistables
- a AggregateInfo[]
value that represents the components to assign to the graph.protected void createPropertyOverrideFlags()
public void clearOverrideFlags()
public java.util.BitSet createPropertyOverrideFlags(int maxID)
createPropertyOverrideFlags
in interface DataviewCommon
createPropertyOverrideFlags
in class CommonDataview
public void clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
clearPropertyOverrideFlag
in class CommonDataview
protected void setPropertyOverrideFlags(int attrID)
protected boolean isStyleOverrideFlag(int attrID)
protected boolean isUserOverrideFlag(int attrID)
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- reference to a PropertyChangeListenerr
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
l
- reference to a ViewFocusListener
protected void firePropertyChange(java.lang.Object obj, java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
obj
- the Object which has the getter/setter for this propertypropName
- String: the name of the property (minus get/set)oldValue
- Object: the previous value of the propertynewValue
- Object: the new value of the propertypublic CustomToolTipCallback getCustomToolTipCallback()
CustomToolTipCallback
that this Gauge
uses to get text for tooltips.CustomToolTipCallback
that provides tooltips for this Gauge
. Returns null
if no CustomToolTipCallback
has been set.public void setCustomToolTipCallback(CustomToolTipCallback callback)
CustomToolTipCallback
that will provide tooltip text to this Gauge
.callback
- The CustomToolTipCallback
that this Gauge
should call for tooltip text.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |