com.f1j.ss
Class CellFormat

java.lang.Object
  |
  +--com.actuate.util.Debug
        |
        +--com.f1j.util.Debug
              |
              +--com.f1j.util.ObjConst
                    |
                    +--com.f1j.util.Obj
                          |
                          +--com.f1j.util.SharedHelper
                                |
                                +--com.f1j.util.SharedObj
                                      |
                                      +--com.f1j.util.FormatImpl
                                            |
                                            +--com.f1j.paint.FormatImpl
                                                  |
                                                  +--com.f1j.ss.CellFormat
public class CellFormat
extends com.f1j.paint.FormatImpl
implements com.f1j.ss.FormatHolder, Format

this class provides the API for creating and returning information about cell formats.

Field Summary
static short eBorderDashed
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDashed
static short eBorderDotted
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDotted
static short eBorderDouble
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDouble
static short eBorderHair
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderHair
static short eBorderMedium
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderMedium
static short eBorderNone
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderNone
static short eBorderThick
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderThick
static short eBorderThin
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderThin
static short eBottomBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderBottom
static short eBottomBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eDiagonalDownBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagDown
static short eDiagonalDownBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eDiagonalUpBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagUp
static short eDiagonalUpBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eHidden
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.eHidden
static short eHorizontalInsideBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderInsideHoriz
static short eHorizontalInsideBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eLeftBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderLeft
static short eLeftBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eLocked
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.eLocked
static short eMergeCells
          Deprecated. Replaced by com.f1j.ss.AlignFormat.eMergeCells
static short eRightBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderRight
static short eRightBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
static short eTopBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderTop
static short eTopBorderColor
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagDown
static short eValidationRule
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.eRule
static short eValidationText
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.eText
static short eVerticalInsideBorder
          Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderInsideVert
static short eVerticalInsideBorderColor
          Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
 
Method Summary
 AlignFormat align()
          Returns the alignment format object for this object.
 BorderFormat border()
          Returns the border format object for this object.
 FillFormat fill()
          Returns the fill format object for this object.
 FontFormat font()
          Returns the font format object for this object.
 short getBottomBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getBottomBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 short getHorizontalInsideBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getHorizontalInsideBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 short getLeftBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getLeftBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 short getRightBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getRightBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 short getTopBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getTopBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 java.lang.String getValidationRule()
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.getRule(int, int)
 java.lang.String getValidationRuleLocal()
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.getRuleLocal(int, int)
 java.lang.String getValidationText()
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.getText()
 short getVerticalInsideBorder()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
 int getVerticalInsideBorderColor()
          Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
 boolean isHidden()
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.isHidden()
 boolean isLocked()
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.isLocked()
 boolean isMergeCells()
          Deprecated. Replaced by com.f1j.ss.AlignFormat.isMergeCells
 boolean isUndefined(short property)
          Deprecated. Replaced by com.f1j.util.FormatBase.isUndefined(EProperty)
 NumberFormat number()
          Returns the number format object for this object.
 ProtectionFormat protection()
          Returns the protection format object for this object.
 void setBottomBorder(short bottom)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setBottomBorderColor(int bottom)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void setHidden(boolean hidden)
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.setHidden(boolean)
 void setHorizontalInsideBorder(short horizontalInside)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setHorizontalInsideBorderColor(int horizontalInside)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void setLeftBorder(short left)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setLeftBorderColor(int left)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void setLocked(boolean locked)
          Deprecated. Replaced by com.f1j.ss.ProtectionFormat.setLocked(boolean)
 void setMergeCells(boolean mergeCells)
          Deprecated. Replaced by com.f1j.ss.AlignFormat.setMergeCells(boolean)
 void setPattern(short iStyle)
          Deprecated. Replaced by com.f1j.paint.FillFormat.setPattern(EPattern)
 void setRightBorder(short right)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setRightBorderColor(int right)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void setTopBorder(short top)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setTopBorderColor(int top)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void setUndefined(short property, boolean undefined)
          Deprecated. Replaced by com.f1j.util.FormatBase.setUndefined(EProperty)
 void setValidationRule(Book book, java.lang.String rule, int row, int col)
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.setRule(rule, row, col)
 void setValidationRuleLocal(Book book, java.lang.String rule, int row, int col)
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.setRuleLocal(rule, row, col)
 void setValidationText(java.lang.String text)
          Deprecated. Replaced by com.f1j.ss.ValidationFormat.setText(text)
 void setVerticalInsideBorder(short verticalInside)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
 void setVerticalInsideBorderColor(int verticalInside)
          Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
 void useAllFormats()
          Instructs the CellFormat object to use all of the format settings.
 ValidationFormat validation()
          Returns the validation format object for this object.
 

