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

E12063-04

oracle.dss.dataView
Interface ImageView

All Superinterfaces:
oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, DataviewAttributes, DataviewCommon
All Known Implementing Classes:
CommonGauge, CommonGraph

public interface ImageView
extends DataviewAttributes, DataviewCommon

Image-based BI Beans views should implement this interface to ensure provide export to PNG and SVG and other image-related features.

Since:
4.0

Field Summary
static java.lang.String a_imageHeight
           
static java.lang.String a_imageWidth
           
static int SVG_HEADERS_ALL
          SvgHeaders: all.
static int SVG_HEADERS_NONE
          SvgHeaders: none.
static int SVG_MODE_BASIC
          SVG mode to simply render the Graph as static SVG.
static int SVG_MODE_DATA_SCROLLING
           
static int SVG_MODE_DATA_ZOOMING
           
static int SVG_MODE_DRILLING
           
static int SVG_MODE_FONT_EMBEDDING
           
static int SVG_MODE_FULL
          SVG mode to render the Graph as interactive SVG.
static int SVG_MODE_METADATA
           
static int SVG_MODE_NO_HEADER
           
static int SVG_MODE_SHAPE_ATTRIBUTES
           
static int SVG_MODE_TIME_AXIS_EVENT
           
static int SVG_MODE_TOOLTIPS
           
 
Method Summary
 void exportToFlash(java.io.OutputStream os, boolean renderDynamic, boolean showDrawing)
          Deprecated.  
 void exportToPNG(java.io.OutputStream os)
           
 void exportToPNGWithException(java.io.OutputStream os)
          Exports a snapshot of this view as a PNG image.
 void exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc)
           
 void exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc)
           
 void exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
           
 void exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc)
           
 void exportToSWFWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
           
 void exportToXMLWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
           
 void exportToXMLWithException(java.io.Writer writer, int mode, java.lang.String charEnc)
           
 java.lang.String getAlternativeText(ComponentHandle handle)
           
 int[] getDrillParameters(ComponentHandle handle)
           
 java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version, java.lang.String url)
           
 java.util.Enumeration getImagemapEnumeration(int filter)
          Required by subclasses, provides imagemap entries for tooltips and image maps
 java.awt.Dimension getImageSize()
          Retrieves the size of this view.
 int getSvgHeaders()
           
 java.util.List getSvgScriptIdList()
           
 SVGWriterProvider getSVGWriterProvider()
           
 void refreshData()
           
 void setDVTResources(DVTResources res)
          Specifies Wrapped RichBundle
 void setImageSize(java.awt.Dimension d)
          Specifies a size for this view.
 void setStylePath(java.lang.String stylePath)
           
 void setSvgHeaders(int headers)
           
 void setSVGWriterProvider(SVGWriterProvider provider)
           
 boolean setTabularData(java.util.List tableRows)
           
 
Methods inherited from interface oracle.dss.dataView.DataviewAttributes
getHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isPagingControlVisible, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPosition, setPagingControlVisible
 
Methods inherited from interface oracle.dss.presutil.CommonViewAttributes
getDescription, getLocalName, getName, setDescription, setLocalName, setName
 
Methods inherited from interface oracle.dss.dataView.DataviewCommon
createPropertyOverrideFlags, dataFormatChanged, dataStyleChanged, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getErrorHandler, getFontList, getHTMLPagingControlWidth, getIntlString, getIntlString, getLayerMetadataLabelType, getLocale, getMemberMetadataLabelType, getModel, getTokenSubstitution, getViewType, getWaitDataForRow, getZoomFactor, isDataUnformattedSupported, isDataViewFormatSupported, isHTMLPagingControlAutosubmit, isLayerMetadataLabelTypeSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isMemberMetadataLabelTypeSupported, isMetadataShortLabelSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, metadataStyleChanged, repaint, scaleFont, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setPagingControlVisible, setPropertyOverrideFlags, setTokenSubstitution, setWaitDataForRow
 
Methods inherited from interface oracle.dss.rules.ComponentTypeConverter
convertComponentTypeToInteger, convertComponentTypeToString
 

Field Detail

a_imageWidth

static final java.lang.String a_imageWidth
See Also:
Constant Field Values

a_imageHeight

static final java.lang.String a_imageHeight
See Also:
Constant Field Values

SVG_MODE_NO_HEADER

static final int SVG_MODE_NO_HEADER
See Also:
Constant Field Values

SVG_MODE_BASIC

static final int SVG_MODE_BASIC
SVG mode to simply render the Graph as static SVG.

See Also:
Constant Field Values

SVG_MODE_TOOLTIPS

static final int SVG_MODE_TOOLTIPS
See Also:
Constant Field Values

SVG_MODE_DRILLING

static final int SVG_MODE_DRILLING
See Also:
Constant Field Values

SVG_MODE_DATA_ZOOMING

static final int SVG_MODE_DATA_ZOOMING
See Also:
Constant Field Values

SVG_MODE_SHAPE_ATTRIBUTES

static final int SVG_MODE_SHAPE_ATTRIBUTES
See Also:
Constant Field Values

SVG_MODE_FONT_EMBEDDING

static final int SVG_MODE_FONT_EMBEDDING
See Also:
Constant Field Values

SVG_MODE_DATA_SCROLLING

static final int SVG_MODE_DATA_SCROLLING
See Also:
Constant Field Values

SVG_MODE_TIME_AXIS_EVENT

static final int SVG_MODE_TIME_AXIS_EVENT
See Also:
Constant Field Values

SVG_MODE_METADATA

static final int SVG_MODE_METADATA
See Also:
Constant Field Values

SVG_MODE_FULL

static final int SVG_MODE_FULL
SVG mode to render the Graph as interactive SVG.

See Also:
Constant Field Values

SVG_HEADERS_NONE

static final int SVG_HEADERS_NONE
SvgHeaders: none. Do not include header XML in exported SVG.

See Also:
Constant Field Values

SVG_HEADERS_ALL

static final int SVG_HEADERS_ALL
SvgHeaders: all. Include all header XML in exported SVG.

See Also:
Constant Field Values
Method Detail

getImageSize

java.awt.Dimension getImageSize()
Retrieves the size of this view.

Returns:
The size of the view, in a Dimension object.

setImageSize

void setImageSize(java.awt.Dimension d)
Specifies a size for this view.

Parameters:
d - The size to make the view.

refreshData

void refreshData()

getDrillParameters

int[] getDrillParameters(ComponentHandle handle)

getAlternativeText

java.lang.String getAlternativeText(ComponentHandle handle)

setTabularData

boolean setTabularData(java.util.List tableRows)
Parameters:
tableRows - List of data to plot in the image view.
Returns:
true if data is successfully set on the image view, false if there is a data problem.

exportToPNG

void exportToPNG(java.io.OutputStream os)
Parameters:
os - The OutputStream that specifies the location and name of the PNG file.
See Also:
exportToPNGWithException(java.io.OutputStream)

exportToPNGWithException

void exportToPNGWithException(java.io.OutputStream os)
                              throws oracle.dss.graph.pfj.png.PNGInvalidParameterException,
                                     java.lang.Exception
Exports a snapshot of this view as a PNG image.

Parameters:
os - The OutputStream that specifies the location and name of the PNG file.
Throws:
oracle.dss.graph.pfj.png.PNGInvalidParameterException
java.lang.Exception
See Also:
exportToPNG(java.io.OutputStream)

exportToSVG

void exportToSVG(java.io.OutputStream os,
                 int mode,
                 java.lang.String charEnc)
Parameters:
os - The OutputStream to write SVG to.
mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_
charEnc - character encoding to use for SVG

exportToSVGWithException

void exportToSVGWithException(java.io.OutputStream os,
                              int mode,
                              java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception
Parameters:
os - The OutputStream to write SVG to.
mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_
charEnc - character encoding to use for SVG
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

exportToSVG

void exportToSVG(java.io.Writer writer,
                 int mode,
                 java.lang.String charEnc)
Parameters:
writer - The Writer to write SVG to.
mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_
charEnc - character encoding to use for SVG

exportToSVGWithException

void exportToSVGWithException(java.io.Writer writer,
                              int mode,
                              java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception
Parameters:
writer - The Writer to write SVG to.
mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_
charEnc - character encoding to use for SVG
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

exportToXMLWithException

void exportToXMLWithException(java.io.OutputStream os,
                              int mode,
                              java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception
Parameters:
os - The OutputStream to write XML to.
mode - specifies what to include in XML; currently not used
charEnc - character encoding to use for XML
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

exportToXMLWithException

void exportToXMLWithException(java.io.Writer writer,
                              int mode,
                              java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception
Parameters:
writer - The Writer to write SVG to.
mode - specifies what to include in XML; currently not used
charEnc - character encoding to use for XML
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred

exportToSWFWithException

void exportToSWFWithException(java.io.OutputStream os,
                              int mode,
                              java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception
Parameters:
os - The OutputStream to write the SWF to.
mode - specifies what to include in SWF; currently not used
charEnc - character encoding to use
Throws:
java.io.IOException - if there was a problem writing to the stream
java.lang.Exception - if another problem occurred
For internal use only. Application developers should not use this
Exports a snapshot of the page that is currently displayed to the SWF file. This method first exports the view to XML, and then injects the XML into the SWF.


exportToFlash

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

Parameters:
os - the outputstream associated with the flash file
renderDynamic - Flag indicating if the rendering will be dynamic or static. For static charts, the value is false.
showDrawing - Only applicable for static charts and indicates if the drawing of the chart should be shown.

getImagemapEnumeration

java.util.Enumeration getImagemapEnumeration(int filter)
Required by subclasses, provides imagemap entries for tooltips and image maps


setStylePath

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
Parameters:
stylePath - The path of the XML to set as a style on this view.
Throws:
java.io.IOException - If there is a problem loading the specified XML file.
oracle.dss.util.xml.BIIOException - If there is a problem reading the XML file.
oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.
oracle.dss.util.xml.BIParseException - If the XML syntax is incorrect, or if the XML is not valid according to the DTD that is specified in the XML.

setSVGWriterProvider

void setSVGWriterProvider(SVGWriterProvider provider)
Parameters:
provider - Instance of SVGWriterProvider used to create an SVGWriter instance

getSVGWriterProvider

SVGWriterProvider getSVGWriterProvider()
Returns:
Instance of SVGWriterProvider used to create an SVGWriter instance

setSvgHeaders

void setSvgHeaders(int headers)
Parameters:
headers - constant indicating whether to include headers in exported SVG

getSvgHeaders

int getSvgHeaders()
Returns:
constant indicating whether to include headers in exported SVG

getSvgScriptIdList

java.util.List getSvgScriptIdList()
Returns:
list of SVG script node ids

getFlashPlayerDownloadMessageHTML

java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version,
                                                   java.lang.String url)
Parameters:
version - required version
url - URL to get the Flash player
Returns:
String message indicating that the required version of the Flash player is not installed

setDVTResources

void setDVTResources(DVTResources res)
Specifies Wrapped RichBundle


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

E12063-04

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