com.crystaldecisions.sdk.occa.report.definition
Class ReportPartID

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportPartID
All Implemented Interfaces:
IReportPartID, IClone

public class ReportPartID
extends java.lang.Object
implements IReportPartID, IClone

This object is used to identify a report part within the report. Report parts include chart, text, and field objects. You need to specify the name and the data context of the object.


Constructor Summary
ReportPartID()
           
ReportPartID(IReportPartID src)
           
ReportPartID(ReportPartID part)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
          For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 ControllableMixin getControllableMixin()
           
 java.lang.String getDataContext()
          Returns a data subtree in the report.
 java.lang.String getName()
          Returns the name of the report part.
 boolean hasContent(java.lang.Object srcReportPartID)
           
 boolean isDirectlyControllable()
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setDataContext(java.lang.String dataContext)
          Sets a data subtree in the report.
 void setName(java.lang.String name)
          Sets the name of the report part.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportPartID

public ReportPartID(IReportPartID src)

ReportPartID

public ReportPartID()

ReportPartID

public ReportPartID(ReportPartID part)
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getDataContext

public java.lang.String getDataContext()
Description copied from interface: IReportPartID

Returns a data subtree in the report. The data context represents the whole group tree or a sub tree in the group tree. DataContext can be specified using either strings or integers to narrow down the search for the report object. For example, "/Country[USA]/Region[CA]" or "2-1". You can use a wildcard (*) in the last position only. For example, "/Country[USA]/ Region[CA]/*" or "2-1-*".

Specified by:
getDataContext in interface IReportPartID
Returns:
The data subtree name of the report part as a String.

getName

public java.lang.String getName()
Description copied from interface: IReportPartID

Returns the name of the report part.

Specified by:
getName in interface IReportPartID
Returns:
The name of the report part as a String.

hasContent

public boolean hasContent(java.lang.Object srcReportPartID)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setDataContext

public void setDataContext(java.lang.String dataContext)
Description copied from interface: IReportPartID

Sets a data subtree in the report. The data context represents the whole group tree or a sub tree in the group tree. DataContext can be specified using either strings or integers to narrow down the search for the report object. For example, "/Country[USA]/Region[CA]" or "2-1". You can use a wildcard (*) in the last position only. For example, "/Country[USA]/ Region[CA]/*" or "2-1-*".

Specified by:
setDataContext in interface IReportPartID
Parameters:
dataContext - The data subtree name of the report part as a String.

setName

public void setName(java.lang.String name)
Description copied from interface: IReportPartID

Sets the name of the report part.

Specified by:
setName in interface IReportPartID
Parameters:
name - The name of the report part as a String.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)