oracle.dss.dataView

Class XMLWriterCallback

java.lang.Object

oracle.dss.dataView.XMLWriterCallback

Direct Known Subclasses:

GaugeXMLWriterCallback, GraphXMLWriterCallback

public abstract class XMLWriterCallback
extends java.lang.Object

Defines a callback used for providing additional information while rendering Flash XML. Applications developers generally do not need to use this class.

Since:

release specific (what release of product did this appear in)

Constructor Summary

Constructors

Constructor and Description
XMLWriterCallback()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCustomProperty() Optional hook for adding an additional property string to an object.
abstract java.lang.String	getId() Returns the id of the component that owns this callback.
java.lang.String	getMarshallerFunctionName() Returns the name of the JavaScript function used to marshall events to the server.
java.lang.String	getOnClickJavaScript() Optional hook for specifying JavaScript that will be called when an object is clicked.
boolean	isAutomaticNewLines() Specifies whether new line characters will be automatically inserted into the XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLWriterCallback

public XMLWriterCallback()

Method Detail

getId

public abstract java.lang.String getId()

Returns the id of the component that owns this callback. This method is used with getMarshallerFunctionName to provide support for component events.

Returns:

the id of the owning component

See Also:

getMarshallerFunctionName()

getMarshallerFunctionName

public java.lang.String getMarshallerFunctionName()

Returns the name of the JavaScript function used to marshall events to the server. This JavaScript function will be called with the following parameters:

1. the id provided in getId
2. an Object containing the component payload for the event

The payload Object will contain an arbitrary number of properties. The property-value pairs should be encoded and sent to the server, where the component would recieve them as a Map of (String,String) pairs.

The default implementation of this method returns null, which means that no JavaScript call will be made, and the event will be ignored.

Returns:

the name of the JavaScript marshalling function

See Also:

getId()

getCustomProperty

public java.lang.String getCustomProperty()

Optional hook for adding an additional property string to an object. This method will be called for each object that is being rendered. When an event is surfaced from an object, this value will be provided.

Returns:

the String containing to add to the object

getOnClickJavaScript

public java.lang.String getOnClickJavaScript()

Optional hook for specifying JavaScript that will be called when an object is clicked. This method will be called for each object that is being rendered.

Returns:

the String containing the JavaScript to call when the current object is clicked

isAutomaticNewLines

public boolean isAutomaticNewLines()

Specifies whether new line characters will be automatically inserted into the XML. Returns true by default for more readable XML.

Returns:

true if new lines are automatically inserted into the XML, false if not