Field Detail

eBorderNone

public static final short eBorderNone
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderNone
No border.

eBorderThin

public static final short eBorderThin
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderThin
Thin solid line border.

eBorderMedium

public static final short eBorderMedium
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderMedium
Medium solid line border.

eBorderDashed

public static final short eBorderDashed
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDashed
Dashed line border.

eBorderDotted

public static final short eBorderDotted
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDotted
Dotted line border.

eBorderThick

public static final short eBorderThick
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderThick
Thick solid line border.

eBorderDouble

public static final short eBorderDouble
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDouble
Double border.

eBorderHair

public static final short eBorderHair
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderHair
Hairline border.

eMergeCells

public static final short eMergeCells
Deprecated. Replaced by com.f1j.ss.AlignFormat.eMergeCells
Cell is part of a merged cell.

eValidationRule

public static final short eValidationRule
Deprecated. Replaced by com.f1j.ss.ValidationFormat.eRule
Validation rule.

eValidationText

public static final short eValidationText
Deprecated. Replaced by com.f1j.ss.ValidationFormat.eText
Validation text.

eTopBorder

public static final short eTopBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderTop
Top border.

eLeftBorder

public static final short eLeftBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderLeft
Left border.

eBottomBorder

public static final short eBottomBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderBottom
Bottom border.

eRightBorder

public static final short eRightBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderRight
Right border.

eVerticalInsideBorder

public static final short eVerticalInsideBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderInsideVert
Vertical inside border.

eHorizontalInsideBorder

public static final short eHorizontalInsideBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderInsideHoriz
Horizontal inside border.

eDiagonalUpBorder

public static final short eDiagonalUpBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagUp
Diagonal-up border.

eDiagonalDownBorder

public static final short eDiagonalDownBorder
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagDown
Diagonal-down border.

eTopBorderColor

public static final short eTopBorderColor
Deprecated. Replaced by com.f1j.ss.BorderFormat.eBorderDiagDown
Top border color.

eLeftBorderColor

public static final short eLeftBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Left border color.

eBottomBorderColor

public static final short eBottomBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Bottom border color.

eRightBorderColor

public static final short eRightBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Right border color.

eVerticalInsideBorderColor

public static final short eVerticalInsideBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Vertical inside border color.

eHorizontalInsideBorderColor

public static final short eHorizontalInsideBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Horizontal inside border color.

eDiagonalUpBorderColor

public static final short eDiagonalUpBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Diagonal-up border color.

eDiagonalDownBorderColor

public static final short eDiagonalDownBorderColor
Deprecated. use calls com.f1j.ss.BorderFormat.getColor() and com.f1j.ss.BorderFormat.setStyleAndColor()
Diagonal-down border color.

eHidden

public static final short eHidden
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.eHidden
Hidden.

eLocked

public static final short eLocked
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.eLocked
Protection attribute.
Method Detail

getBottomBorder

public short getBottomBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the bottom edge of the cell.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setBottomBorder(short)

getBottomBorderColor

public int getBottomBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the bottom edge of the cell. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
Returns:
an int representing the color.
See Also:
setBottomBorderColor(int)

