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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.Area
All Implemented Interfaces:
IArea, IClone
Direct Known Subclasses:
MultiColumnArea

public class Area
extends java.lang.Object
implements IArea, IClone

This object implements an area in a report. An area is a group of like sections in the report (for example, Details A--Da, Details B--Db, and so on) that all share the same characteristics. Each section within the area can be formatted differently. This object allows you to retrieve information and set options for a specified area in your report.


Constructor Summary
Area()
           
Area(IArea 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()
           
 IAreaFormat getFormat()
           Returns the format of the area.
 AreaSectionKind getKind()
           Returns the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).
 java.lang.String getName()
           Returns the area name.
 Sections getSections()
           Returns the sections of the area.
 boolean hasContent(java.lang.Object srcArea)
           
 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(IAreaFormat areaFormat)
           Sets the format of the area.
 void setKind(AreaSectionKind kind)
           Sets the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).
 void setName(java.lang.String name)
           Sets the area name.
 void setSections(Sections sections)
           Sets the sections of the area.
 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

Area

public Area(IArea src)

Area

public Area()
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 IAreaFormat getFormat()
Description copied from interface: IArea

Returns the format of the area.

Specified by:
getFormat in interface IArea
Returns:
An IAreaFormat object that specifies the format of the area.

getKind

public AreaSectionKind getKind()
Description copied from interface: IArea

Returns the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).

Specified by:
getKind in interface IArea
Returns:
An AreaSectionKind object that specifies the kind of area.

getName

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

Returns the area name.

Specified by:
getName in interface IArea
Returns:
A String that specifies the area name.

getSections

public Sections getSections()
Description copied from interface: IArea

Returns the sections of the area.

Specified by:
getSections in interface IArea
Returns:
A Sections object containing the sections of the area.

hasContent

public boolean hasContent(java.lang.Object srcArea)

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(IAreaFormat areaFormat)
Description copied from interface: IArea

Sets the format of the area.

Specified by:
setFormat in interface IArea
Parameters:
areaFormat - An IAreaFormat object that specifies the format of the area.

setKind

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

Sets the type (kind) of area (for example, Details, Report Header, Page Footer, and so on).

Specified by:
setKind in interface IArea
Parameters:
kind - An AreaSectionKind object that specifies the kind of area.

setName

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

Sets the area name.

Specified by:
setName in interface IArea
Parameters:
name - A String that specifies the area name.

setSections

public void setSections(Sections sections)
Description copied from interface: IArea

Sets the sections of the area.

Specified by:
setSections in interface IArea
Parameters:
sections - A Sections object containing the sections of the area.

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)