|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IStringFieldFormat
This interface enables you to get and set how a FieldObject
containing Strings is formatted. If the field is not being used to
represent a StringFormat property, and you modify this object, your changes will be
ignored and discarded.
| Method Summary | |
|---|---|
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. |
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. |
| Method Detail |
|---|
int getCharacterSpacing()
Returns the spacing between characters.
int.IIndentAndSpacingFormat getIndentAndSpacingFormat()
Returns the indent and spacing format for the string field.
IIndentAndSpacingFormat.int getMaxNumberOfLines()
Returns the maximum number of lines of text for a string field.
int.TextFormat getTextFormat()
Returns the text format for the string field.
TextFormat.boolean getEnableWordWrap()
Returns whether lines of text that are too long will automatically be broken into multiple lines.
true if word wrap is enabled, and otherwise false.ReadingOrder getReadingOrder()
Returns the reading order for the text field. Reading order can be either left to right, or right to left.
ReadingOrder.void setCharacterSpacing(int characterSpacing)
Sets the spacing between characters.
characterSpacing - The spacing between characters as an int.void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
Sets the indent and spacing format for the string field.
indentAndSpacingFormat - The indent and spacing format for the string field as
IIndentAndSpacingFormat.void setMaxNumberOfLines(int maxNumberOfLines)
Sets the maximum number of lines of text for a string field.
maxNumberOfLines - The maximum number of lines of text for a string field
as an int.void setTextFormat(TextFormat textFormat)
Sets the text format for the string field.
textFormat - The text format for the string field as TextFormat.void setEnableWordWrap(boolean enableWordWrap)
Sets whether lines of text that are too long will automatically be broken into multiple lines.
enableWordWrap - true if word wrap is enabled, and otherwise false.void setReadingOrder(ReadingOrder newReadingOrder)
Sets the reading order for the text field. Reading order can be either left to right, or right to left.
newReadingOrder - The reading order as ReadingOrder.StringFieldFormatConditionFormulas getConditionFormulas()
void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||