getHorizontalInsideBorder

public short getHorizontalInsideBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the horizontal inside border.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setHorizontalInsideBorder(short)

getHorizontalInsideBorderColor

public int getHorizontalInsideBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the horizontal inside border.
Returns:
an int representing the color. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
setHorizontalInsideBorderColor(int)

getLeftBorder

public short getLeftBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the left edge of the cell.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setLeftBorder(short)

getLeftBorderColor

public int getLeftBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the left edge of the cell.
Returns:
an int representing the color. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
setLeftBorderColor(int)

getRightBorder

public short getRightBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the right edge of the cell.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setRightBorder(short)

getRightBorderColor

public int getRightBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the right edge of the cell.
Returns:
an int representing the color. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
setRightBorderColor(int)

getTopBorder

public short getTopBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the top edge of the cell.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setTopBorder(short)

getTopBorderColor

public int getTopBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the top edge of the cell.
Returns:
an int representing the color. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
setTopBorderColor(int)

getValidationRule

public java.lang.String getValidationRule()
Deprecated. Replaced by com.f1j.ss.ValidationFormat.getRule(int, int)
Returns the validation rule associated with the active cell in US english.
Returns:
a string describing the validation rule (such as "(A1 > 100)").
See Also:
setValidationRule(com.f1j.ss.Book, java.lang.String, int, int)

getValidationRuleLocal

public java.lang.String getValidationRuleLocal()
Deprecated. Replaced by com.f1j.ss.ValidationFormat.getRuleLocal(int, int)
Returns the validation rule associated with the active cell in the user's language.
Returns:
a string describing the validation rule(such as "(A1 > 100)").
See Also:
setValidationRuleLocal(com.f1j.ss.Book, java.lang.String, int, int)

getValidationText

public java.lang.String getValidationText()
Deprecated. Replaced by com.f1j.ss.ValidationFormat.getText()
Returns the text to be displayed in the cell if the validation rule fails.
Returns:
a string describing the text.
See Also:
setValidationText(String)

getVerticalInsideBorder

public short getVerticalInsideBorder()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getStyle(EProperty)
Returns the border style for the vertical inside border.
Returns:
a short integer representing one of the following border styles:
                    eBorderNone             = 0
                    eBorderThin             = 1
                    eBorderMedium           = 2
                    eBorderDashed           = 3
                    eBorderDotted           = 4
                    eBorderThick            = 5
                    eBorderDouble           = 6
                    eBorderHair             = 7
                    eBorderMediumDash       = 8
                    eBorderDashDot          = 9
                    eBorderMediumDashDot    = 10
                    eBorderDashDotDot       = 11
                    eBorderMediumDashDotDot = 12
                    eBorderSlantedDashDot   = 13
See Also:
setVerticalInsideBorder(short)

getVerticalInsideBorderColor

public int getVerticalInsideBorderColor()
Deprecated. Replaced by com.f1j.ss.BorderFormat.getColor(EProperty)
Returns the color used to display the vertical inside border.
Returns:
an int representing the color. The color is returned as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
setVerticalInsideBorderColor(int)

isHidden

public boolean isHidden()
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.isHidden()
Returns whether formulas are hidden.
Returns:
boolean. true = hidden. false = not hidden.
See Also:
setHidden(boolean)

isLocked

public boolean isLocked()
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.isLocked()
Returns whether the active cell is locked.
Returns:
boolean. true = locked. false = not locked.
See Also:
setLocked(boolean)

isMergeCells

public boolean isMergeCells()
Deprecated. Replaced by com.f1j.ss.AlignFormat.isMergeCells
Returns the merge cells setting.
Returns:
boolean. true = cells are merged.
See Also:
setMergeCells(boolean)

isUndefined

public boolean isUndefined(short property)
                    throws F1Exception
