com.crystaldecisions.report.htmlrender
Class BeforeRenderObjectEvent

java.lang.Object
  |
  +--RenderEventObjectBase
        |
        +--com.crystaldecisions.report.htmlrender.BeforeRenderObjectEvent

public class BeforeRenderObjectEvent

extends RenderEventObjectBase

This class provides arguments for the BeforeRenderObjectEventListener. The event occurs when the report object rendering process starts.

See Also:

Serialized Form

Constructor Summary

BeforeRenderObjectEvent(java.lang.Object source)

Method Summary

java.lang.String	getAttribute() For internal use only.
java.lang.Object	getObject() Returns the report object to be cached.
java.lang.String	getOnBlurHandler() Returns the JavaScript code that is executed when the contents of an object are made to appear out of focus.
java.lang.String	getOnClickHandler() Returns the JavaScript code that is executed when an object is clicked.
java.lang.String	getOnContextMenuHandler() Returns the JavaScript code that is executed when the context menu is displayed.
java.lang.String	getOnDBClickHandler() Returns the JavaScript code that is executed when an object is double-clicked.
java.lang.String	getOnDragEndHandler() Returns the JavaScript code that is executed at the end of a drag operation.
java.lang.String	getOnDragEnterHandler() Returns the JavaScript code that is executed when an object is dragged into the controls bounds.
java.lang.String	getOnDragHandler() Returns the JavaScript code that is executed during a drag operation.
java.lang.String	getOnDragLeaveHandler() Returns the JavaScript code that is executed when an object is dragged out of the controls bounds.
java.lang.String	getOnDragOverHandler() Returns the JavaScript code that is executed when a control is being dragged over a target object.
java.lang.String	getOnDragStartHandler() Returns the JavaScript code that is executed at the start of a drag operation.
java.lang.String	getOnDropHandler() Returns the JavaScript code that is executed when the drag and drop operation is complete.
java.lang.String	getOnFocusHandler() Returns the JavaScript code that is executed when the object receives focus.
java.lang.String	getOnFocusInHandler() Returns the JavaScript code that is executed just prior to the object receiving focus.
java.lang.String	getOnFocusOutHandler() Returns the JavaScript code that is executed immediately after the object loses focus.
java.lang.String	getOnKeyDownHandler() Returns the JavaScript code that is executed when an alphanumeric key is pressed.
java.lang.String	getOnKeyPressHandler() Returns the JavaScript code that is executed when a key is pressed.
java.lang.String	getOnKeyUpHandler() Returns the JavaScript code that is executed when a key is released.
java.lang.String	getOnMouseDownHandler() Returns the JavaScript code that is executed when an object is clicked with either mouse button.
java.lang.String	getOnMouseEnterHandler() Returns the JavaScript code that is executed when the mouse pointer is moved into the boundaries of an object.
java.lang.String	getOnMouseLeaveHandler() Returns the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.
java.lang.String	getOnMouseMoveHandler() Returns the JavaScript code that is executed when the mouse pointer is moved over an object.
java.lang.String	getOnMouseOutHandler() Returns the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.
java.lang.String	getOnMouseOverHandler() Returns the JavaScript code that is executed when the mouse pointer is moved into an object.
java.lang.String	getOnMouseUpHandler() Returns the JavaScript code that is executed when either mouse button is released over an object.
java.lang.String	getOnSelectHandler() Returns the JavaScript code that is executed when the current selection changes.
java.lang.String	getOnSelectionChangeHandler() Returns the JavaScript code that is executed when the selection state of the document changes.
java.lang.String	getOnSelectStartHandler() Returns the JavaScript code that is executed when the object is being selected.
java.lang.String	getOnStopHandler() Returns the JavaScript code that is executed when the user clicks the stop button or leaves the web page.
void	setAttribute(java.lang.String value) For internal use only.
void	setObject(java.lang.Object value) Sets the report object to be cached.
void	setOnBlurHandler(java.lang.String value) Sets the JavaScript code that is executed when the contents of an object are made to appear out of focus.
void	setOnClickHandler(java.lang.String value) Sets the JavaScript code that is executed when an object is clicked.
void	setOnContextMenuHandler(java.lang.String value) Sets the JavaScript code that is executed when the context menu is displayed.
void	setOnDBClickHandler(java.lang.String value) Sets the JavaScript code that is executed when an object is double-clicked.
void	setOnDragEndHandler(java.lang.String value) Sets the JavaScript code that is executed at the end of a drag operation.
void	setOnDragEnterHandler(java.lang.String value) Sets the JavaScript code that is executed when an object is dragged into the controls bounds.
void	setOnDragHandler(java.lang.String value) Sets the JavaScript code that is executed during a drag operation.
void	setOnDragLeaveHandler(java.lang.String value) Sets the JavaScript code that is executed when an object is dragged out of the controls bounds.
void	setOnDragOverHandler(java.lang.String value) Sets the JavaScript code that is executed when a control is being dragged over a target object.
void	setOnDragStartHandler(java.lang.String value) Sets the JavaScript code that is executed at the start of a drag operation.
void	setOnDropHandler(java.lang.String value) Sets the JavaScript code that is executed when the drag and drop operation is complete.
void	setOnFocusHandler(java.lang.String value) Sets the JavaScript code that is executed when the object receives focus.
void	setOnFocusInHandler(java.lang.String value) Sets the JavaScript code that is executed just prior to the object receiving focus.
void	setOnFocusOutHandler(java.lang.String value) Sets the JavaScript code that is executed immediately after the object loses focus.
void	setOnKeyDownHandler(java.lang.String value) Sets the JavaScript code that is executed when an alphanumeric key is pressed.
void	setOnKeyPressHandler(java.lang.String value) Sets the JavaScript code that is executed when a key is pressed.
void	setOnKeyUpHandler(java.lang.String value) Sets the JavaScript code that is executed when a key is released.
void	setOnMouseDownHandler(java.lang.String value) Sets the JavaScript code that is executed when an object is clicked with either mouse button.
void	setOnMouseEnterHandler(java.lang.String value) Sets the JavaScript code that is executed when the mouse pointer is moved into the boundaries of an object.
void	setOnMouseLeaveHandler(java.lang.String value) Sets the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.
void	setOnMouseMoveHandler(java.lang.String value) Sets the JavaScript code that is executed when the mouse pointer is moved over an object.
void	setOnMouseOutHandler(java.lang.String value) Sets the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.
void	setOnMouseOverHandler(java.lang.String value) Sets the JavaScript code that is executed when the mouse pointer is moved into an object.
void	setOnMouseUpHandler(java.lang.String value) Sets the JavaScript code that is executed when either mouse button is released over an object.
void	setOnSelectHandler(java.lang.String value) Sets the JavaScript code that is executed when the current selection changes.
void	setOnSelectionChangeHandler(java.lang.String value) Sets the JavaScript code that is executed when the selection state of the document changes.
void	setOnSelectStartHandler(java.lang.String value) Sets the JavaScript code that is executed when the object is being selected.
void	setOnStopHandler(java.lang.String value) Sets the JavaScript code that is executed when the user clicks the stop button or leaves the web page.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeforeRenderObjectEvent

public BeforeRenderObjectEvent(java.lang.Object source)

Method Detail

getAttribute

public java.lang.String getAttribute()

For internal use only.

getObject

public java.lang.Object getObject()

Returns the report object to be cached. This can be a com.crystaldecisions.sdk.occa.report.definition.FieldObject, com.crystaldecisions.sdk.occa.report.definition.TextObject, com.crystaldecisions.sdk.occa.report.definition ChartObject, and so on.

Returns:

The report object to be cached as an Object.

See Also:

setObject

getOnBlurHandler

public java.lang.String getOnBlurHandler()

Returns the JavaScript code that is executed when the contents of an object are made to appear out of focus.

Returns:

The JavaScript code as a String.

See Also:

setOnBlurHandler

getOnClickHandler

public java.lang.String getOnClickHandler()

Returns the JavaScript code that is executed when an object is clicked.

Returns:

The JavaScript code as a String.

See Also:

setOnClickHandler

getOnContextMenuHandler

public java.lang.String getOnContextMenuHandler()

Returns the JavaScript code that is executed when the context menu is displayed.

Returns:

The JavaScript code as a String.

See Also:

setOnContextMenuHandler

getOnDBClickHandler

public java.lang.String getOnDBClickHandler()

Returns the JavaScript code that is executed when an object is double-clicked.

Returns:

The JavaScript code as a String.

See Also:

setOnDBClickHandler

getOnDragEndHandler

public java.lang.String getOnDragEndHandler()

Returns the JavaScript code that is executed at the end of a drag operation.

Returns:

The JavaScript code as a String.

See Also:

setOnDragEndHandler

getOnDragEnterHandler

public java.lang.String getOnDragEnterHandler()

Returns the JavaScript code that is executed when an object is dragged into the controls bounds.

Returns:

The JavaScript code as a String.

See Also:

setOnDragEnterHandler

getOnDragHandler

public java.lang.String getOnDragHandler()

Returns the JavaScript code that is executed during a drag operation.

Note: The code is cached on the client in the HTML page.

Returns:

The JavaScript code as a String.

See Also:

setOnDragHandler

getOnDragLeaveHandler

public java.lang.String getOnDragLeaveHandler()

Returns the JavaScript code that is executed when an object is dragged out of the controls bounds.

Returns:

The JavaScript code as a String.

See Also:

