com.crystaldecisions.sdk.occa.report.data
Class HierarchicalOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.HierarchicalOptions
All Implemented Interfaces:
IHierarchicalOptions, IClone

public class HierarchicalOptions
extends java.lang.Object
implements IHierarchicalOptions, IClone

This object is used to store options for hierarchical grouping.

See Also:
IGroupOptions.setHierarchicalOptions(IHierarchicalOptions)

Constructor Summary
HierarchicalOptions()
          Creates a new HierarchicalOptions object.
HierarchicalOptions(IHierarchicalOptions src)
          Copies a given IHierarchicalOptions object.
 
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)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 ControllableMixin getControllableMixin()
          For internal use only.
 int getGroupIndent()
          Returns the group indent.
 IField getParentIDField()
          Returns the parent ID field used in the hierarchical sorting.
 boolean hasContent(java.lang.Object srcHierarchicalOptions)
           
 boolean isDirectlyControllable()
          For internal use only.
 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 setGroupIndent(int groupIndent)
          Sets the group indent.
 void setParentIDField(IField parentField)
          Sets the parent ID field used in the hierarchical sorting.
 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

HierarchicalOptions

public HierarchicalOptions(IHierarchicalOptions src)
Copies a given IHierarchicalOptions object. This method makes a deep copy of the src object.

Parameters:
src - the source object to copy

HierarchicalOptions

public HierarchicalOptions()
Creates a new HierarchicalOptions object.

Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

hasContent

public boolean hasContent(java.lang.Object srcHierarchicalOptions)

startElement

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


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.


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

getParentIDField

public IField getParentIDField()
Description copied from interface: IHierarchicalOptions
Returns the parent ID field used in the hierarchical sorting.

Specified by:
getParentIDField in interface IHierarchicalOptions
Returns:
The parent field as an IField.

getGroupIndent

public int getGroupIndent()
Description copied from interface: IHierarchicalOptions
Returns the group indent.

Specified by:
getGroupIndent in interface IHierarchicalOptions
Returns:
The gourp indent in twips as an int.

setParentIDField

public void setParentIDField(IField parentField)
Description copied from interface: IHierarchicalOptions
Sets the parent ID field used in the hierarchical sorting.

Specified by:
setParentIDField in interface IHierarchicalOptions
Parameters:
parentField - The parent field in twips as an IField.

setGroupIndent

public void setGroupIndent(int groupIndent)
Description copied from interface: IHierarchicalOptions
Sets the group indent.

Specified by:
setGroupIndent in interface IHierarchicalOptions
Parameters:
groupIndent - The group indent in twips as an int.

getControllableMixin

public ControllableMixin getControllableMixin()
For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)
For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.