Deprecated. Replaced by com.f1j.util.FormatBase.isUndefined(EProperty)
Returns whether a CellFormat attribute has been defined.
Parameters:
property - One of the following CellFormat attributes:

CellFormat Attributes
eFontName eFontSize eFontBold eFontItalic
eFontUnderline eFontStrikeout eFontColor eFontOutline
eFontShadow eHorizontalAlignment eVerticalAlignment eWordWrap
eOrientation eMergeCells ePattern ePatternFG
ePatternBG eValueFormat eValueFormatType eValidationRule
eValidationText eTopBorder eLeftBorder eBottomBorder
eRightBorder eVerticalInsideBorder eHorizontalInsideBorder eTopBorderColor
eLeftBorderColor eBottomBorderColor eRightBorderColor eVerticalInsideBorder
eHorizontalInsideBorder eHidden eLocked
Returns:
boolean. true = the attribute is undefined. false = the attribute is defined. if an attribute for any cell in the range is defined this method returns false.
Throws:
F1Exception - if the value for property is invalid.
Specified by:
isUndefined in interface Format
See Also:
setUndefined(short, boolean)

setBottomBorder

public void setBottomBorder(short bottom)
                     throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the style for the bottom border.
Parameters:
bottom - one of the following border styles:
                                eBorderNone             = 0
                                eBorderThin             = 1
                                eBorderMedium           = 2
                                eBorderDashed           = 3
                                eBorderDotted           = 4
                                eBorderThick            = 5
                                eBorderDouble           = 6
                                eBorderHair             = 7
                                eBorderMediumDash       = 8
                                eBorderDashDot          = 9
                                eBorderMediumDashDot    = 10
                                eBorderDashDotDot       = 11
                                eBorderMediumDashDotDot = 12
                                eBorderSlantedDashDot   = 13
Throws:
F1Exception - if there is no active cell.
See Also:
getBottomBorder()

setBottomBorderColor

public void setBottomBorderColor(int bottom)
                          throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color used to display the bottom edge of the cell.
Parameters:
bottom - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
Throws:
F1Exception - if there is no active cell.
See Also:
getBottomBorderColor()

setPattern

public void setPattern(short iStyle)
Deprecated. Replaced by com.f1j.paint.FillFormat.setPattern(EPattern)
Sets the pattern type.

Parameters:
iStyle - a number corresponding to the e.Spreadsheet patterns. Patterns are only supported under Java 2. Under Java 1.1, patterns will be displayed as solid.

Pattern Constants
ePatternNull ePatternSolid ePattern50Percent
ePattern70Percent ePattern25Percent ePatternDarkHorizontal
ePatternDarkVertical ePatternWideDownwardDiagonal ePatternWideUpwardDiagonal
ePatternSmallCheckerBoard ePatternTrellis ePatternLightHorizontal
ePatternLightVertical ePatternLightDownwardDiagonal ePatternLightUpwardDiagonal
ePatternSmallGrid ePattern30Percent ePattern20Percent
ePattern10Percent ePattern5Percent ePattern40Percent
ePattern60Percent ePattern75Percent ePattern80Percent
ePattern90Percent ePatternLargeCheckerBoard ePatternLargeGrid
ePatternDottedGrid ePatternHorizontalBrick ePatternDiagonalBrick
ePatternNarrowVertical ePatternNarrowHorizontal ePatternDashedVertical
ePatternDashedHorizontal ePatternDarkDownwardDiagonal ePatternDarkUpwardDiagonal
ePatternDashedDownwardDiagonal ePatternDashedUpwardDiagonal ePatternSolidDiamond
ePatternOutlinedDiamond ePatternDottedDiamond ePatternLargeConfetti
ePatternSmallConfetti ePatternZigZag ePatternDivot
ePatternWave ePatternShingle ePatternWeave
ePatternPlaid ePatternSphere ePatternHorzGradient
ePatternVertGradient ePatternDiagGradient ePatternRevDiagGradient
ePatternMidHorzGradient ePatternMidVertGradient ePatternMidDiagGradient
ePatternMidRevDiagGradient ePatternHorzVertGradient ePatternVertHorzGradient
ePatternRevHorzVertGradient ePatternRevVertHorzGradient ePatternCenterGradient
ePatternMidGradient ePatternNewsPrint ePatternRecycledPaper
ePatternParchment ePatternStationary ePatternGreenMarble
ePatternWhiteMarble ePatternBrownMarble ePatternGranite
ePatternBlueTissuePaper ePatternPinkTissuePaper ePatternPurpleMesh
ePatternBouquet ePatternPapyrus ePatternCanvas
ePatternDenim ePatternWovenMat ePatternWaterDroplets
ePatternPaperBag ePatternFishFossil ePatternSand
ePatternCork ePatternWalnut ePatternOak
ePatternMediumWood ePatternName