setOnDragLeaveHandler

getOnDragOverHandler

public java.lang.String getOnDragOverHandler()

Returns the JavaScript code that is executed when a control is being dragged over a target object.

Returns:

The JavaScript code as a String.

See Also:

setOnDragOverHandler

getOnDragStartHandler

public java.lang.String getOnDragStartHandler()

Returns the JavaScript code that is executed at the start of a drag operation.

Returns:

The JavaScript code as a String.

See Also:

setOnDragStartHandler

getOnDropHandler

public java.lang.String getOnDropHandler()

Returns the JavaScript code that is executed when the drag and drop operation is complete.

Returns:

The JavaScript code as a String.

See Also:

setOnDropHandler

getOnFocusHandler

public java.lang.String getOnFocusHandler()

Returns the JavaScript code that is executed when the object receives focus.

Returns:

The JavaScript code as a String.

See Also:

setOnFocusHandler

getOnFocusInHandler

public java.lang.String getOnFocusInHandler()

Returns the JavaScript code that is executed just prior to the object receiving focus.

Returns:

The JavaScript code as a String.

See Also:

setOnFocusInHandler

getOnFocusOutHandler

public java.lang.String getOnFocusOutHandler()

Returns the JavaScript code that is executed immediately after the object loses focus.

Returns:

The JavaScript code as a String.

See Also:

setOnFocusOutHandler

getOnKeyDownHandler

public java.lang.String getOnKeyDownHandler()

Returns the JavaScript code that is executed when an alphanumeric key is pressed.

Returns:

The JavaScript code as a String.

See Also:

setOnKeyDownHandler

getOnKeyPressHandler

public java.lang.String getOnKeyPressHandler()

Returns the JavaScript code that is executed when a key is pressed.

Returns:

The JavaScript code as a String.

See Also:

setOnKeyPressHandler

getOnKeyUpHandler

public java.lang.String getOnKeyUpHandler()

Returns the JavaScript code that is executed when a key is released.

Returns:

The JavaScript code as a String.

See Also:

setOnKeyUpHandler

getOnMouseDownHandler

public java.lang.String getOnMouseDownHandler()

Returns the JavaScript code that is executed when an object is clicked with either mouse button.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseDownHandler

getOnMouseEnterHandler

public java.lang.String getOnMouseEnterHandler()

Returns the JavaScript code that is executed when the mouse pointer is moved into the boundaries of an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseEnterHandler

getOnMouseLeaveHandler

public java.lang.String getOnMouseLeaveHandler()

Returns the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseLeaveHandler

getOnMouseMoveHandler

public java.lang.String getOnMouseMoveHandler()

Returns the JavaScript code that is executed when the mouse pointer is moved over an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseMoveHandler

getOnMouseOutHandler

public java.lang.String getOnMouseOutHandler()

Returns the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseOutHandler

getOnMouseOverHandler

public java.lang.String getOnMouseOverHandler()

Returns the JavaScript code that is executed when the mouse pointer is moved into an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseOverHandler

getOnMouseUpHandler

public java.lang.String getOnMouseUpHandler()

Returns the JavaScript code that is executed when either mouse button is released over an object.

Returns:

The JavaScript code as a String.

See Also:

setOnMouseUpHandler

getOnSelectHandler

public java.lang.String getOnSelectHandler()

Returns the JavaScript code that is executed when the current selection changes.

Returns:

The JavaScript code as a String.

See Also:

setOnSelectHandler

getOnSelectionChangeHandler

public java.lang.String getOnSelectionChangeHandler()

Returns the JavaScript code that is executed when the selection state of the document changes.

Returns:

The JavaScript code as a String.

See Also:

setOnSelectionChangeHandler

getOnSelectStartHandler

public java.lang.String getOnSelectStartHandler()

Returns the JavaScript code that is executed when the object is being selected.

Returns:

The JavaScript code as a String.

See Also:

setOnSelectStartHandler

getOnStopHandler

public java.lang.String getOnStopHandler()

Returns the JavaScript code that is executed when the user clicks the stop button or leaves the web page.

Returns:

The JavaScript code as a String.

See Also:

setOnStopHandler

setAttribute

public void setAttribute(java.lang.String value)

For internal use only.

setObject

public void setObject(java.lang.Object value)

Sets the report object to be cached. This can be a com.crystaldecisions.sdk.occa.report.definition.FieldObject, com.crystaldecisions.sdk.occa.report.definition.TextObject, com.crystaldecisions.sdk.occa.report.definition ChartObject, and so on.

Parameters:

value - An Object that represents the report object to be cached.

See Also:

getObject

setOnBlurHandler

public void setOnBlurHandler(java.lang.String value)

Sets the JavaScript code that is executed when the contents of an object are made to appear out of focus.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnBlurHandler

setOnClickHandler

public void setOnClickHandler(java.lang.String value)

Sets the JavaScript code that is executed when an object is clicked.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnClickHandler

setOnContextMenuHandler

public void setOnContextMenuHandler(java.lang.String value)

Sets the JavaScript code that is executed when the context menu is displayed.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnContextMenuHandler

setOnDBClickHandler

public void setOnDBClickHandler(java.lang.String value)

Sets the JavaScript code that is executed when an object is double-clicked.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDBClickHandler

setOnDragEndHandler

public void setOnDragEndHandler(java.lang.String value)

Sets the JavaScript code that is executed at the end of a drag operation.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragEndHandler

setOnDragEnterHandler

public void setOnDragEnterHandler(java.lang.String value)

Sets the JavaScript code that is executed when an object is dragged into the controls bounds.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragEnterHandler

setOnDragHandler

public void setOnDragHandler(java.lang.String value)

Sets the JavaScript code that is executed during a drag operation.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragHandler

setOnDragLeaveHandler

public void setOnDragLeaveHandler(java.lang.String value)

Sets the JavaScript code that is executed when an object is dragged out of the controls bounds.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragLeaveHandler

setOnDragOverHandler

public void setOnDragOverHandler(java.lang.String value)

Sets the JavaScript code that is executed when a control is being dragged over a target object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragOverHandler

setOnDragStartHandler

public void setOnDragStartHandler(java.lang.String value)

Sets the JavaScript code that is executed at the start of a drag operation.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDragStartHandler

setOnDropHandler

public void setOnDropHandler(java.lang.String value)

Sets the JavaScript code that is executed when the drag and drop operation is complete.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnDropHandler

setOnFocusHandler

public void setOnFocusHandler(java.lang.String value)

Sets the JavaScript code that is executed when the object receives focus.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnFocusHandler

setOnFocusInHandler

public void setOnFocusInHandler(java.lang.String value)

Sets the JavaScript code that is executed just prior to the object receiving focus.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnFocusInHandler

setOnFocusOutHandler

public void setOnFocusOutHandler(java.lang.String value)

Sets the JavaScript code that is executed immediately after the object loses focus.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnFocusOutHandler

setOnKeyDownHandler

public void setOnKeyDownHandler(java.lang.String value)

Sets the JavaScript code that is executed when an alphanumeric key is pressed.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnKeyDownHandler

setOnKeyPressHandler

public void setOnKeyPressHandler(java.lang.String value)

Sets the JavaScript code that is executed when a key is pressed.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnKeyPressHandler

setOnKeyUpHandler

public void setOnKeyUpHandler(java.lang.String value)

Sets the JavaScript code that is executed when a key is released.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnKeyUpHandler

setOnMouseDownHandler

public void setOnMouseDownHandler(java.lang.String value)

Sets the JavaScript code that is executed when an object is clicked with either mouse button.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseDownHandler

setOnMouseEnterHandler

public void setOnMouseEnterHandler(java.lang.String value)

Sets the JavaScript code that is executed when the mouse pointer is moved into the boundaries of an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseEnterHandler

setOnMouseLeaveHandler

public void setOnMouseLeaveHandler(java.lang.String value)

Sets the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseLeaveHandler

setOnMouseMoveHandler

public void setOnMouseMoveHandler(java.lang.String value)

Sets the JavaScript code that is executed when the mouse pointer is moved over an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseMoveHandler

setOnMouseOutHandler

public void setOnMouseOutHandler(java.lang.String value)

Sets the JavaScript code that is executed when the mouse pointer is moved outside of the boundaries of an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseOutHandler

setOnMouseOverHandler

public void setOnMouseOverHandler(java.lang.String value)

Sets the JavaScript code that is executed when the mouse pointer is moved into an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseOverHandler

setOnMouseUpHandler

public void setOnMouseUpHandler(java.lang.String value)

Sets the JavaScript code that is executed when either mouse button is released over an object.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnMouseUpHandler

setOnSelectHandler

public void setOnSelectHandler(java.lang.String value)

Sets the JavaScript code that is executed when the current selection changes.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnSelectHandler

setOnSelectionChangeHandler

public void setOnSelectionChangeHandler(java.lang.String value)

Sets the JavaScript code that is executed when the selection state of the document changes.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnSelectionChangeHandler

setOnSelectStartHandler

public void setOnSelectStartHandler(java.lang.String value)

Sets the JavaScript code that is executed when the object is being selected.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnSelectStartHandler

setOnStopHandler

public void setOnStopHandler(java.lang.String value)

Sets the JavaScript code that is executed when the user clicks the stop button or leaves the web page.

Note: The code is cached on the client in the HTML page.

Parameters:

value - A String that specifies the JavaScript code.

See Also:

getOnStopHandler