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

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

public class Border
extends java.lang.Object
implements IBorder, IClone

This object defines the color and the line styles of a report object's border.


Field Summary
static int DROPSHADOW_BREADTH
           The breadth of a drop shadow in twips.
 
Constructor Summary
Border()
           
Border(IBorder 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)
           
 java.awt.Color getBackgroundColor()
           Returns the Color object that specifies the background color of the border.
 int getBackgroundColorValue()
          Deprecated. internal use only
 java.awt.Color getBorderColor()
           Returns the Color object that specifies the color of the border.
 int getBorderColorValue()
          Deprecated. internal use only
 LineStyle getBottomLineStyle()
           Returns the style of the border's bottom line.
 BorderConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the default border values.
 ControllableMixin getControllableMixin()
           
 boolean getEnableTightHorizontal()
           Returns true if the border is trimmed to match the size of the field, and false otherwise.
 boolean getHasDropShadow()
           Returns true if a drop shadow is printed below and to the right of the field, and false otherwise.
 LineStyle getLeftLineStyle()
           Returns the style of the border's line on the left side.
 LineStyle getRightLineStyle()
           Returns the style of the border's line on the right side.
 LineStyle getTopLineStyle()
           Returns the style of the border's top line.
 boolean hasContent(java.lang.Object srcBorder)
           
 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 setBackgroundColor(java.awt.Color backgroundColor)
           Sets the Color object that specifies the background color of the border.
 void setBackgroundColorValue(int backgroundColor)
          Deprecated. internal use only
 void setBorderColor(java.awt.Color borderColor)
           Sets the Color object that specifies the color of the border.
 void setBorderColorValue(int borderColor)
          Deprecated. internal use only
 void setBottomLineStyle(LineStyle bottomLineStyle)
           Sets the style of the border's bottom line.
 void setConditionFormulas(BorderConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the default border values.
 void setEnableTightHorizontal(boolean enableTightHorizontal)
           Sets whether the border is trimmed to match the size of the field.
 void setHasDropShadow(boolean hasDropShadow)
           Sets whether a drop shadow is printed below and to the right of the field.
 void setLeftLineStyle(LineStyle leftLineStyle)
           Sets the style of the border's line on the left side.
 void setRightLineStyle(LineStyle rightLineStyle)
           Sets the style of the border's line on the right side.
 void setTopLineStyle(LineStyle topLineStyle)
           Sets the style of the border's top line.
 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
 

Field Detail

DROPSHADOW_BREADTH

public static final int DROPSHADOW_BREADTH

The breadth of a drop shadow in twips.

See Also:
Constant Field Values
Constructor Detail

Border

public Border(IBorder src)

Border

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


getBackgroundColor

public java.awt.Color getBackgroundColor()
Description copied from interface: IBorder

Returns the Color object that specifies the background color of the border.

Specified by:
getBackgroundColor in interface IBorder
Returns:
A java.awt.Color object that specifies the background color of the border.

getBorderColor

public java.awt.Color getBorderColor()
Description copied from interface: IBorder

Returns the Color object that specifies the color of the border.

Specified by:
getBorderColor in interface IBorder
Returns:
A java.awt.Color object that specifies the color of the border.

getBottomLineStyle

public LineStyle getBottomLineStyle()
Description copied from interface: IBorder

Returns the style of the border's bottom line.

Specified by:
getBottomLineStyle in interface IBorder
Returns:
A LineStyle object that specifies the style of the border's bottom line.

getConditionFormulas

public BorderConditionFormulas getConditionFormulas()
Description copied from interface: IBorder

Returns the condition formulas used to override the default border values.

Specified by:
getConditionFormulas in interface IBorder
Returns:
A BorderConditionFormulas object containing the condition formulas used to override the default border values.

getEnableTightHorizontal

public boolean getEnableTightHorizontal()
Description copied from interface: IBorder

Returns true if the border is trimmed to match the size of the field, and false otherwise. false indicates that the border will be the same size for each record.

Specified by:
getEnableTightHorizontal in interface IBorder
Returns:
true if the border is trimmed to match the size of the field, and false otherwise.

getHasDropShadow

public boolean getHasDropShadow()
Description copied from interface: IBorder

Returns true if a drop shadow is printed below and to the right of the field, and false otherwise.

Specified by:
getHasDropShadow in interface IBorder
Returns:
true if a drop shadow is printed below and to the right of the field, and false otherwise.

getLeftLineStyle

public LineStyle getLeftLineStyle()
Description copied from interface: IBorder

Returns the style of the border's line on the left side. By default, no line is applied.

Specified by:
getLeftLineStyle in interface IBorder
Returns:
A LineStyle object that specifies the style of the border's line on the left side.

getRightLineStyle

public LineStyle getRightLineStyle()
Description copied from interface: IBorder

Returns the style of the border's line on the right side. By default, no line is applied.

Specified by:
getRightLineStyle in interface IBorder
Returns:
A LineStyle object that specifies the style of the border's line on the right side.

getTopLineStyle

public LineStyle getTopLineStyle()
Description copied from interface: IBorder

Returns the style of the border's top line. By default, no line is applied.

Specified by:
getTopLineStyle in interface IBorder
Returns:
A LineStyle object that specifies the style of the border's top line.

hasContent

public boolean hasContent(java.lang.Object srcBorder)

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

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)
Description copied from interface: IBorder

