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

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

public class IndentAndSpacingFormat
extends java.lang.Object
implements IIndentAndSpacingFormat, IClone

This object is used to set the indent and spacing for your report object. Use this object to format ReportObjects objects that contain text; that is, it formats how text lines and paragraphs are indented and spaced. This object is used by the TextObject's Paragraph objects as well as the StringFieldFormat, which provides formatting for a FieldObject when it displays textual information. When possible, use the IIndentAndSpacingFormat interface.


Constructor Summary
IndentAndSpacingFormat()
           
IndentAndSpacingFormat(IIndentAndSpacingFormat 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()
           
 int getFirstLineIndent()
           Returns the distance between the left margin and the first indented line.
 int getLeftIndent()
           Returns the size of the paragraph indentation.
 double getLineSpacing()
           Returns the measure of the line spacing (this measure depends on the type).
 LineSpacingType getLineSpacingType()
           Returns the type of line spacing.
 int getRightIndent()
           Returns the distance of the line that is indented from the right.
 boolean hasContent(java.lang.Object srcIndentAndSpacingFormat)
           
 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 setFirstLineIndent(int firstLineIndent)
           Sets the distance of the first line that is indented from the left margin.
 void setLeftIndent(int leftIndent)
           Sets the size of the paragraph indentation.
 void setLineSpacing(double lineSpacing)
           Sets the measure of the line spacing (this measure depends on the type).
 void setLineSpacingType(LineSpacingType lineSpacingType)
           Sets the type of line spacing.
 void setRightIndent(int rightIndent)
           Sets the distance of the line that is indented from the right.
 boolean skipWritingIdenticalObject()
           For internal use only.
 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

IndentAndSpacingFormat

public IndentAndSpacingFormat(IIndentAndSpacingFormat src)

IndentAndSpacingFormat

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


getFirstLineIndent

public int getFirstLineIndent()
Description copied from interface: IIndentAndSpacingFormat

Returns the distance between the left margin and the first indented line.

Specified by:
getFirstLineIndent in interface IIndentAndSpacingFormat
Returns:
An int that specifies the distance between the left margin and the first indented line.

getLeftIndent

public int getLeftIndent()
Description copied from interface: IIndentAndSpacingFormat

Returns the size of the paragraph indentation. Note that this value is different from the value returned by IIndentAndSpacingFormat.getFirstLineIndent().

Specified by:
getLeftIndent in interface IIndentAndSpacingFormat
Returns:
An int that specifies the size of the paragraph's indent.

getLineSpacing

public double getLineSpacing()
Description copied from interface: IIndentAndSpacingFormat

Returns the measure of the line spacing (this measure depends on the type). The spacing type can either be double or in twips.

Specified by:
getLineSpacing in interface IIndentAndSpacingFormat
Returns:
A double that specifies the measure of the line spacing.

getLineSpacingType

public LineSpacingType getLineSpacingType()
Description copied from interface: IIndentAndSpacingFormat

Returns the type of line spacing.

Specified by:
getLineSpacingType in interface IIndentAndSpacingFormat
Returns:
A LineSpacingType object that specifies the type of line spacing.

getRightIndent

public int getRightIndent()
Description copied from interface: IIndentAndSpacingFormat

Returns the distance of the line that is indented from the right.

Specified by:
getRightIndent in interface IIndentAndSpacingFormat
Returns:
An int that specifies the distance of the line that is indented from the right.

hasContent

public boolean hasContent(java.lang.Object srcIndentAndSpacingFormat)

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

setFirstLineIndent

public void setFirstLineIndent(int firstLineIndent)
Description copied from interface: IIndentAndSpacingFormat

Sets the distance of the first line that is indented from the left margin.

Specified by:
setFirstLineIndent in interface IIndentAndSpacingFormat
Parameters:
firstLineIndent - An int that specifies the distance of the first line that is indented from the left margin.

setLeftIndent

public void setLeftIndent(int leftIndent)
Description copied from interface: IIndentAndSpacingFormat

Sets the size of the paragraph indentation. Note that this value is different from the value returned by IIndentAndSpacingFormat.getFirstLineIndent().

Specified by:
setLeftIndent in interface IIndentAndSpacingFormat
Parameters:
leftIndent - An int that specifies the size of the paragraph's indent.

setLineSpacing

public void setLineSpacing(double lineSpacing)
Description copied from interface: IIndentAndSpacingFormat

Sets the measure of the line spacing (this measure depends on the type). The spacing type can either be double or in twips.

Specified by:
setLineSpacing in interface IIndentAndSpacingFormat
Parameters:
lineSpacing - A double that specifies the measure of the line spacing.

setLineSpacingType

public void setLineSpacingType(LineSpacingType lineSpacingType)
Description copied from interface: IIndentAndSpacingFormat

Sets the type of line spacing.

Specified by:
setLineSpacingType in interface IIndentAndSpacingFormat
Parameters:
lineSpacingType - A LineSpacingType object that specifies the type of line spacing.

setRightIndent

public void setRightIndent(int rightIndent)
Description copied from interface: IIndentAndSpacingFormat

Sets the distance of the line that is indented from the right.

Specified by:
setRightIndent in interface IIndentAndSpacingFormat
Parameters:
rightIndent - An int that specifies the distance of the line that is indented from the right.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

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

For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)