Specified by:
setPattern in interface Format
See Also:
FormatImpl.getPattern()

setHidden

public void setHidden(boolean hidden)
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.setHidden(boolean)
Sets the display status of an element.
Parameters:
hidden - boolean. true = hidden. false = visible.
See Also:
isHidden()

setHorizontalInsideBorder

public void setHorizontalInsideBorder(short horizontalInside)
                               throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the horizontal inside border style.
Parameters:
horizontalInside - short integer representing one of the following border styles:
                                                    eBorderNone             = 0
                                                    eBorderThin             = 1
                                                    eBorderMedium           = 2
                                                    eBorderDashed           = 3
                                                    eBorderDotted           = 4
                                                    eBorderThick            = 5
                                                    eBorderDouble           = 6
                                                    eBorderHair             = 7
                                                    eBorderMediumDash       = 8
                                                    eBorderDashDot          = 9
                                                    eBorderMediumDashDot    = 10
                                                    eBorderDashDotDot       = 11
                                                    eBorderMediumDashDotDot = 12
                                                    eBorderSlantedDashDot   = 13
Throws:
F1Exception - if a parameter is invalid.
See Also:
getHorizontalInsideBorder()

setHorizontalInsideBorderColor

public void setHorizontalInsideBorderColor(int horizontalInside)
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color of the horizontal inside border.
Parameters:
horizontalInside - an int representing the color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
getHorizontalInsideBorderColor()

setLeftBorder

public void setLeftBorder(short left)
                   throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the style for the left border.
Parameters:
left - one of the following border styles:
                            eBorderNone             = 0
                            eBorderThin             = 1
                            eBorderMedium           = 2
                            eBorderDashed           = 3
                            eBorderDotted           = 4
                            eBorderThick            = 5
                            eBorderDouble           = 6
                            eBorderHair             = 7
                            eBorderMediumDash       = 8
                            eBorderDashDot          = 9
                            eBorderMediumDashDot    = 10
                            eBorderDashDotDot       = 11
                            eBorderMediumDashDotDot = 12
                            eBorderSlantedDashDot   = 13
Throws:
F1Exception - if there is no active cell.
See Also:
getLeftBorder()

setLeftBorderColor

public void setLeftBorderColor(int left)
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color used to display the left edge of the cell.
Parameters:
left - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
See Also:
getLeftBorderColor()

setLocked

public void setLocked(boolean locked)
Deprecated. Replaced by com.f1j.ss.ProtectionFormat.setLocked(boolean)
Sets the locked cell flag.
Parameters:
locked - boolean. true = lock the cell. false = unlock the cell.
See Also:
isLocked()

setMergeCells

public void setMergeCells(boolean mergeCells)
Deprecated. Replaced by com.f1j.ss.AlignFormat.setMergeCells(boolean)
Sets the mergeCells attribute.
Parameters:
mergeCells - boolean. Indicates whether cells are to be merged.
See Also:
isMergeCells()

