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

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

public class Section
extends java.lang.Object
implements ISection, IClone

This object defines a section of the report. Report areas contain at least one section. Each section within an area can be formatted differently. This object holds on to a report object, then releases the report object when it is destroyed.

Report objects can only be added to a section. Boxes and lines can cross section boundaries, but other objects cannot. When you want to add a report object, you do so by adding it to a section using the appropriate controller.


Constructor Summary
Section()
           
Section(ISection src)
           
 
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()
           
 ISectionFormat getFormat()
          Returns the section format.
 int getHeight()
          Returns the height of the section.
 AreaSectionKind getKind()
          Returns AreaSectionKind that identifies the kind of section.
 java.lang.String getName()
          Returns the name of the section.
 ReportObjects getReportObjects()
          Returns the report objects for the section.
 int getSectionCode()
          Returns the section code.
 int getWidth()
          Returns the width of the section.
 boolean hasContent(java.lang.Object srcSection)
           
 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 setFormat(ISectionFormat sectionFormat)
          Sets the section format.
 void setHeight(int height)
          Sets the height of the section.
 void setKind(AreaSectionKind kind)
          Sets the kind of section.
 void setName(java.lang.String name)
          Sets the name of the section.
 void setReportObjects(ReportObjects reportObjects)
          Set the report objects for the section.
 void setSectionCode(int sectionCode)
          Sets the section code.
 void setWidth(int width)
          Sets the width of the section.
 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

Section

public Section(ISection src)

Section

public Section()
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.


getFormat

public ISectionFormat getFormat()
Description copied from interface: ISection

Returns the section format.

Specified by:
getFormat in interface ISection
Returns:
The section kind as an ISectionFormat.

getHeight

public int getHeight()
Description copied from interface: ISection

Returns the height of the section.

Specified by:
getHeight in interface ISection
Returns:
The height of the section as an int in twips.

getKind

public AreaSectionKind getKind()
Description copied from interface: ISection

Returns AreaSectionKind that identifies the kind of section.

Specified by:
getKind in interface ISection
Returns:
The section kind as an AreaSectionKind.

getName

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

Returns the name of the section.

Specified by:
getName in interface ISection
Returns:
The name of the section as a String.

getReportObjects

public ReportObjects getReportObjects()
Description copied from interface: ISection

Returns the report objects for the section.

Specified by:
getReportObjects in interface ISection
Returns:
The report objects for the section as ReportObjects.

getSectionCode

public int getSectionCode()
Description copied from interface: ISection

Returns the section code. The section code is an int that is used to identify sections within a report.

Specified by:
getSectionCode in interface ISection
Returns:
The section code as an int.

getWidth

public int getWidth()
Description copied from interface: ISection

Returns the width of the section.

Specified by:
getWidth in interface ISection
Returns:
The width of the section as an int in twips.

hasContent

public boolean hasContent(java.lang.Object srcSection)

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

setFormat

public void setFormat(ISectionFormat sectionFormat)
Description copied from interface: ISection

Sets the section format.

Specified by:
setFormat in interface ISection
Parameters:
sectionFormat - The section kind as an ISectionFormat.

setHeight

public void setHeight(int height)
Description copied from interface: ISection

Sets the height of the section.

Specified by:
setHeight in interface ISection
Parameters:
height - The height of the section as an int in twips.

setKind

public void setKind(AreaSectionKind kind)
Description copied from interface: ISection

Sets the kind of section.

Specified by:
setKind in interface ISection
Parameters:
kind - The section kind as an AreaSectionKind.

setName

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

Sets the name of the section.

Specified by:
setName in interface ISection
Parameters:
name - The name of the section as a String.

setReportObjects

public void setReportObjects(ReportObjects reportObjects)
Description copied from interface: ISection

Set the report objects for the section.

Specified by:
setReportObjects in interface ISection
Parameters:
reportObjects - The report objects for the section as ReportObjects.

setSectionCode

public void setSectionCode(int sectionCode)
Description copied from interface: ISection

Sets the section code. The section code is an int that is used to identify sections within a report.

Specified by:
setSectionCode in interface ISection
Parameters:
sectionCode - The section code as an int.

setWidth

public void setWidth(int width)
Description copied from interface: ISection

Sets the width of the section.

Specified by:
setWidth in interface ISection
Parameters:
width - The width of the section as an int in twips.

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)