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

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

public class ObjectFormat
extends java.lang.Object
implements IObjectFormat, IClone

This object is used to format different kinds of ReportObject objects.


Constructor Summary
ObjectFormat()
           
ObjectFormat(IObjectFormat 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, com.crystaldecisions.xml.serialization.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)
           
 ObjectFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the ObjectFormat object settings.
 ControllableMixin getControllableMixin()
           
 java.lang.String getCssClass()
          Returns the specified class name for the report object.
 boolean getEnableCanGrow()
           Returns true if the object frame is expanded vertically, and false otherwise.
 boolean getEnableCloseAtPageBreak()
           Returns true if the border is closed on a page break, and false otherwise.
 boolean getEnableKeepTogether()
           Returns true if objects are kept together on the same page, and false otherwise.
 boolean getEnableRepeatOnHorizontalPages()
           
 boolean getEnableSuppress()
           Returns true if the object is suppressed, and false otherwise.
 Alignment getHorizontalAlignment()
           Returns the horizontal alignment for the field.
 java.lang.String getHyperlinkText()
           Returns the hyperlink text content.
 HyperlinkType getHyperlinkType()
           Returns the type of hyperlink.
 TextRotationAngle getTextRotationAngle()
           Returns the text rotation angle.
 java.lang.String getToolTipText()
           Returns the text found in the tooltip text.
 boolean hasContent(java.lang.Object srcObjectFormat)
           
 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(ObjectFormatConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the ObjectFormat object settings.
 void setCssClass(java.lang.String cssClass)
           Sets the CSS class name.
 void setEnableCanGrow(boolean enableCanGrow)
           Sets whether the object frame is expanded vertically.
 void setEnableCloseAtPageBreak(boolean enableCloseAtPageBreak)
           Sets whether the border is closed on a page break.
 void setEnableKeepTogether(boolean enableKeepTogether)
           Sets whether objects are kept together on the same page.
 void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)
           
 void setEnableSuppress(boolean enableSuppress)
           Sets whether the object is suppressed.
 void setHorizontalAlignment(Alignment horizontalAlignment)
           Sets the horizontal alignment for the field.
 void setHyperlinkText(java.lang.String hyperlinkText)
           Sets the hyperlink text content.
 void setHyperlinkType(HyperlinkType hyperlinkType)
           Sets the type of hyperlink.
 void setTextRotationAngle(TextRotationAngle textRotationAngle)
           Sets the text rotation angle.
 void setToolTipText(java.lang.String toolTipText)
           Sets the text found in the tooltip text.
 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

ObjectFormat

public ObjectFormat(IObjectFormat src)

ObjectFormat

public ObjectFormat()
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,
                                     com.crystaldecisions.xml.serialization.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 ObjectFormatConditionFormulas getConditionFormulas()
Description copied from interface: IObjectFormat

Returns the condition formulas used to override the ObjectFormat object settings.

Specified by:
getConditionFormulas in interface IObjectFormat
Returns:
An ObjectFormatConditionFormulas object containing the condition formulas used to override the ObjectFormat object settings.

getCssClass

public java.lang.String getCssClass()
Description copied from interface: IObjectFormat

Returns the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Specified by:
getCssClass in interface IObjectFormat
Returns:
The class name for the report object (used in a CSS) as a String.

getEnableCanGrow

public boolean getEnableCanGrow()
Description copied from interface: IObjectFormat

Returns true if the object frame is expanded vertically, and false otherwise. Setting this to true is useful for objects that contain variable length strings, such as memo fields. If this is set to false, the data will be truncated when the value is larger than the frame.

Specified by:
getEnableCanGrow in interface IObjectFormat
Returns:
true if the object frame is expanded vertically, and false otherwise.

getEnableCloseAtPageBreak

public boolean getEnableCloseAtPageBreak()
Description copied from interface: IObjectFormat

Returns true if the border is closed on a page break, and false otherwise. If an object has a border and the object is split over two pages, you have two options: set to true to put a border around each part of the split object, or set to false to display each part of the object with a partial border.

Specified by:
getEnableCloseAtPageBreak in interface IObjectFormat
Returns:
true if the border is closed on a page break, and false otherwise.

getEnableKeepTogether

public boolean getEnableKeepTogether()
Description copied from interface: IObjectFormat

Returns true if objects are kept together on the same page, and false otherwise.

Specified by:
getEnableKeepTogether in interface IObjectFormat
Returns:
true if objects are kept together on the same page, and false otherwise.

getEnableSuppress

public boolean getEnableSuppress()
Description copied from interface: IObjectFormat

Returns true if the object is suppressed, and false otherwise.

Specified by:
getEnableSuppress in interface IObjectFormat
Returns:
true if the object is suppressed, and false otherwise.

getHorizontalAlignment

public Alignment getHorizontalAlignment()
Description copied from interface: IObjectFormat

Returns the horizontal alignment for the field.

Specified by:
getHorizontalAlignment in interface IObjectFormat
Returns:
An Alignment object that specifies the horizontal alignment for the field.

getHyperlinkText

public java.lang.String getHyperlinkText()
Description copied from interface: IObjectFormat

Returns the hyperlink text content.

