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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ParagraphElement
      extended by com.crystaldecisions.sdk.occa.report.definition.ParagraphFieldElement
All Implemented Interfaces:
IParagraphElement, IParagraphFieldElement, IClone

public class ParagraphFieldElement
extends ParagraphElement
implements IParagraphFieldElement, IClone

This object defines text from a field object. When a text object displays text, it can display static text, which is stored in a ParagraphTextElement object, or it can display text from a field object, which is what this object represents. That is, you can embed a field object within a text object by adding a ParagraphFieldElement to one of the TextObject object's paragraphs. When possible, use the IParagraphFieldElement interface.


Constructor Summary
ParagraphFieldElement()
           
ParagraphFieldElement(IParagraphFieldElement 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 endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 java.lang.String getDataSource()
           Returns the data source.
 IFieldFormat getFieldFormat()
           Returns the field format.
 FieldKind getFieldKind()
           
 boolean hasContent(java.lang.Object srcParagraphFieldElement)
           
 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 setDataSource(java.lang.String dataSource)
           Sets the data source.
 void setFieldFormat(IFieldFormat fieldFormat)
           Sets the field format.
 void startElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.ParagraphElement
doControllerModification, getCharacterSpacing, getControllableMixin, getFontColor, getKind, isDirectlyControllable, setCharacterSpacing, setFontColor, setKind, startElement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IParagraphElement
getCharacterSpacing, getFontColor, getKind, setCharacterSpacing, setFontColor, setKind
 

Constructor Detail

ParagraphFieldElement

public ParagraphFieldElement(IParagraphFieldElement src)

ParagraphFieldElement

public ParagraphFieldElement()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class ParagraphElement

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class ParagraphElement

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
Description copied from class: ParagraphElement

For internal use only.

Overrides:
createMember in class ParagraphElement

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: ParagraphElement

For internal use only.

Overrides:
endElement in class ParagraphElement

getDataSource

public java.lang.String getDataSource()
Description copied from interface: IParagraphFieldElement

Returns the data source. The data source is equivalent to the field's FormulaForm.

Specified by:
getDataSource in interface IParagraphFieldElement
Returns:
A String that specifies the data source. The data source is equivalent to the field's FormulaForm.

getFieldFormat

public IFieldFormat getFieldFormat()
Description copied from interface: IParagraphFieldElement

Returns the field format.

Specified by:
getFieldFormat in interface IParagraphFieldElement
Returns:
An IFieldFormat object that specifies the field format.

hasContent

public boolean hasContent(java.lang.Object srcParagraphFieldElement)
Overrides:
hasContent in class ParagraphElement

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: ParagraphElement

For internal use only.

Overrides:
readElement in class ParagraphElement

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ParagraphElement

For internal use only.

Overrides:
save in class ParagraphElement
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ParagraphElement

For internal use only.

Overrides:
save in class ParagraphElement
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: ParagraphElement

For internal use only.

Overrides:
saveContents in class ParagraphElement
Throws:
java.io.IOException

setDataSource

public void setDataSource(java.lang.String dataSource)
Description copied from interface: IParagraphFieldElement

Sets the data source. The data source is equivalent to the field's FormulaForm.

Specified by:
setDataSource in interface IParagraphFieldElement
Parameters:
dataSource - A String that specifies the data source. The data source is equivalent to the field's FormulaForm.

setFieldFormat

public void setFieldFormat(IFieldFormat fieldFormat)
Description copied from interface: IParagraphFieldElement

Sets the field format.

Specified by:
setFieldFormat in interface IParagraphFieldElement
Parameters:
fieldFormat - An IFieldFormat object that specifies the field format.

startElement

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

For internal use only.


getFieldKind

public FieldKind getFieldKind()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
Overrides:
enumerateMembers in class ParagraphElement