|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ReportObject
com.crystaldecisions.sdk.occa.report.definition.TextObject
public class TextObject
This object represents a text object that is
found in a report. This object enables you to retrieve
and set options for a text object in your report.When possible, use the
ITextObject interface to manipulate this object.
| Field Summary | |
|---|---|
static java.lang.String |
BASEID_TEXTELEMENT
|
| Constructor Summary | |
|---|---|
TextObject()
|
|
TextObject(ITextObject src)
|
|
TextObject(java.lang.String text)
For internal use only |
|
| 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 |
disconnect()
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType |
getEmbeddedContentType()
For internal use only. |
boolean |
getEnableSuppressIfDuplicated()
For internal use only |
IFontColor |
getFontColor()
Returns the color of the font for the first element of the first paragraph. |
java.lang.String |
getImageKey()
For internal use only. |
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()
For internal use only |
java.lang.String |
getText()
Returns the text content of the text field. |
java.lang.String |
getTranslatableString(TranslatableStringId id)
For internal use only |
java.util.List |
getTranslatableStringIds()
For internal use only |
java.lang.String |
getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only |
boolean |
hasContent(java.lang.Object srcTextObject)
|
boolean |
isConnected()
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
refresh()
|
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 |
setEmbeddedContentType(com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType embeddedContentType)
For internal use only. |
void |
setEnableSuppressIfDuplicated(boolean bEnableSuppressIfDuplicated)
For internal use only |
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 newReadingOrder)
Sets the reading order for the text field. |
void |
setSuppressEmbeddedFieldBlankLines(boolean bSuppressEmbeddedFieldBlankLines)
For internal use only |
void |
setTranslatableString(TranslatableStringId id,
java.lang.String newText)
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 com.crystaldecisions.sdk.occa.report.definition.ReportObject |
|---|
getBorder, getBorderMargins, getFormat, getFormula, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getTranslatableObject, getVersion, getWidth, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setVersion, setWidth |
| 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.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 |
| Field Detail |
|---|
public static final java.lang.String BASEID_TEXTELEMENT
| Constructor Detail |
|---|
public TextObject(ITextObject src)
public TextObject()
public TextObject(java.lang.String text)
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class ReportObject
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class ReportObject
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
ReportObjectFor internal use only.
createMember in class ReportObject
public void endElement(java.lang.String eleName,
java.util.Map objState)
ReportObjectFor internal use only.
endElement in class ReportObjectpublic ReadingOrder getReadingOrder()
ITextObjectReturns the reading order for the text field. Reading order can be either left to right, or right to left.
getReadingOrder in interface ITextObjectReadingOrder.public IFontColor getFontColor()
ITextObjectReturns the color of the font for the first element of the first paragraph.
getFontColor in interface ITextObjectIFontColor.ITextObject.setFontColor(com.crystaldecisions.sdk.occa.report.definition.IFontColor)public int getMaxNumberOfLines()
ITextObjectReturns the maximum number of lines in the field as an int.
getMaxNumberOfLines in interface ITextObjectint.public Paragraphs getParagraphs()
ITextObjectReturns the paragraph object of the text field.
getParagraphs in interface ITextObjectParagraphs.public java.lang.String getText()
ITextObjectReturns the text content of the text field.
getText in interface ITextObjectString.public boolean getEnableSuppressIfDuplicated()
ITextObject
getEnableSuppressIfDuplicated in interface ITextObjectpublic boolean getSuppressEmbeddedFieldBlankLines()
ITextObject
getSuppressEmbeddedFieldBlankLines in interface ITextObjectpublic com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType getEmbeddedContentType()
public boolean hasContent(java.lang.Object srcTextObject)
hasContent in class ReportObject
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
ReportObjectFor internal use only.
readElement in class ReportObject
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
save in class ReportObjectjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
save in class ReportObjectjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
ReportObjectFor internal use only.
saveContents in class ReportObjectjava.io.IOExceptionpublic void setFontColor(IFontColor fontColor)
ITextObjectSets 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);
setFontColor in interface ITextObjectfontColor - The color of the font for the first element of
the first paragraph as IFontColor.public void setMaxNumberOfLines(int maxNumberOfLines)
ITextObjectSets the maximum number of lines in the field.
setMaxNumberOfLines in interface ITextObjectmaxNumberOfLines - The maximum number of lines in the field as an int.public void setReadingOrder(ReadingOrder newReadingOrder)
ITextObjectSets the reading order for the text field. Reading order can be either left to right, or right to left.
setReadingOrder in interface ITextObjectnewReadingOrder - The reading order as ReadingOrder.public void setParagraphs(Paragraphs paragraphs)
ITextObjectSets the paragraph object of the text field.
setParagraphs in interface ITextObjectparagraphs - The paragraph object of the text field as Paragraphs.public void setEnableSuppressIfDuplicated(boolean bEnableSuppressIfDuplicated)
ITextObject
setEnableSuppressIfDuplicated in interface ITextObjectpublic void setSuppressEmbeddedFieldBlankLines(boolean bSuppressEmbeddedFieldBlankLines)
ITextObject
setSuppressEmbeddedFieldBlankLines in interface ITextObjectpublic void setEmbeddedContentType(com.crystaldecisions.sdk.occa.report.definition.EmbeddedContentType embeddedContentType)
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
ReportObjectFor internal use only.
startElement in class ReportObjectpublic boolean isConnected()
public void disconnect()
public void refresh()
public java.util.List getTranslatableStringIds()
ReportObject
getTranslatableStringIds in class ReportObjectpublic java.lang.String getTranslatableString(TranslatableStringId id)
ReportObject
getTranslatableString in class ReportObject
public void setTranslatableString(TranslatableStringId id,
java.lang.String newText)
ReportObject
setTranslatableString in class ReportObjectpublic java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
ReportObject
getTranslatableStringLabelResourceID in class ReportObjectpublic java.lang.String getImageKey()
For internal use only.
getImageKey in class ReportObject
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||