com.crystaldecisions.sdk.occa.report.definition
Interface IBorder

All Superinterfaces:
IClone
All Known Implementing Classes:
Border

public interface IBorder
extends IClone

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


Method Summary
 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.
 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.
 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.
 

Method Detail

getBackgroundColor

java.awt.Color getBackgroundColor()

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

Returns:
A java.awt.Color object that specifies the background color of the border.

getBackgroundColorValue

int getBackgroundColorValue()
Deprecated. internal use only


getBorderColor

java.awt.Color getBorderColor()

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

Returns:
A java.awt.Color object that specifies the color of the border.

getBorderColorValue

int getBorderColorValue()
Deprecated. internal use only


getBottomLineStyle

LineStyle getBottomLineStyle()

Returns the style of the border's bottom line.

Returns:
A LineStyle object that specifies the style of the border's bottom line.

getConditionFormulas

BorderConditionFormulas getConditionFormulas()

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

Returns:
A BorderConditionFormulas object containing the condition formulas used to override the default border values.

getEnableTightHorizontal

boolean getEnableTightHorizontal()

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.

Returns:
true if the border is trimmed to match the size of the field, and false otherwise.

getHasDropShadow

boolean getHasDropShadow()

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

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

getLeftLineStyle

LineStyle getLeftLineStyle()

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

Returns:
A LineStyle object that specifies the style of the border's line on the left side.

getRightLineStyle

LineStyle getRightLineStyle()

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

Returns:
A LineStyle object that specifies the style of the border's line on the right side.

getTopLineStyle

LineStyle getTopLineStyle()

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

Returns:
A LineStyle object that specifies the style of the border's top line.

setBackgroundColor

void setBackgroundColor(java.awt.Color backgroundColor)

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

Parameters:
backgroundColor - A java.awt.Color object that specifies the background color of the border.

setBackgroundColorValue

void setBackgroundColorValue(int backgroundColor)
Deprecated. internal use only


setBorderColor

void setBorderColor(java.awt.Color borderColor)

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

Parameters:
borderColor - A java.awt.Color object that specifies the color of the border.

setBorderColorValue

void setBorderColorValue(int borderColor)
Deprecated. internal use only


setBottomLineStyle

void setBottomLineStyle(LineStyle bottomLineStyle)

Sets the style of the border's bottom line.

Parameters:
bottomLineStyle - A LineStyle object that specifies the style of the border's bottom line.

setConditionFormulas

void setConditionFormulas(BorderConditionFormulas conditionFormulas)

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

Parameters:
conditionFormulas - A BorderConditionFormulas object containing the condition formulas used to override the default border values.

setEnableTightHorizontal

void setEnableTightHorizontal(boolean enableTightHorizontal)

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.

Parameters:
enableTightHorizontal - true if the border is trimmed to match the size of the field, and false otherwise.

setHasDropShadow

void setHasDropShadow(boolean hasDropShadow)

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

Parameters:
hasDropShadow - true if a drop shadow is printed below and to the right of the field, and false otherwise.

setLeftLineStyle

void setLeftLineStyle(LineStyle leftLineStyle)

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

Parameters:
leftLineStyle - A LineStyle object that specifies the style of the border's line on the left side.

setRightLineStyle

void setRightLineStyle(LineStyle rightLineStyle)

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

Parameters:
rightLineStyle - A LineStyle object that specifies the style of the border's line on the right side.

setTopLineStyle

void setTopLineStyle(LineStyle topLineStyle)

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

Parameters:
topLineStyle - A LineStyle object that specifies the style of the border's top line.