Specified by:
getHyperlinkText in interface IObjectFormat
Returns:
A String that specifies the hyperlink text content.

getHyperlinkType

public HyperlinkType getHyperlinkType()
Description copied from interface: IObjectFormat

Returns the type of hyperlink.

Specified by:
getHyperlinkType in interface IObjectFormat
Returns:
A HyperlinkType object that contains the type of hyperlink.

getTextRotationAngle

public TextRotationAngle getTextRotationAngle()
Description copied from interface: IObjectFormat

Returns the text rotation angle.

Specified by:
getTextRotationAngle in interface IObjectFormat
Returns:
A TextRotationAngle object that specifies the text rotation angle.

getToolTipText

public java.lang.String getToolTipText()
Description copied from interface: IObjectFormat

Returns the text found in the tooltip text.

Specified by:
getToolTipText in interface IObjectFormat
Returns:
A String that specifies the tooltip text.

getEnableRepeatOnHorizontalPages

public boolean getEnableRepeatOnHorizontalPages()
Specified by:
getEnableRepeatOnHorizontalPages in interface IObjectFormat

hasContent

public boolean hasContent(java.lang.Object srcObjectFormat)

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(ObjectFormatConditionFormulas conditionFormulas)
Description copied from interface: IObjectFormat

Sets the condition formulas used to override the ObjectFormat object settings.

Specified by:
setConditionFormulas in interface IObjectFormat
Parameters:
conditionFormulas - An ObjectFormatConditionFormulas object containing the condition formulas used to override the ObjectFormat object settings.

setCssClass

public void setCssClass(java.lang.String cssClass)
Description copied from interface: IObjectFormat

Sets the CSS class name. This method enables you to apply classes to report objects and to sections of a report, instead of manually changing the formatting of the report.

Specified by:
setCssClass in interface IObjectFormat
Parameters:
cssClass - A String for the class name of the report object used in a CSS.

setEnableCanGrow

public void setEnableCanGrow(boolean enableCanGrow)
Description copied from interface: IObjectFormat

Sets whether the object frame is expanded vertically. Setting this to true is useful for objects that contain variable length strings, such as memo fields. If this is set to false, the data will be truncated when the value is larger than the frame.

Specified by:
setEnableCanGrow in interface IObjectFormat
Parameters:
enableCanGrow - true if the object frame is expanded vertically, and false otherwise.

setEnableCloseAtPageBreak

public void setEnableCloseAtPageBreak(boolean enableCloseAtPageBreak)
Description copied from interface: IObjectFormat

Sets whether the border is closed on a page break. If an object has a border and the object is split over two pages, you have two options: set to true to put a border around each part of the split object, or set to false to display each part of the object with a partial border.

Specified by:
setEnableCloseAtPageBreak in interface IObjectFormat
Parameters:
enableCloseAtPageBreak - true if the border is closed on a page break, and false otherwise.

setEnableKeepTogether

public void setEnableKeepTogether(boolean enableKeepTogether)
Description copied from interface: IObjectFormat

Sets whether objects are kept together on the same page.

Specified by:
setEnableKeepTogether in interface IObjectFormat
Parameters:
enableKeepTogether - true if objects are kept together on the same page, and false otherwise.

setEnableSuppress

public void setEnableSuppress(boolean enableSuppress)
Description copied from interface: IObjectFormat

Sets whether the object is suppressed.

Specified by:
setEnableSuppress in interface IObjectFormat
Parameters:
enableSuppress - true if the object is suppressed, and false otherwise.

setHorizontalAlignment

public void setHorizontalAlignment(Alignment horizontalAlignment)
Description copied from interface: IObjectFormat

Sets the horizontal alignment for the field.

Specified by:
setHorizontalAlignment in interface IObjectFormat
Parameters:
horizontalAlignment - An Alignment object that specifies the horizontal alignment for the field.

setHyperlinkText

public void setHyperlinkText(java.lang.String hyperlinkText)
Description copied from interface: IObjectFormat

Sets the hyperlink text content.

Specified by:
setHyperlinkText in interface IObjectFormat
Parameters:
hyperlinkText - A String that specifies the hyperlink text content.

setHyperlinkType

public void setHyperlinkType(HyperlinkType hyperlinkType)
Description copied from interface: IObjectFormat

Sets the type of hyperlink.

Specified by:
setHyperlinkType in interface IObjectFormat
Parameters:
hyperlinkType - A HyperlinkType object that contains the type of hyperlink.

setTextRotationAngle

public void setTextRotationAngle(TextRotationAngle textRotationAngle)
Description copied from interface: IObjectFormat

Sets the text rotation angle.

Specified by:
setTextRotationAngle in interface IObjectFormat
Parameters:
textRotationAngle - A TextRotationAngle object that specifies the text rotation angle.

setToolTipText

public void setToolTipText(java.lang.String toolTipText)
Description copied from interface: IObjectFormat

Sets the text found in the tooltip text.

Specified by:
setToolTipText in interface IObjectFormat
Parameters:
toolTipText - A String that specifies the tooltip text.

setEnableRepeatOnHorizontalPages

public void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)
Specified by:
setEnableRepeatOnHorizontalPages in interface IObjectFormat

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.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)