setRightBorder

public void setRightBorder(short right)
                    throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the style for the right border.
Parameters:
right - one of the following border styles: 
                              eBorderNone             = 0
                              eBorderThin             = 1
                              eBorderMedium           = 2
                              eBorderDashed           = 3
                              eBorderDotted           = 4
                              eBorderThick            = 5
                              eBorderDouble           = 6
                              eBorderHair             = 7
                              eBorderMediumDash       = 8
                              eBorderDashDot          = 9
                              eBorderMediumDashDot    = 10
                              eBorderDashDotDot       = 11
                              eBorderMediumDashDotDot = 12
                              eBorderSlantedDashDot   = 13
Throws:
F1Exception - if there is no active cell.
See Also:
getRightBorder()

setRightBorderColor

public void setRightBorderColor(int right)
                         throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color used to display the right edge of the cell.
Parameters:
right - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
Throws:
F1Exception - if there is no active cell.
See Also:
getRightBorderColor()

setTopBorder

public void setTopBorder(short top)
                  throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the style for the top edge of the cell.
Parameters:
top - one of the following border styles:
                          eBorderNone             = 0
                          eBorderThin             = 1
                          eBorderMedium           = 2
                          eBorderDashed           = 3
                          eBorderDotted           = 4
                          eBorderThick            = 5
                          eBorderDouble           = 6
                          eBorderHair             = 7
                          eBorderMediumDash       = 8
                          eBorderDashDot          = 9
                          eBorderMediumDashDot    = 10
                          eBorderDashDotDot       = 11
                          eBorderMediumDashDotDot = 12
                          eBorderSlantedDashDot   = 13
Throws:
F1Exception - if there is no active cell.
See Also:
getTopBorder()

setTopBorderColor

public void setTopBorderColor(int top)
                       throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color used to display the top edge of the cell.
Parameters:
top - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
Throws:
F1Exception - if there is no active cell.
See Also:
getTopBorderColor()

setUndefined

public void setUndefined(short property,
                         boolean undefined)
                  throws F1Exception
Deprecated. Replaced by com.f1j.util.FormatBase.setUndefined(EProperty)
Sets whether a cell format attribute has been defined.
Parameters:
property - One of the following attributes:

CellFormat Attributes
eFontName eFontSize eFontBold eFontItalic
eFontUnderline eFontStrikeout eFontColor eFontOutline
eFontShadow eHorizontalAlignment eVerticalAlignment eWordWrap
eOrientation eMergeCells ePattern ePatternFG
ePatternBG eValueFormat eValueFormatType eValidationRule
eValidationText eTopBorder eLeftBorder eBottomBorder
eRightBorder eVerticalInsideBorder eHorizontalInsideBorder eTopBorderColor
eLeftBorderColor eBottomBorderColor eRightBorderColor eVerticalInsideBorder
eHorizontalInsideBorder eHidden eLocked

undefined - boolean. true = the attribute is not defined.
Throws:
F1Exception - BAD_ARGUMENT if an invalid property is specified.
Specified by:
setUndefined in interface Format
See Also:
isUndefined(short)

setValidationRule

public void setValidationRule(Book book,
                              java.lang.String rule,
                              int row,
                              int col)
                       throws F1Exception
Deprecated. Replaced by com.f1j.ss.ValidationFormat.setRule(rule, row, col)
Sets the validation rule expression, in US English.

Using the row and column coordinates as the starting point, the rule adjusts according to the position of the active cell.

Parameters:
book - the Book this validation rule will apply to.
rule - the validation rule expression (such as "(A1>100)"). The cell reference in the expression represents the ending point of a calculated relative reference.
row - the coordinate of the row used as a starting point for the calculated relative reference.
col - the coordinate of the column used as the starting point for the calculated relative reference.
Throws:
F1Exception - if a parameter is invalid.
See Also:
getValidationRule()

setValidationRuleLocal

