com.crystaldecisions.report.web.viewer
Class DrillReportPartsEventArgs

java.lang.Object
  extended byjava.util.EventObject
      extended bycom.crystaldecisions.report.web.viewer.ViewerEventArgs
          extended bycom.crystaldecisions.report.web.viewer.DrillReportPartsEventArgs
All Implemented Interfaces:
java.io.Serializable

public class DrillReportPartsEventArgs
extends ViewerEventArgs

This class provides arguments for the DrillReportPartsEventListener. The event occurs when drilling down on a report part.

See Also:
Serialized Form

Constructor Summary
DrillReportPartsEventArgs(java.lang.Object source)
           
 
Method Summary
 java.lang.String getDataContext()
          Returns the data sub tree of the report where the engine should start to look for the report object.
 ReportPartIDs getDrillDownParts()
          For internal use only.
 java.lang.String getGroupName()
          Returns the name of the group the user has drilled on.
 GroupPath getGroupPath()
          Returns the path of the group the user has drilled down on.
 java.lang.String getObjectName()
          Returns the name of the object the user has drilled down on.
 void setDataContext(java.lang.String newM_DataContext)
          Sets the data sub tree of the report where the engine should start to look for the report object.
 void setDrillDownParts(ReportPartIDs newM_DrillDownNodes)
          For internal use only.
 void setGroupName(java.lang.String newM_GroupName)
          Sets the name of the group to drill down on.
 void setGroupPath(GroupPath newM_GroupPath)
          Sets the path of the group to drill down on.
 void setObjectName(java.lang.String newM_ObjectName)
          Sets the name of the object drilled down on.
 
Methods inherited from class com.crystaldecisions.report.web.viewer.ViewerEventArgs
isHandled, setHandled
 
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

DrillReportPartsEventArgs

public DrillReportPartsEventArgs(java.lang.Object source)
Method Detail

getDataContext

public java.lang.String getDataContext()

Returns the data sub tree of the report where the engine should start to look for the report object.

Returns:
The data sub tree of the report as a String.
See Also:
setDataContext

getDrillDownParts

public ReportPartIDs getDrillDownParts()
For internal use only.


getGroupName

public java.lang.String getGroupName()

Returns the name of the group the user has drilled on.

Returns:
The name of the group the user has drilled on as a String.
See Also:
setGroupName

getGroupPath

public GroupPath getGroupPath()

Returns the path of the group the user has drilled down on.

Returns:
The path of the group the user has drilled down on as a com.crystaldecisions.sdk.occa.report.data.GroupPath object.
See Also:
setGroupPath

getObjectName

public java.lang.String getObjectName()

Returns the name of the object the user has drilled down on.

Returns:
The name of the object the user has drilled down on as a String.
See Also:
setObjectName

setDataContext

public void setDataContext(java.lang.String newM_DataContext)

Sets the data sub tree of the report where the engine should start to look for the report object.

Note: The data context can be specified using either strings or integers to describe the report nodes.

Parameters:
newM_DataContext - A String that specifies the data sub tree of the report.
See Also:
getDataContext

setDrillDownParts

public void setDrillDownParts(ReportPartIDs newM_DrillDownNodes)
For internal use only.


setGroupName

public void setGroupName(java.lang.String newM_GroupName)

Sets the name of the group to drill down on.

Parameters:
newM_GroupName - A String that specifies the name of the group to drill down on.
See Also:
setGroupName

setGroupPath

public void setGroupPath(GroupPath newM_GroupPath)

Sets the path of the group to drill down on.

Parameters:
newM_GroupPath - A GroupPath object that specifies the path of the group to drill down on.
See Also:
getGroupPath

setObjectName

public void setObjectName(java.lang.String newM_ObjectName)

Sets the name of the object drilled down on.

Note: By default, Crystal Reports generates names like "Field3" or "Text5", but you can rename them in the report designer. The name can only use alphanumeric characters and must start with an alphabetical character. No spaces are allowed.

Parameters:
newM_ObjectName - A String that specifies the name of the object drilled down on.
See Also:
getObjectName