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

All Superinterfaces:
IClone, IReportObject
All Known Subinterfaces:
IFieldHeadingObject
All Known Implementing Classes:
FieldHeadingObject, TextObject

public interface ITextObject
extends IReportObject

This interface is used to manipulate the TextObject. The TextObject represents a text object that is found in a report. This interface enables you to retrieve and set options for a text object in your report.


Method Summary
 boolean getEnableSuppressIfDuplicated()
           
 IFontColor getFontColor()
          Returns the color of the font for the first element of the first paragraph.
 int getMaxNumberOfLines()
          Returns the maximum number of lines in the field as an int.
 Paragraphs getParagraphs()
          Returns the paragraph object of the text field.
 ReadingOrder getReadingOrder()
          Returns the reading order for the text field.
 boolean getSuppressEmbeddedFieldBlankLines()
           
 java.lang.String getText()
          Returns the text content of the text field.
 void setEnableSuppressIfDuplicated(boolean bSuppressIfDuplicated)
           
 void setFontColor(IFontColor fontColor)
          Sets the color of the font for the first element of the first paragraph.
 void setMaxNumberOfLines(int maxNumberOfLines)
           Sets the maximum number of lines in the field.
 void setParagraphs(Paragraphs paragraphs)
          Sets the paragraph object of the text field.
 void setReadingOrder(ReadingOrder readingOrder)
          Sets the reading order for the text field.
 void setSuppressEmbeddedFieldBlankLines(boolean bSuppressEmbeddedFieldBlankLines)
           
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Method Detail

getFontColor

IFontColor getFontColor()

Returns the color of the font for the first element of the first paragraph.

Returns:
The font color as IFontColor.
See Also:
setFontColor(com.crystaldecisions.sdk.occa.report.definition.IFontColor)

getMaxNumberOfLines

int getMaxNumberOfLines()

Returns the maximum number of lines in the field as an int.

Returns:
The maximum number of lines in the field as an int.

getParagraphs

Paragraphs getParagraphs()

Returns the paragraph object of the text field.

Returns:
The paragraph object of the text field as Paragraphs.

getText

java.lang.String getText()

Returns the text content of the text field.

Returns:
The text content of the text field as a String.

getEnableSuppressIfDuplicated

boolean getEnableSuppressIfDuplicated()

getSuppressEmbeddedFieldBlankLines

boolean getSuppressEmbeddedFieldBlankLines()

setFontColor

void setFontColor(IFontColor fontColor)

Sets the color of the font for the first element of the first 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 - The color of the font for the first element of the first paragraph as IFontColor.

setMaxNumberOfLines

void setMaxNumberOfLines(int maxNumberOfLines)

Sets the maximum number of lines in the field.

Parameters:
maxNumberOfLines - The maximum number of lines in the field as an int.

setParagraphs

void setParagraphs(Paragraphs paragraphs)

Sets the paragraph object of the text field.

Parameters:
paragraphs - The paragraph object of the text field as Paragraphs.

getReadingOrder

ReadingOrder getReadingOrder()

Returns the reading order for the text field. Reading order can be either left to right, or right to left.

Returns:
The reading order as ReadingOrder.

setReadingOrder

void setReadingOrder(ReadingOrder readingOrder)

Sets the reading order for the text field. Reading order can be either left to right, or right to left.

Parameters:
readingOrder - The reading order as ReadingOrder.

setEnableSuppressIfDuplicated

void setEnableSuppressIfDuplicated(boolean bSuppressIfDuplicated)

setSuppressEmbeddedFieldBlankLines

void setSuppressEmbeddedFieldBlankLines(boolean bSuppressEmbeddedFieldBlankLines)