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

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

public class CommonFieldFormat
extends java.lang.Object
implements ICommonFieldFormat, IClone

This object provides the formatting options that are common to all ReportObjects. When possible, use the ICommonFieldFormat interface.


Constructor Summary
CommonFieldFormat()
           
CommonFieldFormat(ICommonFieldFormat 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)
           
 CommonFieldFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the common field's format settings.
 ControllableMixin getControllableMixin()
           
 boolean getEnableSuppressIfDuplicated()
           Returns whether duplicate fields are printed or not.
 boolean getEnableSystemDefault()
           Returns true if the system default format is used, and false otherwise.
 boolean hasContent(java.lang.Object srcCommonFieldFormat)
           
 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 setConditionFormulas(CommonFieldFormatConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the common field's format settings.
 void setEnableSuppressIfDuplicated(boolean enableSuppressIfDuplicated)
           Sets whether duplicate fields are printed or not.
 void setEnableSystemDefault(boolean EnableSystemDefault)
           Sets whether the system default format is used.
 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

CommonFieldFormat

public CommonFieldFormat(ICommonFieldFormat src)

CommonFieldFormat

public CommonFieldFormat()
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.


getConditionFormulas

public CommonFieldFormatConditionFormulas getConditionFormulas()
Description copied from interface: ICommonFieldFormat

Returns the condition formulas used to override the common field's format settings.

Specified by:
getConditionFormulas in interface ICommonFieldFormat
Returns:
A CommonFieldFormatConditionFormulas object containing the condition formulas used to override the common field's format settings.

getEnableSuppressIfDuplicated

public boolean getEnableSuppressIfDuplicated()
Description copied from interface: ICommonFieldFormat

Returns whether duplicate fields are printed or not.

Specified by:
getEnableSuppressIfDuplicated in interface ICommonFieldFormat
Returns:
true if duplicate fields are not printed, and false otherwise.

getEnableSystemDefault

public boolean getEnableSystemDefault()
Description copied from interface: ICommonFieldFormat

Returns true if the system default format is used, and false otherwise. If this is set to true, other format object settings will be ignored.

Specified by:
getEnableSystemDefault in interface ICommonFieldFormat
Returns:
true if the system default format is used, and false otherwise.

hasContent

public boolean hasContent(java.lang.Object srcCommonFieldFormat)

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

setConditionFormulas

public void setConditionFormulas(CommonFieldFormatConditionFormulas conditionFormulas)
Description copied from interface: ICommonFieldFormat

Sets the condition formulas used to override the common field's format settings.

Specified by:
setConditionFormulas in interface ICommonFieldFormat
Parameters:
conditionFormulas - A CommonFieldFormatConditionFormulas object containing the condition formulas used to override the common field's format settings.

setEnableSuppressIfDuplicated

public void setEnableSuppressIfDuplicated(boolean enableSuppressIfDuplicated)
Description copied from interface: ICommonFieldFormat

Sets whether duplicate fields are printed or not.

Specified by:
setEnableSuppressIfDuplicated in interface ICommonFieldFormat
Parameters:
enableSuppressIfDuplicated - true if duplicate fields are not printed, and false otherwise.

setEnableSystemDefault

public void setEnableSystemDefault(boolean EnableSystemDefault)
Description copied from interface: ICommonFieldFormat

Sets whether the system default format is used. If this is set to true, other format object settings will be ignored.

Specified by:
setEnableSystemDefault in interface ICommonFieldFormat
Parameters:
EnableSystemDefault - true if the system default format is used, and false otherwise.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

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

For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()