oracle.dss.dataView

Interface ExportableGraph

All Known Implementing Classes:

Graph

public interface ExportableGraph

For internal use only. Application developers should not use this

This interface defines methods that an export engine can call to export a Graph.

Method Summary

Modifier and Type	Method and Description
void	endExport()
boolean	exportGraphToStream(java.io.OutputStream out)
DataviewCommon	getDataviewCommon()
java.awt.Dimension	getImageSize()
ViewStyle	getMetadataStyle(java.lang.Object metaData, ViewStyle initStyle, int edge, int depth, int index)
int	getPagingControlPosition()
ViewStyle	getPagingControlViewStyle()
boolean	isExporting()
boolean	isPagingControlVisible()
boolean	startExport()

Method Detail

getDataviewCommon

DataviewCommon getDataviewCommon()

Returns:

view being exported

For internal use only. Application developers should not use this

Get the view being exported.

getMetadataStyle

ViewStyle getMetadataStyle(java.lang.Object metaData,
                           ViewStyle initStyle,
                           int edge,
                           int depth,
                           int index)

Parameters:

metaData - member metadata

initStyle - initial ViewStyle for the member

edge - edge member is on

depth - layer member is in

index - slice member is in

Returns:

resulting ViewStyle for the given member

For internal use only. Application developers should not use this

Get the resulting ViewStyle for the given member.

getPagingControlViewStyle

ViewStyle getPagingControlViewStyle()

Returns:

default paging control ViewStyle

For internal use only. Application developers should not use this

Get the default paging control ViewStyle.

exportGraphToStream

boolean exportGraphToStream(java.io.OutputStream out)

Parameters:

out - OutputStream object to use in exporting the graph

Returns:

boolean True if the export completed successfully, False otherwise

For internal use only. Application developers should not use this

Called when the graph must be rendered to the provided OutputStream

isPagingControlVisible

boolean isPagingControlVisible()

Returns:

boolean True if the paging controls are visible, False otherwise

See Also:

Dataview

For internal use only. Application developers should not use this

Called to determine is the paging controls are visible.

getPagingControlPosition

int getPagingControlPosition()

Returns:

int Position of paging controls relative to dataview titles; Constants beginning with PAGING_CONTROL in DataView class

See Also:

Dataview

For internal use only. Application developers should not use this

Called to determine the paging control position relative to dataview titles

startExport

boolean startExport()

Returns:

true if the view can begin exporting, false if not

For internal use only. Application developers should not use this

Inform the view that an export has started.

endExport

void endExport()

For internal use only. Application developers should not use this

Inform the view that an export has ended.

isExporting

boolean isExporting()

Returns:

true if exporting, false if not

For internal use only. Application developers should not use this

Determine if this view is currently exporting to Excel.

getImageSize

java.awt.Dimension getImageSize()

Returns:

Dimension Width and Height of image being exported

For internal use only. Application developers should not use this

Return the size of the graph image being exported.