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

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

public class StringFieldFormatConditionFormulas
extends java.lang.Object

A collection of conditional formatting formulas for displaying a string field.

See Also:
StringFieldFormat.setConditionFormulas(StringFieldFormatConditionFormulas), FieldObject.setFieldFormat(IFieldFormat)

Constructor Summary
StringFieldFormatConditionFormulas()
          Creates an empty StringFieldFormatConditionFormulas collection.
StringFieldFormatConditionFormulas(StringFieldFormatConditionFormulas src)
          Creates a copy of the given StringFieldFormatConditionFormulas collection.
 
Method Summary
 void clear()
          Removes all of the formulas.
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 int count()
          For internal use only.
 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)
           
 IConditionFormula get(java.lang.Object key)
          Deprecated.  
 ControllableMixin getControllableMixin()
           
 IConditionFormula getFormula(StringFieldFormatConditionFormulaType formulaType)
          Gets the IConditionFormula in the collection for the given formula type.
 boolean hasContent(java.lang.Object objFormulas)
           
 boolean isDirectlyControllable()
           
 void put(java.lang.Object key, IConditionFormula newFormula)
          Deprecated.  
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void remove(StringFieldFormatConditionFormulaType type)
          Remove the IConditionFormula for the given StringFieldFormatConditionFormulaType.
 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)
           
 void setFormula(StringFieldFormatConditionFormulaType formulaType, IConditionFormula newFormula)
          Adds or replaces a formula in the collection for the specified formula type.
 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

StringFieldFormatConditionFormulas

public StringFieldFormatConditionFormulas(StringFieldFormatConditionFormulas src)
Creates a copy of the given StringFieldFormatConditionFormulas collection. This method will create a deep copy of the src collection.

Parameters:
src - the formula collection to copy

StringFieldFormatConditionFormulas

public StringFieldFormatConditionFormulas()
Creates an empty StringFieldFormatConditionFormulas collection.

Method Detail

getFormula

public IConditionFormula getFormula(StringFieldFormatConditionFormulaType formulaType)
Gets the IConditionFormula in the collection for the given formula type.

Parameters:
formulaType - the type of formula to retrieve
Returns:
the IConditionFormula for the specified formula type

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.


remove

public void remove(StringFieldFormatConditionFormulaType type)
Remove the IConditionFormula for the given StringFieldFormatConditionFormulaType.

Parameters:
type - the formula type to remove from the collection

setFormula

public void setFormula(StringFieldFormatConditionFormulaType formulaType,
                       IConditionFormula newFormula)
Adds or replaces a formula in the collection for the specified formula type.

Parameters:
formulaType - the type of formula to add or replace
newFormula - the formula to be used for the specified formula type

clear

public void clear()

Removes all of the formulas.


clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

count

public int count()

For internal use only.


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.


get

public IConditionFormula get(java.lang.Object key)
Deprecated. 


hasContent

public boolean hasContent(java.lang.Object objFormulas)

put

public void put(java.lang.Object key,
                IConditionFormula newFormula)
Deprecated. 


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
Throws:
java.io.IOException

startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)