|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.StringFieldFormat
public class StringFieldFormat
This object describes how the StringFormat property shown by a FieldObject should be formatted if the FieldObject is being used to display strings. If the field is not being used to represent a StringFormat property, and you modify this object, your changes will be ignored and discarded.
| Constructor Summary | |
|---|---|
StringFieldFormat()
|
|
StringFieldFormat(IStringFieldFormat 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 |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
int |
getCharacterSpacing()
Returns the spacing between characters. |
StringFieldFormatConditionFormulas |
getConditionFormulas()
For internal use only |
boolean |
getEnableWordWrap()
Returns whether lines of text that are too long will automatically be broken into multiple lines. |
IIndentAndSpacingFormat |
getIndentAndSpacingFormat()
Returns the indent and spacing format for the string field. |
int |
getMaxNumberOfLines()
Returns the maximum number of lines of text for a string field. |
ReadingOrder |
getReadingOrder()
Returns the reading order for the text field. |
TextFormat |
getTextFormat()
Returns the text format for the string field. |
boolean |
hasContent(java.lang.Object srcStringFieldFormat)
|
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 |
setCharacterSpacing(int characterSpacing)
Sets the spacing between characters. |
void |
setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
For internal use only |
void |
setEnableWordWrap(boolean enableWordWrap)
Sets whether lines of text that are too long will automatically be broken into multiple lines. |
void |
setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
Sets the indent and spacing format for the string field. |
void |
setMaxNumberOfLines(int maxNumberOfLines)
Sets the maximum number of lines of text for a string field. |
void |
setReadingOrder(ReadingOrder newReadingOrder)
Sets the reading order for the text field. |
void |
setTextFormat(TextFormat textFormat)
Sets the text format for the string field. |
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 |
|---|
public StringFieldFormat(IStringFieldFormat src)
public StringFieldFormat()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
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.
public void endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only.
public int getCharacterSpacing()
IStringFieldFormatReturns the spacing between characters.
getCharacterSpacing in interface IStringFieldFormatint.public boolean getEnableWordWrap()
IStringFieldFormatReturns whether lines of text that are too long will automatically be broken into multiple lines.
getEnableWordWrap in interface IStringFieldFormattrue if word wrap is enabled, and otherwise false.public IIndentAndSpacingFormat getIndentAndSpacingFormat()
IStringFieldFormatReturns the indent and spacing format for the string field.
getIndentAndSpacingFormat in interface IStringFieldFormatIIndentAndSpacingFormat.public int getMaxNumberOfLines()
IStringFieldFormatReturns the maximum number of lines of text for a string field.
getMaxNumberOfLines in interface IStringFieldFormatint.public TextFormat getTextFormat()
IStringFieldFormatReturns the text format for the string field.
getTextFormat in interface IStringFieldFormatTextFormat.public ReadingOrder getReadingOrder()
IStringFieldFormatReturns the reading order for the text field. Reading order can be either left to right, or right to left.
getReadingOrder in interface IStringFieldFormatReadingOrder.public boolean hasContent(java.lang.Object srcStringFieldFormat)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOExceptionpublic void setCharacterSpacing(int characterSpacing)
IStringFieldFormatSets the spacing between characters.
setCharacterSpacing in interface IStringFieldFormatcharacterSpacing - The spacing between characters as an int.public void setEnableWordWrap(boolean enableWordWrap)
IStringFieldFormatSets whether lines of text that are too long will automatically be broken into multiple lines.
setEnableWordWrap in interface IStringFieldFormatenableWordWrap - true if word wrap is enabled, and otherwise false.public void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
IStringFieldFormatSets the indent and spacing format for the string field.
setIndentAndSpacingFormat in interface IStringFieldFormatindentAndSpacingFormat - The indent and spacing format for the string field as
IIndentAndSpacingFormat.public void setMaxNumberOfLines(int maxNumberOfLines)
IStringFieldFormatSets the maximum number of lines of text for a string field.
setMaxNumberOfLines in interface IStringFieldFormatmaxNumberOfLines - The maximum number of lines of text for a string field
as an int.public void setTextFormat(TextFormat textFormat)
IStringFieldFormatSets the text format for the string field.
setTextFormat in interface IStringFieldFormattextFormat - The text format for the string field as TextFormat.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only.
public void setReadingOrder(ReadingOrder newReadingOrder)
IStringFieldFormatSets the reading order for the text field. Reading order can be either left to right, or right to left.
setReadingOrder in interface IStringFieldFormatnewReadingOrder - The reading order as ReadingOrder.public boolean skipWritingIdenticalObject()
For internal use only.
public StringFieldFormatConditionFormulas getConditionFormulas()
IStringFieldFormat
getConditionFormulas in interface IStringFieldFormatpublic void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
IStringFieldFormat
setConditionFormulas in interface IStringFieldFormat
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||