Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.0.0)

E17492-01

oracle.dss.gauge
Class GaugeSVGWriter

java.lang.Object
  extended by oracle.dss.presutil.XMLWriter
      extended by oracle.dss.presutil.SVGWriter
          extended by oracle.dss.gauge.GaugeSVGWriter
All Implemented Interfaces:
GaugeRenderer

public class GaugeSVGWriter
extends oracle.dss.presutil.SVGWriter
implements GaugeRenderer

Since:
11.0

Field Summary
 
Fields inherited from class oracle.dss.presutil.SVGWriter
ATTR_ASCENT, ATTR_CLIP_PATH, ATTR_CX, ATTR_CY, ATTR_D, ATTR_DESCENT, ATTR_FILL, ATTR_FILL_OPACITY, ATTR_FONT_FAMILY, ATTR_FONT_SIZE, ATTR_FONT_STYLE, ATTR_FONT_WEIGHT, ATTR_GRADIENT_UNITS, ATTR_HEIGHT, ATTR_HORIZ_ADV_X, ATTR_ID, ATTR_OFFSET, ATTR_ONCLICK, ATTR_ONFOCUSIN, ATTR_ONFOCUSOUT, ATTR_ONLOAD, ATTR_ONMOUSEDOWN, ATTR_ONMOUSEMOVE, ATTR_ONMOUSEOUT, ATTR_ONMOUSEOVER, ATTR_ONMOUSEUP, ATTR_PATTERN_UNITS, ATTR_POINTER_EVENTS, ATTR_POINTS, ATTR_R, ATTR_RX, ATTR_RY, ATTR_STOP_COLOR, ATTR_STOP_OPACITY, ATTR_STROKE, ATTR_STROKE_DASHARRAY, ATTR_STROKE_DASHOFFSET, ATTR_STROKE_LINECAP, ATTR_STROKE_MITERLIMIT, ATTR_STROKE_OPACITY, ATTR_STROKE_WIDTH, ATTR_STYLE, ATTR_TARGET, ATTR_TEXT_DECORATION, ATTR_TRANSFORM, ATTR_UNICODE, ATTR_UNITS_PER_EM, ATTR_WIDTH, ATTR_X, ATTR_X1, ATTR_X2, ATTR_XLINK_HREF, ATTR_Y, ATTR_Y1, ATTR_Y2, ELEM_A, ELEM_CIRCLE, ELEM_CLIP_PATH, ELEM_DEFS, ELEM_DESC, ELEM_ELLIPSE, ELEM_ENCSCRIPT, ELEM_FONT, ELEM_FONT_FACE, ELEM_G, ELEM_GLYPH, ELEM_IMAGE, ELEM_LINE, ELEM_LINEAR_GRADIENT, ELEM_METADATA, ELEM_MISSING_GLYPH, ELEM_PATH, ELEM_PATTERN, ELEM_POLYGON, ELEM_POLYLINE, ELEM_RADIAL_GRADIENT, ELEM_RECT, ELEM_SCRIPT, ELEM_STOP, ELEM_SVG, ELEM_TEXT, ELEM_TITLE, JS_HIDE_TOOLTIP, JS_SHOW_TITLE_TOOLTIP, JS_SHOW_TOOLTIP, m_fontTextMapped, m_scriptIds, NAMESPACE_SVG, NAMESPACE_XLINK, NAMESPACE_XML, TOOLTIP_LINE_DELIMITER
 
Fields inherited from class oracle.dss.presutil.XMLWriter
LINE_SEP, m_eh, m_elems, m_writer
 
Constructor Summary
GaugeSVGWriter(java.io.OutputStream os, ErrorHandler eh)
          Constructor.
GaugeSVGWriter(java.io.OutputStream os, ErrorHandler eh, java.lang.String charEnc)
          Constructor.
GaugeSVGWriter(java.io.Writer writer, ErrorHandler eh)
          Constructor.
GaugeSVGWriter(java.io.Writer writer, ErrorHandler eh, java.lang.String charEnc)
          Constructor.
 
Method Summary
 void applyTransform(java.awt.geom.AffineTransform transform)
          This method allows an application of the given AffineTransform object.
