|
|||||||||
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 |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
int |
getCharacterSpacing()
Returns the spacing between characters. |
StringFieldFormatConditionFormulas |
getConditionFormulas()
|
ControllableMixin |
getControllableMixin()
|
boolean |
getEnableWordWrap()
Deprecated. EnableWordWrap is not used |
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)
|
boolean |
isDirectlyControllable()
|
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)
|
void |
setEnableWordWrap(boolean enableWordWrap)
Deprecated. EnableWordWrap is not used |
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)
Skips writing this object if an identical object already exists. |
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()
IStringFieldFormat
Returns the spacing between characters.
getCharacterSpacing
in interface IStringFieldFormat
int
.public boolean getEnableWordWrap()
IStringFieldFormat
Returns whether lines of text that are too long will automatically be broken into multiple lines.
getEnableWordWrap
in interface IStringFieldFormat
true
if word wrap is enabled, and otherwise false
.public IIndentAndSpacingFormat getIndentAndSpacingFormat()
IStringFieldFormat
Returns the indent and spacing format for the string field.
getIndentAndSpacingFormat
in interface IStringFieldFormat
IIndentAndSpacingFormat
.public int getMaxNumberOfLines()
IStringFieldFormat
Returns the maximum number of lines of text for a string field.
getMaxNumberOfLines
in interface IStringFieldFormat
int
.public TextFormat getTextFormat()
IStringFieldFormat
Returns the text format for the string field.
getTextFormat
in interface IStringFieldFormat
TextFormat
.public ReadingOrder getReadingOrder()
IStringFieldFormat
Returns the reading order for the text field. Reading order can be either left to right, or right to left.
getReadingOrder
in interface IStringFieldFormat
ReadingOrder
.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.IOException
public void setCharacterSpacing(int characterSpacing)
IStringFieldFormat
Sets the spacing between characters.
setCharacterSpacing
in interface IStringFieldFormat
characterSpacing
- The spacing between characters as an int
.public void setEnableWordWrap(boolean enableWordWrap)
IStringFieldFormat
Sets whether lines of text that are too long will automatically be broken into multiple lines.
setEnableWordWrap
in interface IStringFieldFormat
enableWordWrap
- true
if word wrap is enabled, and otherwise false
.public void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
IStringFieldFormat
Sets the indent and spacing format for the string field.
setIndentAndSpacingFormat
in interface IStringFieldFormat
indentAndSpacingFormat
- The indent and spacing format for the string field as
IIndentAndSpacingFormat
.public void setMaxNumberOfLines(int maxNumberOfLines)
IStringFieldFormat
Sets the maximum number of lines of text for a string field.
setMaxNumberOfLines
in interface IStringFieldFormat
maxNumberOfLines
- The maximum number of lines of text for a string field
as an int
.public void setTextFormat(TextFormat textFormat)
IStringFieldFormat
Sets the text format for the string field.
setTextFormat
in interface IStringFieldFormat
textFormat
- 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)
Skips writing this object if an identical object already exists.
setReadingOrder
in interface IStringFieldFormat
newReadingOrder
- the ReadingOrder
object to be setpublic boolean skipWritingIdenticalObject()
For internal use only.
public StringFieldFormatConditionFormulas getConditionFormulas()
getConditionFormulas
in interface IStringFieldFormat
public void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
setConditionFormulas
in interface IStringFieldFormat
public void doControllerModification(java.lang.Object newObject)
public void enumerateMembers(IMemberVisitor visitor)
public ControllableMixin getControllableMixin()
public boolean isDirectlyControllable()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |