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

All Superinterfaces:
IClone
All Known Implementing Classes:
Paragraph

public interface IParagraph
extends IClone

This interface enables you to set the paragraph formatting. For the paragraph, you can specify the alignment, the font color, the indent and spacing, and so on.

TextObject objects contain a Paragraphs collection. Each Paragraphs collection contains a number of Paragraph objects. These in turn contain ParagraphElements. The ParagraphElements contain either ParagraphTextElement objects, which store text to display, or ParagraphFieldElement objects, which display text from some kind of field object. This enables you to have minute control of the text objects' formatting options by formatting the elements that constitute a paragraph. You can format each element of each paragraph in the text object.


Method Summary
 Alignment getAlignment()
           Returns the alignment of the paragraph.
 IFontColor getFontColor()
           Returns the font color of the paragraph.
 IIndentAndSpacingFormat getIndentAndSpacingFormat()
           Returns the indent and spacing for the paragraph.
 ParagraphElements getParagraphElements()
           Returns all of the paragraph elements in the paragraph.
 ReadingOrder getReadingOrder()
           Returns the reading order of the paragraphs.
 TabStops getTabStops()
           Returns all of the tab stops in the paragraph.
 void setAlignment(Alignment alignment)
           Sets the alignment of the paragraph.
 void setFontColor(IFontColor fontColor)
           Sets the font color of the paragraph.
 void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
           Sets the indent and spacing for the paragraph.
 void setParagraphElements(ParagraphElements paragraphElements)
           Sets all of the paragraph elements in the paragraph.
 void setReadingOrder(ReadingOrder readingOrder)
           Sets the reading order of the paragraphs.
 void setTabStops(TabStops tabStops)
           Sets all of the tab stops in the paragraph.
 

Method Detail

getIndentAndSpacingFormat

IIndentAndSpacingFormat getIndentAndSpacingFormat()

Returns the indent and spacing for the paragraph.

Returns:
An IIndentAndSpacingFormat object that specifies the indent and spacing for the paragraph.

getParagraphElements

ParagraphElements getParagraphElements()

Returns all of the paragraph elements in the paragraph.

Returns:
A ParagraphElements object containing all of the paragraph elements in the paragraph.

getTabStops

TabStops getTabStops()

Returns all of the tab stops in the paragraph.

Returns:
A TabStops object that specifies all of the tab stops in the paragraph.

getFontColor

IFontColor getFontColor()

Returns the font color of the paragraph.

Returns:
An IFontColor object that specifies the font color of the paragraph.
See Also:
setFontColor(com.crystaldecisions.sdk.occa.report.definition.IFontColor)

setIndentAndSpacingFormat

void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)

Sets the indent and spacing for the paragraph.

Parameters:
indentAndSpacingFormat - An IIndentAndSpacingFormat object that specifies the indent and spacing for the paragraph.

setParagraphElements

void setParagraphElements(ParagraphElements paragraphElements)

Sets all of the paragraph elements in the paragraph.

Parameters:
paragraphElements - A ParagraphElements object containing all of the paragraph elements in the paragraph.

setTabStops

void setTabStops(TabStops tabStops)

Sets all of the tab stops in the paragraph.

Parameters:
tabStops - A TabStops object that specifies all of the tab stops in the paragraph.

setFontColor

void setFontColor(IFontColor fontColor)

Sets the font color of the paragraph. For this change to be persistent, use IParagraphElement.setFontColor(IFontColor fontColor).

In order to set the font color, you will need to use syntax like:

  ITextObject newText = (ITextObject) oldText.clone(true);
        IFontColor fc = newText.getFontColor();
        fc.setColor(java.awt.Color.red);
        newText.setFontColor(fc);
        objectController.modify(oldText, newText);
  

Parameters:
fontColor - An IFontColor object that specifies the font color of the paragraph.

getAlignment

Alignment getAlignment()

Returns the alignment of the paragraph.

Returns:
An Alignment object that specifies the alignment of the paragraph.

getReadingOrder

ReadingOrder getReadingOrder()

Returns the reading order of the paragraphs.

Returns:
A ReadingOrder object that specifies the reading order of the paragraphs.

setAlignment

void setAlignment(Alignment alignment)

Sets the alignment of the paragraph.

Parameters:
alignment - An Alignment object that specifies the alignment of the paragraph.

setReadingOrder

void setReadingOrder(ReadingOrder readingOrder)

Sets the reading order of the paragraphs.

Parameters:
readingOrder - A ReadingOrder object that specifies the reading order of the paragraphs.