com.crystaldecisions.sdk.occa.report.application
Class AdvancedClientDocumentEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.crystaldecisions.sdk.occa.report.application.AdvancedClientDocumentEvent
All Implemented Interfaces:
java.io.Serializable

public class AdvancedClientDocumentEvent
extends java.util.EventObject

This class defines an event that represents a change to the report, including the name of the modified report object, the subreport name and the section name where the change occurred.

See Also:
IAdvancedClientDocumentEventListener, Serialized Form

Constructor Summary
AdvancedClientDocumentEvent(ClientDocument clientDoc, ClientDocumentChangeType changeType, java.lang.String objectName, java.lang.String hostName, java.lang.String reportName)
          Creates a new AdvancedClientDocument that defines a change to the report.
 
Method Summary
 ClientDocumentChangeType getChangeType()
          Returns the type of change.
 java.lang.String getHostName()
          Returns the name of the section that contains the modified report object.
 java.lang.String getObjectName()
          Returns the name of the object that was modified.
 java.lang.String getReportName()
          Returns the name of the report where the event occurred.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AdvancedClientDocumentEvent

public AdvancedClientDocumentEvent(ClientDocument clientDoc,
                                   ClientDocumentChangeType changeType,
                                   java.lang.String objectName,
                                   java.lang.String hostName,
                                   java.lang.String reportName)
Creates a new AdvancedClientDocument that defines a change to the report.

Parameters:
clientDoc - the ClientDocument that generated the event
changeType - a ClientDocumentChangeType object that describes the type of change
objectName - the name of the modified report object
hostName - the section of the report that contains the modified report object
reportName - the name of the subreport that contains the modified report object, or the empty string if the report object is contained in the main report
Method Detail

getChangeType

public ClientDocumentChangeType getChangeType()
Returns the type of change.

Returns:
the type of change

getObjectName

public java.lang.String getObjectName()
Returns the name of the object that was modified.

Returns:
the name of the object that was modified

getHostName

public java.lang.String getHostName()
Returns the name of the section that contains the modified report object.

Returns:
the name of a report section

getReportName

public java.lang.String getReportName()
Returns the name of the report where the event occurred.

Returns:
the name of the subreport where the event occurred, or an empty string if the event occurred in the main report