com.crystaldecisions.sdk.occa.report.definition
Interface IIndentAndSpacingFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
IndentAndSpacingFormat

public interface IIndentAndSpacingFormat
extends IClone

This interface is used to set the indent and spacing for your report object. This interface is used to format ReportObjects 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.


Method Summary
 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.
 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.
 

Method Detail

getFirstLineIndent

int getFirstLineIndent()

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

Returns:
An int that specifies the distance between the left margin and the first indented line.

getLeftIndent

int getLeftIndent()

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

Returns:
An int that specifies the size of the paragraph's indent.

getLineSpacing

double getLineSpacing()

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

Returns:
A double that specifies the measure of the line spacing.

getRightIndent

int getRightIndent()

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

Returns:
An int that specifies the distance of the line that is indented from the right.

getLineSpacingType

LineSpacingType getLineSpacingType()

Returns the type of line spacing.

Returns:
A LineSpacingType object that specifies the type of line spacing.

setFirstLineIndent

void setFirstLineIndent(int firstLineIndent)

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

Parameters:
firstLineIndent - An int that specifies the distance of the first line that is indented from the left margin.

setLeftIndent

void setLeftIndent(int leftIndent)

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

Parameters:
leftIndent - An int that specifies the size of the paragraph's indent.

setLineSpacing

void setLineSpacing(double lineSpacing)

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

Parameters:
lineSpacing - A double that specifies the measure of the line spacing.

setRightIndent

void setRightIndent(int rightIndent)

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

Parameters:
rightIndent - An int that specifies the distance of the line that is indented from the right.

setLineSpacingType

void setLineSpacingType(LineSpacingType lineSpacingType)

Sets the type of line spacing.

Parameters:
lineSpacingType - A LineSpacingType object that specifies the type of line spacing.