|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ObjectFormat
public class ObjectFormat
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 |
---|
public ObjectFormat(IObjectFormat src)
public ObjectFormat()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public ObjectFormatConditionFormulas getConditionFormulas()
IObjectFormat
Returns the condition formulas used to override the ObjectFormat
object settings.
getConditionFormulas
in interface IObjectFormat
ObjectFormatConditionFormulas
object containing the condition formulas
used to override the ObjectFormat
object settings.public java.lang.String getCssClass()
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.
getCssClass
in interface IObjectFormat
String
.public boolean getEnableCanGrow()
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.
getEnableCanGrow
in interface IObjectFormat
true
if the object frame is expanded vertically, and false
otherwise.public boolean getEnableCloseAtPageBreak()
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.
getEnableCloseAtPageBreak
in interface IObjectFormat
true
if the border is closed on a page break, and false
otherwise.public boolean getEnableKeepTogether()
IObjectFormat
Returns true
if objects are kept together on the same page, and false
otherwise.
getEnableKeepTogether
in interface IObjectFormat
true
if objects are kept together on the same page, and false
otherwise.public boolean getEnableSuppress()
IObjectFormat
Returns true
if the object is suppressed, and false
otherwise.
getEnableSuppress
in interface IObjectFormat
true
if the object is suppressed, and false
otherwise.public Alignment getHorizontalAlignment()
IObjectFormat
Returns the horizontal alignment for the field.
getHorizontalAlignment
in interface IObjectFormat
Alignment
object that specifies the horizontal alignment for the field.public java.lang.String getHyperlinkText()
IObjectFormat
Returns the hyperlink text content.
getHyperlinkText
in interface IObjectFormat
String
that specifies the hyperlink text content.public HyperlinkType getHyperlinkType()
IObjectFormat
Returns the type of hyperlink.
getHyperlinkType
in interface IObjectFormat
HyperlinkType
object that contains the type of hyperlink.public TextRotationAngle getTextRotationAngle()
IObjectFormat
Returns the text rotation angle.
getTextRotationAngle
in interface IObjectFormat
TextRotationAngle
object that specifies the text rotation angle.public java.lang.String getToolTipText()
IObjectFormat
Returns the text found in the tooltip text.
getToolTipText
in interface IObjectFormat
String
that specifies the tooltip text.public boolean getEnableRepeatOnHorizontalPages()
getEnableRepeatOnHorizontalPages
in interface IObjectFormat
public boolean hasContent(java.lang.Object srcObjectFormat)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setConditionFormulas(ObjectFormatConditionFormulas conditionFormulas)
IObjectFormat
Sets the condition formulas used to override the ObjectFormat
object settings.
setConditionFormulas
in interface IObjectFormat
conditionFormulas
- An ObjectFormatConditionFormulas
object containing the
condition formulas used to override the ObjectFormat
object settings.public void setCssClass(java.lang.String cssClass)
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.
setCssClass
in interface IObjectFormat
cssClass
- A String
for the class name of the report object used in a CSS.public void setEnableCanGrow(boolean enableCanGrow)
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.
setEnableCanGrow
in interface IObjectFormat
enableCanGrow
- true
if the object frame is expanded vertically, and false
otherwise.public void setEnableCloseAtPageBreak(boolean enableCloseAtPageBreak)
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.
setEnableCloseAtPageBreak
in interface IObjectFormat
enableCloseAtPageBreak
- true
if the border is closed on a page break, and false
otherwise.public void setEnableKeepTogether(boolean enableKeepTogether)
IObjectFormat
Sets whether objects are kept together on the same page.
setEnableKeepTogether
in interface IObjectFormat
enableKeepTogether
- true
if objects are kept together on the same page, and false
otherwise.public void setEnableSuppress(boolean enableSuppress)
IObjectFormat
Sets whether the object is suppressed.
setEnableSuppress
in interface IObjectFormat
enableSuppress
- true
if the object is suppressed, and false
otherwise.public void setHorizontalAlignment(Alignment horizontalAlignment)
IObjectFormat
Sets the horizontal alignment for the field.
setHorizontalAlignment
in interface IObjectFormat
horizontalAlignment
- An Alignment
object that specifies the horizontal alignment for the field.public void setHyperlinkText(java.lang.String hyperlinkText)
IObjectFormat
Sets the hyperlink text content.
setHyperlinkText
in interface IObjectFormat
hyperlinkText
- A String
that specifies the hyperlink text content.public void setHyperlinkType(HyperlinkType hyperlinkType)
IObjectFormat
Sets the type of hyperlink.
setHyperlinkType
in interface IObjectFormat
hyperlinkType
- A HyperlinkType
object that contains the type of hyperlink.public void setTextRotationAngle(TextRotationAngle textRotationAngle)
IObjectFormat
Sets the text rotation angle.
setTextRotationAngle
in interface IObjectFormat
textRotationAngle
- A TextRotationAngle
object that specifies the text
rotation angle.public void setToolTipText(java.lang.String toolTipText)
IObjectFormat
Sets the text found in the tooltip text.
setToolTipText
in interface IObjectFormat
toolTipText
- A String
that specifies the tooltip text.public void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)
setEnableRepeatOnHorizontalPages
in interface IObjectFormat
public boolean skipWritingIdenticalObject()
For internal use only.
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject)
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |