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

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

public class Paragraph
extends java.lang.Object
implements IParagraph, IClone

This object is used to set the paragraph formatting. For the paragraph, you can specify the alignment, the font color, the indent and spacing, and so on. When possible, use the IParagraph interface.


Constructor Summary
Paragraph()
           
Paragraph(IParagraph 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)
           
 Alignment getAlignment()
           Returns the alignment of the paragraph.
 ControllableMixin getControllableMixin()
           
 IFontColor getFontColor()
           Returns the font color of the paragraph.
 IIndentAndSpacingFormat getIndentAndSpacingFormat()
           Returns the indent and spacing for the paragraph.
 ParagraphElements getParagraphElements()
           Returns all of the paragraph elements in the paragraph.
 ReadingOrder getReadingOrder()
           Returns the reading order of the paragraphs.
 TabStops getTabStops()
           Returns all of the tab stops in the paragraph.
 boolean hasContent(java.lang.Object srcParagraph)
           
 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 setAlignment(Alignment alignment)
           Sets the alignment of the paragraph.
 void setFontColor(IFontColor fontColor)
           Sets the font color of the paragraph.
 void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
           Sets the indent and spacing for the paragraph.
 void setParagraphElements(ParagraphElements paragraphElements)
           Sets all of the paragraph elements in the paragraph.
 void setReadingOrder(ReadingOrder newReadingOrder)
           Sets the reading order of the paragraphs.
 void setTabStops(TabStops tabStops)
           Sets all of the tab stops in the paragraph.
 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

Paragraph

public Paragraph(IParagraph src)

Paragraph

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


getAlignment

public Alignment getAlignment()
Description copied from interface: IParagraph

Returns the alignment of the paragraph.

Specified by:
getAlignment in interface IParagraph
Returns:
An Alignment object that specifies the alignment of the paragraph.

getFontColor

public IFontColor getFontColor()
Description copied from interface: IParagraph

Returns the font color of the paragraph.

Specified by:
getFontColor in interface IParagraph
Returns:
An IFontColor object that specifies the font color of the paragraph.
See Also:
IParagraph.setFontColor(com.crystaldecisions.sdk.occa.report.definition.IFontColor)

getIndentAndSpacingFormat

public IIndentAndSpacingFormat getIndentAndSpacingFormat()
Description copied from interface: IParagraph

Returns the indent and spacing for the paragraph.

Specified by:
getIndentAndSpacingFormat in interface IParagraph
Returns:
An IIndentAndSpacingFormat object that specifies the indent and spacing for the paragraph.

getParagraphElements

public ParagraphElements getParagraphElements()
Description copied from interface: IParagraph

Returns all of the paragraph elements in the paragraph.

Specified by:
getParagraphElements in interface IParagraph
Returns:
A ParagraphElements object containing all of the paragraph elements in the paragraph.

getReadingOrder

public ReadingOrder getReadingOrder()
Description copied from interface: IParagraph

Returns the reading order of the paragraphs.

Specified by:
getReadingOrder in interface IParagraph
Returns:
A ReadingOrder object that specifies the reading order of the paragraphs.

getTabStops

public TabStops getTabStops()
Description copied from interface: IParagraph

Returns all of the tab stops in the paragraph.

Specified by:
getTabStops in interface IParagraph
Returns:
A TabStops object that specifies all of the tab stops in the paragraph.

hasContent

public boolean hasContent(java.lang.Object srcParagraph)

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

setAlignment

public void setAlignment(Alignment alignment)
Description copied from interface: IParagraph

Sets the alignment of the paragraph.

Specified by:
setAlignment in interface IParagraph
Parameters:
alignment - An Alignment object that specifies the alignment of the paragraph.

setFontColor

public void setFontColor(IFontColor fontColor)
Description copied from interface: IParagraph

Sets the font color of the paragraph. For this change to be persistent, use IParagraphElement.setFontColor(IFontColor fontColor).

In order to set the font color, you will need to use syntax like:

  ITextObject newText = (ITextObject) oldText.clone(true);
        IFontColor fc = newText.getFontColor();
        fc.setColor(java.awt.Color.red);
        newText.setFontColor(fc);
        objectController.modify(oldText, newText);
  

Specified by:
setFontColor in interface IParagraph
Parameters:
fontColor - An IFontColor object that specifies the font color of the paragraph.

setIndentAndSpacingFormat

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

Sets the indent and spacing for the paragraph.

Specified by:
setIndentAndSpacingFormat in interface IParagraph
Parameters:
indentAndSpacingFormat - An IIndentAndSpacingFormat object that specifies the indent and spacing for the paragraph.

setParagraphElements

public void setParagraphElements(ParagraphElements paragraphElements)
Description copied from interface: IParagraph

Sets all of the paragraph elements in the paragraph.

Specified by:
setParagraphElements in interface IParagraph
Parameters:
paragraphElements - A ParagraphElements object containing all of the paragraph elements in the paragraph.

setReadingOrder

public void setReadingOrder(ReadingOrder newReadingOrder)
Description copied from interface: IParagraph

Sets the reading order of the paragraphs.

Specified by:
setReadingOrder in interface IParagraph
Parameters:
newReadingOrder - A ReadingOrder object that specifies the reading order of the paragraphs.

setTabStops

public void setTabStops(TabStops tabStops)
Description copied from interface: IParagraph

Sets all of the tab stops in the paragraph.

Specified by:
setTabStops in interface IParagraph
Parameters:
tabStops - A TabStops object that specifies all of the tab stops in the paragraph.

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)