protected  java.lang.String constructId(java.lang.String id)
           
 void drawAndFillArc(java.awt.geom.Arc2D arc, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of an outline represented by the given Arc2D instance, using the given colors.
 void drawAndFillArea(java.awt.geom.Area area, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of an outline represented by the given Area instance, using the given colors.
 void drawAndFillPolygon(java.awt.Polygon polygon, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of an outline represented by the given Polygon instance, using the given colors.
 void drawAndFillRect(java.awt.Rectangle rect, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of an outline represented by the given Rectangle instance, using the given colors.
 void drawAndFillRoundedRect(java.awt.geom.RoundRectangle2D roundRect, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of the given rectangle using the given instance of Color and rounded with the given arc width and height.
 void drawAndFillShape(java.awt.Shape shape, java.awt.Color borderColor, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the drawing and filling of an outline represented by the given Shape instance, using the given colors.
 void drawArc(java.awt.geom.Arc2D arc, java.awt.Color c)
          This method supports the drawing of an outline represented by the given Arc2D instance, using the given color as its border color.
 void drawArea(java.awt.geom.Area area, java.awt.Color c)
          This method supports the drawing of an area outlined according to the given Area object, using the given color as its border color.
 void drawImage(java.lang.String imgURL, java.awt.Image image, int x, int y, int width, int height, java.awt.image.ImageObserver imgObs)
          This method supports the drawing of an image.
 void drawLine(int x1, int y1, int x2, int y2, java.awt.Color c)
          This method supports the drawing of a line with the given color.
 void drawLine(int x1, int y1, int x2, int y2, int thickness, java.awt.Color c)
          This method supports the drawing of a line with the given thickness and color.
 void drawPolygon(java.awt.Polygon poly, java.awt.Color c)
          This method supports the drawing of the outline of a polygon defined by the specified Polygon object using the given instance of Color.
 void drawRect(java.awt.Rectangle rect, java.awt.Color c)
          This method supports the drawing of the given rectangle using the given instance of Color.
 void drawShape(java.awt.Shape shape, java.awt.Color c)
          This method supports the drawing of an outline represented by the given Shape instance, using the given color as its border color.
 void drawString(DrawableObject.Label labelObj, int x, int y, java.awt.Font f, java.awt.Color c, double angle)
          This method supports the drawing of text in the given color at the location specified by the point at x1 and y1.
 void fillArc(java.awt.geom.Arc2D arc, java.awt.Color c, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the filling of the given arc with the given color.
 void fillArea(java.awt.geom.Area area, java.awt.Color c, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the filling of an area outlined according to the given Area object, using the given color.
 void fillPolygon(java.awt.Polygon poly, java.awt.Color c, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the filling of the given polygon using the provided color as its border color.
 void fillRect(java.awt.Rectangle rect, java.awt.Color c, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the filling of the given rectangle using the given instance of Color.
 void fillShape(java.awt.Shape shape, java.awt.Color c, oracle.dss.presutil.GradientObj gradient, java.util.Map sfxMap)
          This method supports the filling of an outline represented by the given Shape instance, using the given color as its fill color.
 java.lang.String getBeanName()
           
 java.lang.String getClickEventJS()
          Get the javascript to fire a click event.
protected  java.lang.String getFillAttribute(java.awt.Shape shape, java.awt.Color fillColor, oracle.dss.presutil.GradientObj gradient)
          Calculate the value for the fill attribute for the given component.
 java.lang.String getFilteredBeanName()
           
 java.lang.String getShapeAttributesAlt()
          Get a specified alt attribute value.
 java.lang.String getShapeAttributesHRef()
          Get a specified href attribute value.
 java.lang.String getShapeAttributesTarget()
          Get a specified target attribute value.
 java.lang.String getShapeAttributesTitle()
          Get a specified title attribute value.
 java.lang.String getSimpleBeanName()
           
protected  int getSvgMode()
          Returns the current mode used during rendering of objects to SVG.
 java.awt.geom.AffineTransform getTransform()
          This method gets the current AffineTransform object.
 boolean isOnClickPresent()
          Determine whether an onClick attribute is specified.
 boolean isOnMouseOverOutPresent()
          Determine whether the onMouseOver or onMouseOut attribute is specified in ShapeAttributes.
 void setCompType(int type)
           
 void setMap(java.util.Map map)
           
 void setSvgMode(int mode)
          Sets the mode to use during rendering.
 void setTransform(java.awt.geom.AffineTransform transform)
          This method allows an reset of the current transform to the given AffineTransform object.
 void writeLinkScript()
          Write javascript related to specifying Links
protected  void writeOpacityAttribute(java.awt.Color color, java.lang.String attr)
          Write a fill-opacity attribute to SVG.
 void writeShapeAttributes()
          Write optional ShapeAttributes for the current element.
 void writeShapeAttributesScript()
          Write javascript related to specifying ShapeAttributes.
 
Methods inherited from class oracle.dss.presutil.SVGWriter
addToScriptIdList, concatTooltipText, createNormalizedFont, getFontFamily, getFontSize, getFontStyle, getFontTextMap, getFontWeight, getScriptIdList, getTextDecoration, isFontEmbedding, isFontTextMapped, processTextForFontEmbedding, setFontEmbedding, setFontTextMap, setFontTextMapped, startCircleElement, startCircleOrEllipseElement, startEllipseElement, startEllipseElement, startImageElement, startLineElement, startLineElement, startPathElement, startPolygonElement, startPolygonElement, startPolylineElement, startRectElement, startRectElement, startRoundedRectElement, startRoundedRectElement, startSVGElement, startTextElement, writeAttribute, writeCommonScript, writeCommonScrollbarScript, writeEmbeddedFonts, writeFontAttributes, writeFontFamilyAttribute, writeFontFamilyAttribute, writeFontSizeAttribute, writeFontStyleAttribute, writeFontWeightAttribute, writeHorizontalScrollbar, writeHorizontalScrollbarScript, writeImageElement, writeScrollbarObjectScript, writeSVGHeader, writeText, writeTextDecorationAttribute, writeTitleElement, writeTooltip, writeTooltip, writeTooltipsScript, writeVerticalScrollbar, writeVerticalScrollbarScript
 
Methods inherited from class oracle.dss.presutil.XMLWriter
_roundDouble, checkPrevStartTag, checkPrevStartTag, close, closeStartTag, colorToHex, colorToHexWithAlpha, convertShapeToPath, endCData, endElement, endElement, escape, flush, getBrighter, getCharacterEncoding, isAutomaticNewlines, isEncodingScriptTag, print, print, println, println, println, setAutomaticNewlines, setEncodingScriptTag, startCData, startElement, write, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeText, writeXMLHeader
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GaugeSVGWriter

public GaugeSVGWriter(java.io.OutputStream os,
                      ErrorHandler eh,
                      java.lang.String charEnc)
Constructor.

Parameters:
os - OutputStream to write to
eh - ErrorHandler to use
charEnc - character encoding to use; if null, UTF-8 will be used

GaugeSVGWriter

public GaugeSVGWriter(java.io.OutputStream os,
                      ErrorHandler eh)
Constructor. UTF-8 will be used as the character encoding.

Parameters:
os - OutputStream to write to
eh - ErrorHandler to use

GaugeSVGWriter

public GaugeSVGWriter(java.io.Writer writer,
                      ErrorHandler eh,
                      java.lang.String charEnc)
Constructor.

Parameters:
writer - Writer to write to
eh - ErrorHandler to use
charEnc - character encoding to use; if null, UTF-8 will be used

GaugeSVGWriter

public GaugeSVGWriter(java.io.Writer writer,
                      ErrorHandler eh)
Constructor. UTF-8 will be used as the character encoding.

Parameters:
writer - Writer to write to
eh - ErrorHandler to use
Method Detail

getSvgMode

protected int getSvgMode()
Returns the current mode used during rendering of objects to SVG.

Returns:
One of the SVG modes in GaugeConstants beginning with SVG_MODE_.

setSvgMode

public void setSvgMode(int mode)
Sets the mode to use during rendering. As each DrawableObject is rendered, the mode is used to render the object with its appropriate adornments.

Parameters:
mode - One of the modes in GaugeConstants beginning with SVG_MODE_.

setCompType

public void setCompType(int type)

setMap

public void setMap(java.util.Map map)

drawShape

public void drawShape(java.awt.Shape shape,
                      java.awt.Color c)
This method supports the drawing of an outline represented by the given Shape instance, using the given color as its border color.

Specified by:
drawShape in interface GaugeRenderer
Parameters:
shape - Instance of Shape
c - Color instance representing the intended color of the shape

fillShape

public void fillShape(java.awt.Shape shape,
                      java.awt.Color c,
                      oracle.dss.presutil.GradientObj gradient,
                      java.util.Map sfxMap)
This method supports the filling of an outline represented by the given Shape instance, using the given color as its fill color.

Specified by:
fillShape in interface GaugeRenderer
Parameters:
shape - Instance of Shape
c - Color instance representing the intended fill color of the shape
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawAndFillShape

public void drawAndFillShape(java.awt.Shape shape,
                             java.awt.Color borderColor,
                             java.awt.Color fillColor,
                             oracle.dss.presutil.GradientObj gradient,
                             java.util.Map sfxMap)
This method supports the drawing and filling of an outline represented by the given Shape instance, using the given colors.

Specified by:
drawAndFillShape in interface GaugeRenderer
Parameters:
shape - Instance of Shape
borderColor - Color instance representing the intended borderColor of the shape
fillColor - Color instance representing the intended fill color of the shape
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawArc

public void drawArc(java.awt.geom.Arc2D arc,
                    java.awt.Color c)
This method supports the drawing of an outline represented by the given Arc2D instance, using the given color as its border color.

Specified by:
drawArc in interface GaugeRenderer
Parameters:
arc - Instance of Arc2D
c - Color instance representing the intended color of the arc

fillArc

public void fillArc(java.awt.geom.Arc2D arc,
                    java.awt.Color c,
                    oracle.dss.presutil.GradientObj gradient,
                    java.util.Map sfxMap)
This method supports the filling of the given arc with the given color.

Specified by:
fillArc in interface GaugeRenderer
Parameters:
arc - Instance of Arc2D
c - Color instance indicating the fill color of the arc
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawAndFillArc

public void drawAndFillArc(java.awt.geom.Arc2D arc,
                           java.awt.Color borderColor,
                           java.awt.Color fillColor,
                           oracle.dss.presutil.GradientObj gradient,
                           java.util.Map sfxMap)
This method supports the drawing and filling of an outline represented by the given Arc2D instance, using the given colors.

Specified by:
drawAndFillArc in interface GaugeRenderer
Parameters:
arc - Instance of Arc2D
borderColor - Color instance representing the intended borderColor of the arc
fillColor - Color instance representing the intended fill color of the arc
sfxMap - Instance of HashMap containing SFX attributes for this arc

drawArea

public void drawArea(java.awt.geom.Area area,
                     java.awt.Color c)
This method supports the drawing of an area outlined according to the given Area object, using the given color as its border color.

Specified by:
drawArea in interface GaugeRenderer
Parameters:
area - Instance of Area
c - Color instance indicating the fill color of the arc

fillArea

public void fillArea(java.awt.geom.Area area,
                     java.awt.Color c,
                     oracle.dss.presutil.GradientObj gradient,
                     java.util.Map sfxMap)
This method supports the filling of an area outlined according to the given Area object, using the given color.

Specified by:
fillArea in interface GaugeRenderer
Parameters:
area - Instance of Area
c - Color instance indicating the fill color of the area
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawAndFillArea

public void drawAndFillArea(java.awt.geom.Area area,
                            java.awt.Color borderColor,
                            java.awt.Color fillColor,
                            oracle.dss.presutil.GradientObj gradient,
                            java.util.Map sfxMap)
This method supports the drawing and filling of an outline represented by the given Area instance, using the given colors.

Specified by:
drawAndFillArea in interface GaugeRenderer
Parameters:
area - Instance of Area
borderColor - Color instance representing the intended borderColor of the area
fillColor - Color instance representing the intended fill color of the area
sfxMap - Instance of HashMap containing SFX attributes for this area

drawPolygon

public void drawPolygon(java.awt.Polygon poly,
                        java.awt.Color c)
This method supports the drawing of the outline of a polygon defined by the specified Polygon object using the given instance of Color.

Specified by:
drawPolygon in interface GaugeRenderer
Parameters:
poly - The polygon to draw.
c - The color with which to draw the polygon

fillPolygon

public void fillPolygon(java.awt.Polygon poly,
                        java.awt.Color c,
                        oracle.dss.presutil.GradientObj gradient,
                        java.util.Map sfxMap)
This method supports the filling of the given polygon using the provided color as its border color.

Specified by:
fillPolygon in interface GaugeRenderer
Parameters:
poly - Instance of Polygon
c - Color instance indicating the fill color of the polygon
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawAndFillPolygon

public void drawAndFillPolygon(java.awt.Polygon polygon,
                               java.awt.Color borderColor,
                               java.awt.Color fillColor,
                               oracle.dss.presutil.GradientObj gradient,
                               java.util.Map sfxMap)
This method supports the drawing and filling of an outline represented by the given Polygon instance, using the given colors.

Specified by:
drawAndFillPolygon in interface GaugeRenderer
Parameters:
polygon - Instance of Polygon
borderColor - Color instance representing the intended borderColor of the polygon
fillColor - Color instance representing the intended fill color of the polygon
sfxMap - Instance of HashMap containing SFX attributes for this polygon

drawRect

public void drawRect(java.awt.Rectangle rect,
                     java.awt.Color c)
This method supports the drawing of the given rectangle using the given instance of Color.

Specified by:
drawRect in interface GaugeRenderer
Parameters:
rect - Instance of Rectangle
c - Instance of Color to use for the rectangle.

fillRect

public void fillRect(java.awt.Rectangle rect,
                     java.awt.Color c,
                     oracle.dss.presutil.GradientObj gradient,
                     java.util.Map sfxMap)
This method supports the filling of the given rectangle using the given instance of Color.

Specified by:
fillRect in interface GaugeRenderer
Parameters:
rect - Instance of Rectangle marking the fill area
c - Instance of Color to use when filling.
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawAndFillRect

public void drawAndFillRect(java.awt.Rectangle rect,
                            java.awt.Color borderColor,
                            java.awt.Color fillColor,
                            oracle.dss.presutil.GradientObj gradient,
                            java.util.Map sfxMap)
This method supports the drawing and filling of an outline represented by the given Rectangle instance, using the given colors.

Specified by:
drawAndFillRect in interface GaugeRenderer
Parameters:
rect - Instance of Rectangle
borderColor - Color instance representing the intended borderColor of the rectangle
fillColor - Color instance representing the intended fill color of the rectangle
sfxMap - Instance of HashMap containing SFX attributes for this rectangle

drawAndFillRoundedRect

public void drawAndFillRoundedRect(java.awt.geom.RoundRectangle2D roundRect,
                                   java.awt.Color borderColor,
                                   java.awt.Color fillColor,
                                   oracle.dss.presutil.GradientObj gradient,
                                   java.util.Map sfxMap)
This method supports the drawing and filling of the given rectangle using the given instance of Color and rounded with the given arc width and height.

Specified by:
drawAndFillRoundedRect in interface GaugeRenderer
Parameters:
roundRect - Instance of RoundRectangle2D marking the fill area
borderColor - Instance of Color to use for the border.
fillColor - Instance of Color to use when filling.
sfxMap - Instance of HashMap containing SFX attributes for this shape

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2,
                     int thickness,
                     java.awt.Color c)
This method supports the drawing of a line with the given thickness and color.

Specified by:
drawLine in interface GaugeRenderer
Parameters:
x1 - The first point's x coordinate
y1 - The first point's y coordinate
x2 - The second point's x coordinate
y2 - The second point's y coordinate
thickness - Width of the line in pixels
c - Color instance indicating the color of the line.

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2,
                     java.awt.Color c)
This method supports the drawing of a line with the given color. The line drawn will have a default thickness of 1 pixel.

Specified by:
drawLine in interface GaugeRenderer
Parameters:
x1 - The first point's x coordinate
y1 - The first point's y coordinate
x2 - The second point's x coordinate
y2 - The second point's y coordinate
c - Color instance indicating the color of the line

drawString

public void drawString(DrawableObject.Label labelObj,
                       int x,
                       int y,
                       java.awt.Font f,
                       java.awt.Color c,
                       double angle)
This method supports the drawing of text in the given color at the location specified by the point at x1 and y1.

Specified by:
drawString in interface GaugeRenderer
Parameters:
label - String instance representing the text to draw
x - The first point's x coordinate
y - The first point's y coordinate
f - Font instance indicating the color of the line
c - Color instance indicating the color of the line
angle - The text rotation angle of the label

drawImage

public void drawImage(java.lang.String imgURL,
                      java.awt.Image image,
                      int x,
                      int y,
                      int width,
                      int height,
                      java.awt.image.ImageObserver imgObs)
This method supports the drawing of an image.

Specified by:
drawImage in interface GaugeRenderer
Parameters:
imgURL - String instance used to load image
image - Instance of Image to draw; can be null
x - x coordinate of image's top corner
y - y coordinate of image's top corner
width - width of image
height - height of image
imgObs - Instance of ImageObserver; can be null

applyTransform

public void applyTransform(java.awt.geom.AffineTransform transform)
This method allows an application of the given AffineTransform object.

Specified by:
applyTransform in interface GaugeRenderer
Parameters:
transform - AffineTransform instance to apply

getTransform

public java.awt.geom.AffineTransform getTransform()
This method gets the current AffineTransform object.

Specified by:
getTransform in interface GaugeRenderer
Returns:
Instance of AffineTransform

setTransform

public void setTransform(java.awt.geom.AffineTransform transform)
This method allows an reset of the current transform to the given AffineTransform object.

Specified by:
setTransform in interface GaugeRenderer
Parameters:
transform - AffineTransform instance to set

getBeanName

public java.lang.String getBeanName()
Overrides:
getBeanName in class oracle.dss.presutil.SVGWriter
Returns:
gauge bean name
For internal use only. Application developers should not use this
Get the name of the gauge bean. This method is intended for use by ADF Faces Gauge, which will return the clientId.

getFilteredBeanName

public java.lang.String getFilteredBeanName()
Overrides:
getFilteredBeanName in class oracle.dss.presutil.SVGWriter
Returns:
filtered gauge bean name
For internal use only. Application developers should not use this
Get the filtered name of the gauge bean, which can be used in javascript variable names. This method is intended for use by ADF Faces Gauge, which will return the clientId with instances of ':' replaced with '_'.

getSimpleBeanName

public java.lang.String getSimpleBeanName()
Overrides:
getSimpleBeanName in class oracle.dss.presutil.SVGWriter
Returns:
simple gauge bean name
For internal use only. Application developers should not use this
Get the simple name of the gauge bean. This method is intended for use by ADF Faces Gauge, which will return the id, instead of the entire clientId.

getClickEventJS

public java.lang.String getClickEventJS()
Get the javascript to fire a click event. This method returns null; subclasses should override to return working javascript.

Returns:
javascript to fire a click event

isOnClickPresent

public boolean isOnClickPresent()
Determine whether an onClick attribute is specified. This method returns false; subclasses should override to return true or false as necessary.

Returns:
true if onClick is specified, false otherwise

isOnMouseOverOutPresent

public boolean isOnMouseOverOutPresent()
Determine whether the onMouseOver or onMouseOut attribute is specified in ShapeAttributes. This method returns false; subclasses should override to return true or false as necessary.

Returns:
true if onMouseOver or onMouseOut is specified, false otherwise

getShapeAttributesAlt

public java.lang.String getShapeAttributesAlt()
Get a specified alt attribute value. This method returns null; subclasses should override to return the specified value.

Returns:
alt attribute value

getShapeAttributesTitle

public java.lang.String getShapeAttributesTitle()
Get a specified title attribute value. This method returns null; subclasses should override to return the specified value.

Returns:
title attribute value

getShapeAttributesHRef

public java.lang.String getShapeAttributesHRef()
Get a specified href attribute value. This method returns null; subclasses should override to return the specified value.

Returns:
href attribute value

getShapeAttributesTarget

public java.lang.String getShapeAttributesTarget()
Get a specified target attribute value. This method returns null; subclasses should override to return the specified value.

Returns:
target attribute value

writeShapeAttributes

public void writeShapeAttributes()
                          throws java.io.IOException,
                                 java.lang.Exception
Write optional ShapeAttributes for the current element.

Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

writeShapeAttributesScript

public void writeShapeAttributesScript()
                                throws java.io.IOException,
                                       java.lang.Exception
Write javascript related to specifying ShapeAttributes.

Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

writeLinkScript

public void writeLinkScript()
                     throws java.io.IOException,
                            java.lang.Exception
Write javascript related to specifying Links

Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

getFillAttribute

protected java.lang.String getFillAttribute(java.awt.Shape shape,
                                            java.awt.Color fillColor,
                                            oracle.dss.presutil.GradientObj gradient)
                                     throws java.io.IOException,
                                            java.lang.Exception
Calculate the value for the fill attribute for the given component.

Parameters:
sfxMap - Instance of SFX for this component
shape - Component shape
fillColor - Standard color for this component
Returns:
value to use for the fill attribute
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

writeOpacityAttribute

protected void writeOpacityAttribute(java.awt.Color color,
                                     java.lang.String attr)
                              throws java.io.IOException,
                                     java.lang.Exception
Write a fill-opacity attribute to SVG.

Parameters:
color - color of the component
attr - attribute for opacity
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

constructId

protected java.lang.String constructId(java.lang.String id)
Overrides:
constructId in class oracle.dss.presutil.SVGWriter
Parameters:
id - base id
Returns:
id unique for the component
For internal use only. Application developers should not use this
Construct an id using the given base.

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.0.0)

E17492-01

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