com.crystaldecisions.sdk.occa.report.definition
Class StringFieldFormat

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.StringFieldFormat
All Implemented Interfaces:
IStringFieldFormat, IClone

public class StringFieldFormat
extends java.lang.Object
implements IStringFieldFormat, IClone

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

StringFieldFormat

public StringFieldFormat(IStringFieldFormat src)

StringFieldFormat

public StringFieldFormat()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getCharacterSpacing

public int getCharacterSpacing()
Description copied from interface: IStringFieldFormat

Returns the spacing between characters.

Specified by:
getCharacterSpacing in interface IStringFieldFormat
Returns:
The spacing between characters as an int.

getEnableWordWrap

public boolean getEnableWordWrap()
Deprecated. EnableWordWrap is not used

Description copied from interface: IStringFieldFormat

Returns whether lines of text that are too long will automatically be broken into multiple lines.

Specified by:
getEnableWordWrap in interface IStringFieldFormat
Returns:
true if word wrap is enabled, and otherwise false.

getIndentAndSpacingFormat

public IIndentAndSpacingFormat getIndentAndSpacingFormat()
Description copied from interface: IStringFieldFormat

Returns the indent and spacing format for the string field.

Specified by:
getIndentAndSpacingFormat in interface IStringFieldFormat
Returns:
The indent and spacing format for the string field as IIndentAndSpacingFormat.

getMaxNumberOfLines

public int getMaxNumberOfLines()
Description copied from interface: IStringFieldFormat

Returns the maximum number of lines of text for a string field.

Specified by:
getMaxNumberOfLines in interface IStringFieldFormat
Returns:
The maximum number of lines of text for a string field as an int.

getTextFormat

public TextFormat getTextFormat()
Description copied from interface: IStringFieldFormat

Returns the text format for the string field.

Specified by:
getTextFormat in interface IStringFieldFormat
Returns:
The text format for the string field as TextFormat.

getReadingOrder

public ReadingOrder getReadingOrder()
Description copied from interface: IStringFieldFormat

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

Specified by:
getReadingOrder in interface IStringFieldFormat
Returns:
The reading order as ReadingOrder.

hasContent

public boolean hasContent(java.lang.Object srcStringFieldFormat)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setCharacterSpacing

public void setCharacterSpacing(int characterSpacing)
Description copied from interface: IStringFieldFormat

Sets the spacing between characters.

Specified by:
setCharacterSpacing in interface IStringFieldFormat
Parameters:
characterSpacing - The spacing between characters as an int.

setEnableWordWrap

public void setEnableWordWrap(boolean enableWordWrap)
Deprecated. EnableWordWrap is not used

Description copied from interface: IStringFieldFormat

Sets whether lines of text that are too long will automatically be broken into multiple lines.

Specified by:
setEnableWordWrap in interface IStringFieldFormat
Parameters:
enableWordWrap - true if word wrap is enabled, and otherwise false.

setIndentAndSpacingFormat

public void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
Description copied from interface: IStringFieldFormat

Sets the indent and spacing format for the string field.

Specified by:
setIndentAndSpacingFormat in interface IStringFieldFormat
Parameters:
indentAndSpacingFormat - The indent and spacing format for the string field as IIndentAndSpacingFormat.

setMaxNumberOfLines

public void setMaxNumberOfLines(int maxNumberOfLines)
Description copied from interface: IStringFieldFormat

Sets the maximum number of lines of text for a string field.

Specified by:
setMaxNumberOfLines in interface IStringFieldFormat
Parameters:
maxNumberOfLines - The maximum number of lines of text for a string field as an int.

setTextFormat

public void setTextFormat(TextFormat textFormat)
Description copied from interface: IStringFieldFormat

Sets the text format for the string field.

Specified by:
setTextFormat in interface IStringFieldFormat
Parameters:
textFormat - The text format for the string field as TextFormat.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


setReadingOrder

public void setReadingOrder(ReadingOrder newReadingOrder)

Skips writing this object if an identical object already exists.

Specified by:
setReadingOrder in interface IStringFieldFormat
Parameters:
newReadingOrder - the ReadingOrder object to be set

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


getConditionFormulas

public StringFieldFormatConditionFormulas getConditionFormulas()
Specified by:
getConditionFormulas in interface IStringFieldFormat

setConditionFormulas

public void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
Specified by:
setConditionFormulas in interface IStringFieldFormat

doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()