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

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

public class MultiColumnArea
extends Area
implements IMultiColumnArea, IClone

This object defines an area containing multiple columns in a report. Each section within the area can be formatted differently. This object allows you to retrieve information and set options for a specified area containing multiple columns in your report.


Constructor Summary
MultiColumnArea()
           
MultiColumnArea(IMultiColumnArea 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 endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 int getDetailHeight()
           Returns the height of the Details area.
 int getDetailWidth()
           Returns the width of the Details area.
 int getHorizontalGap()
           Returns the horizontal gap between the columns.
 boolean hasContent(java.lang.Object srcMultiColumnArea)
           
 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 setDetailHeight(int detailHeight)
           Sets the height of the Details area.
 void setDetailWidth(int detailWidth)
           Sets the width of the Details area.
 void setHorizontalGap(int horizontalGap)
           Sets the horizontal gap between the columns.
 void startElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.Area
doControllerModification, enumerateMembers, getControllableMixin, getFormat, getKind, getName, getSections, isDirectlyControllable, setFormat, setKind, setName, setSections, startElement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IArea
getFormat, getKind, getName, getSections, setFormat, setKind, setName, setSections
 

Constructor Detail

MultiColumnArea

public MultiColumnArea(IMultiColumnArea src)

MultiColumnArea

public MultiColumnArea()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Area

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Area

createMember

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

For internal use only.

Overrides:
createMember in class Area

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: Area

For internal use only.

Overrides:
endElement in class Area

getDetailHeight

public int getDetailHeight()
Description copied from interface: IMultiColumnArea

Returns the height of the Details area.

Specified by:
getDetailHeight in interface IMultiColumnArea
Returns:
An int that specifies the height of the Details area in twips.

getDetailWidth

public int getDetailWidth()
Description copied from interface: IMultiColumnArea

Returns the width of the Details area.

Specified by:
getDetailWidth in interface IMultiColumnArea
Returns:
An int that specifies the width of the Details area in twips.

getHorizontalGap

public int getHorizontalGap()
Description copied from interface: IMultiColumnArea

Returns the horizontal gap between the columns.

Specified by:
getHorizontalGap in interface IMultiColumnArea
Returns:
The horizontal gap between the columns in twips as an int.

hasContent

public boolean hasContent(java.lang.Object srcMultiColumnArea)
Overrides:
hasContent in class Area

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: Area

For internal use only.

Overrides:
readElement in class Area

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: Area

For internal use only.

Overrides:
save in class Area
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: Area

For internal use only.

Overrides:
save in class Area
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: Area

For internal use only.

Overrides:
saveContents in class Area
Throws:
java.io.IOException

setDetailHeight

public void setDetailHeight(int detailHeight)
Description copied from interface: IMultiColumnArea

Sets the height of the Details area.

Specified by:
setDetailHeight in interface IMultiColumnArea
Parameters:
detailHeight - An int that specifies the height of the Details area in twips.

setDetailWidth

public void setDetailWidth(int detailWidth)
Description copied from interface: IMultiColumnArea

Sets the width of the Details area.

Specified by:
setDetailWidth in interface IMultiColumnArea
Parameters:
detailWidth - An int that specifies the width of the Details area in twips.

setHorizontalGap

public void setHorizontalGap(int horizontalGap)
Description copied from interface: IMultiColumnArea

Sets the horizontal gap between the columns.

Specified by:
setHorizontalGap in interface IMultiColumnArea
Parameters:
horizontalGap - An int that specifies the horizontal gap between the columns in twips.

startElement

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

For internal use only.