public void setValidationRuleLocal(Book book,
                                   java.lang.String rule,
                                   int row,
                                   int col)
                            throws F1Exception
Deprecated. Replaced by com.f1j.ss.ValidationFormat.setRuleLocal(rule, row, col)
Sets the validation rule expression, in the user's language.

Using the row and column coordinates as the starting point, the rule adjusts according to the position of the active cell.

Parameters:
book - the Book to which this validation rule will apply.
rule - the validation rule expression, such as (such as "(A1>100)"). The cell reference in the expression represents the ending point of a calculated relative reference.
row - the coordinate of the row used as a starting point for the calculated relative reference.
col - the coordinate of the column used as the starting point for the calculated relative reference.
Throws:
F1Exception - if a parameter is invalid.
See Also:
getValidationRule()

setValidationText

public void setValidationText(java.lang.String text)
Deprecated. Replaced by com.f1j.ss.ValidationFormat.setText(text)
Sets the text to display if a validation rule fails.
Parameters:
text - the text to display if the entered data does not meet the condition specified by the validation expression.
See Also:
getValidationText()

setVerticalInsideBorder

public void setVerticalInsideBorder(short verticalInside)
                             throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setStyle(EProperty, EStyle)
Sets the border style for the vertical inside border.
Parameters:
verticalInside - One of the following border styles:
                                                eBorderNone             = 0
                                                eBorderThin             = 1
                                                eBorderMedium           = 2
                                                eBorderDashed           = 3
                                                eBorderDotted           = 4
                                                eBorderThick            = 5
                                                eBorderDouble           = 6
                                                eBorderHair             = 7
                                                eBorderMediumDash       = 8
                                                eBorderDashDot          = 9
                                                eBorderMediumDashDot    = 10
                                                eBorderDashDotDot       = 11
                                                eBorderMediumDashDotDot = 12
                                                eBorderSlantedDashDot   = 13
Throws:
F1Exception - if a parameter is invalid.
See Also:
getVerticalInsideBorder()

setVerticalInsideBorderColor

public void setVerticalInsideBorderColor(int verticalInside)
                                  throws F1Exception
Deprecated. Replaced by com.f1j.ss.BorderFormat.setColor(EProperty, int)
Sets the color used to display the vertical inside border.
Parameters:
verticalInside - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. See the getPaletteRGB method for more information.
Throws:
F1Exception - if there is no active cell.
See Also:
getVerticalInsideBorderColor()

useAllFormats

public void useAllFormats()
Instructs the CellFormat object to use all of the format settings.

Normally the CellFormat object will not use format settings unless the format or a related format has been set with an explicit call to a set*() method. To copy a format from one place to another you must call useAllFormats() in between the calls to getCellFormat(...) and setCellFormat(...).

The groups are:

Specified by:
useAllFormats in interface Format

align

public AlignFormat align()
Returns the alignment format object for this object.
Returns:
The alignment format object for this object.
Since:
11.0
See Also:
AlignFormat

border

public BorderFormat border()
Returns the border format object for this object.
Returns:
The border format object for this object.
Since:
11.0
See Also:
BorderFormat

fill

public FillFormat fill()
Returns the fill format object for this object.
Returns:
The fill format object for this object.
Since:
11.0
See Also:
FillFormat

font

public FontFormat font()
Returns the font format object for this object.
Returns:
The font format object for this object.
Since:
11.0
See Also:
FontFormat

number

public NumberFormat number()
Returns the number format object for this object.
Returns:
The number format object for this object.
Since:
11.0
See Also:
NumberFormat

protection

public ProtectionFormat protection()
Returns the protection format object for this object.
Returns:
The protection format object for this object.
Since:
11.0
See Also:
ProtectionFormat

validation

public ValidationFormat validation()
Returns the validation format object for this object.
Returns:
The validation format object for this object.
Since:
11.0
See Also:
ValidationFormat