Sets the Color object that specifies the background color of the border.

Specified by:
setBackgroundColor in interface IBorder
Parameters:
backgroundColor - A java.awt.Color object that specifies the background color of the border.

setBorderColor

public void setBorderColor(java.awt.Color borderColor)
Description copied from interface: IBorder

Sets the Color object that specifies the color of the border.

Specified by:
setBorderColor in interface IBorder
Parameters:
borderColor - A java.awt.Color object that specifies the color of the border.

setBottomLineStyle

public void setBottomLineStyle(LineStyle bottomLineStyle)
Description copied from interface: IBorder

Sets the style of the border's bottom line.

Specified by:
setBottomLineStyle in interface IBorder
Parameters:
bottomLineStyle - A LineStyle object that specifies the style of the border's bottom line.

setConditionFormulas

public void setConditionFormulas(BorderConditionFormulas conditionFormulas)
Description copied from interface: IBorder

Sets the condition formulas used to override the default border values.

Specified by:
setConditionFormulas in interface IBorder
Parameters:
conditionFormulas - A BorderConditionFormulas object containing the condition formulas used to override the default border values.

setEnableTightHorizontal

public void setEnableTightHorizontal(boolean enableTightHorizontal)
Description copied from interface: IBorder

Sets whether the border is trimmed to match the size of the field. false indicates that the border will be the same size for each record.

Specified by:
setEnableTightHorizontal in interface IBorder
Parameters:
enableTightHorizontal - true if the border is trimmed to match the size of the field, and false otherwise.

setHasDropShadow

public void setHasDropShadow(boolean hasDropShadow)
Description copied from interface: IBorder

Sets whether a drop shadow is printed below and to the right of the field.

Specified by:
setHasDropShadow in interface IBorder
Parameters:
hasDropShadow - true if a drop shadow is printed below and to the right of the field, and false otherwise.

setLeftLineStyle

public void setLeftLineStyle(LineStyle leftLineStyle)
Description copied from interface: IBorder

Sets the style of the border's line on the left side. By default, no line is applied.

Specified by:
setLeftLineStyle in interface IBorder
Parameters:
leftLineStyle - A LineStyle object that specifies the style of the border's line on the left side.

setRightLineStyle

public void setRightLineStyle(LineStyle rightLineStyle)
Description copied from interface: IBorder

Sets the style of the border's line on the right side. By default, no line is applied.

Specified by:
setRightLineStyle in interface IBorder
Parameters:
rightLineStyle - A LineStyle object that specifies the style of the border's line on the right side.

setTopLineStyle

public void setTopLineStyle(LineStyle topLineStyle)
Description copied from interface: IBorder

Sets the style of the border's top line. By default, no line is applied.

Specified by:
setTopLineStyle in interface IBorder
Parameters:
topLineStyle - A LineStyle object that specifies the style of the border's top line.

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.


getBackgroundColorValue

public int getBackgroundColorValue()
Deprecated. internal use only

Specified by:
getBackgroundColorValue in interface IBorder

getBorderColorValue

public int getBorderColorValue()
Deprecated. internal use only

Specified by:
getBorderColorValue in interface IBorder

setBackgroundColorValue

public void setBackgroundColorValue(int backgroundColor)
Deprecated. internal use only

Specified by:
setBackgroundColorValue in interface IBorder

setBorderColorValue

public void setBorderColorValue(int borderColor)
Deprecated. internal use only

Specified by:
setBorderColorValue in interface IBorder

getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)