|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectFormatIterator
com.jxcell.CellFormat
The JXCELL CellFormat class, providing information about a cell format
Field Summary | |
static short |
eBorderDashed
Dashed line border |
static short |
eBorderDotted
Dotted line border |
static short |
eBorderDouble
Double border |
static short |
eBorderHair
Hairline border |
static short |
eBorderMedium
Medium solid line border |
static short |
eBorderNone
No border |
static short |
eBorderThick
Thick solid line border |
static short |
eBorderThin
Thin solid line border |
static short |
eBottomBorder
|
static short |
eBottomBorderColor
|
static short |
eFontBold
|
static short |
eFontColor
|
static short |
eFontItalic
|
static short |
eFontName
|
static short |
eFontOutline
|
static short |
eFontShadow
|
static short |
eFontSize
|
static short |
eFontStrikeout
|
static short |
eFontUnderline
|
static short |
eHidden
|
static short |
eHorizontalAlignment
|
static short |
eHorizontalAlignmentCenter
Centers data |
static short |
eHorizontalAlignmentCenterAcrossCells
Centers data across cells |
static short |
eHorizontalAlignmentFill
Fills cell with data |
static short |
eHorizontalAlignmentGeneral
Aligns according to data type |
static short |
eHorizontalAlignmentJustify
Justifies data |
static short |
eHorizontalAlignmentLeft
Aligns data left |
static short |
eHorizontalAlignmentRight
Aligns right |
static short |
eHorizontalInsideBorder
|
static short |
eHorizontalInsideBorderColor
|
static short |
eLeftBorder
|
static short |
eLeftBorderColor
|
static short |
eLocked
|
static short |
eNumberFormat
|
static short |
eNumberFormatType
|
static short |
eNumberFormatTypeCurrency
Currency format |
static short |
eNumberFormatTypeDate
Date format |
static short |
eNumberFormatTypeDateTime
DateTime format |
static short |
eNumberFormatTypeFraction
Fraction format |
static short |
eNumberFormatTypeGeneral
Displays numbers as integers and fractions as decimals. |
static short |
eNumberFormatTypeNumber
Number format |
static short |
eNumberFormatTypePercent
Percent format |
static short |
eNumberFormatTypeScientific
Scientific format |
static short |
eNumberFormatTypeString
String format |
static short |
ePattern
|
static short |
ePatternBG
|
static short |
ePatternFG
|
static short |
eRightBorder
|
static short |
eRightBorderColor
|
static short |
eTopBorder
|
static short |
eTopBorderColor
|
static short |
eValidationRule
|
static short |
eValidationText
|
static short |
eVerticalAlignment
|
static short |
eVerticalAlignmentBottom
Vertically aligns at the bottom |
static short |
eVerticalAlignmentCenter
Vertically aligns at the center |
static short |
eVerticalAlignmentTop
Vertically aligns at the top |
static short |
eVerticalInsideBorder
|
static short |
eVerticalInsideBorderColor
|
static short |
eWordWrap
|
static short |
kMaxPattern
|
Method Summary | |
short |
getBottomBorder()
Returns the border for the bottom edge of the cell |
java.awt.Color |
getBottomBorderColor()
Returns the color used to display the bottom edge of the cell |
java.awt.Color |
getFontColor()
Returns the color used to display the font |
java.lang.String |
getFontName()
Returns the name of the font |
int |
getFontSize()
Returns the size of the font |
double |
getFontSizeInPoints()
Returns the size of the font in points |
short |
getHorizontalAlignment()
Returns the type of horizontal alignment. |
short |
getHorizontalInsideBorder()
Returns the border type for the horizontal inside border |
java.awt.Color |
getHorizontalInsideBorderColor()
Returns the color used to display the horizontal inside border |
short |
getLeftBorder()
Returns the border for the left edge of the cell |
java.awt.Color |
getLeftBorderColor()
Returns the color used to display the left edge of the cell |
java.lang.String |
getNumberFormat()
Returns the number format associated with a cell. |
java.lang.String |
getNumberFormatLocal()
Returns the number format associated with a cell in the local language. |
short |
getNumberFormatType()
Returns the type of number format associated with a cell. |
short |
getPattern()
Returns the pattern type. |
java.awt.Color |
getPatternBG()
Returns the color used to display the pattern background |
java.awt.Color |
getPatternFG()
Returns the color used to display the pattern foreground |
short |
getRightBorder()
Returns the border for the right edge of the cell |
java.awt.Color |
getRightBorderColor()
Returns the color used to display the right edge of the cell |
short |
getTopBorder()
Returns the border for the top edge of the cell |
java.awt.Color |
getTopBorderColor()
Returns the color used to display the top edge of the cell |
java.lang.String |
getValidationRule()
Returns the validation rule associated with the active cell in US english. |
java.lang.String |
getValidationText()
Returns the text to be displayed in the cell if the validation rule fails. |
short |
getVerticalAlignment()
Returns the type of vertical alignment. |
short |
getVerticalInsideBorder()
Returns the color used to display the vertical inside border |
java.awt.Color |
getVerticalInsideBorderColor()
|
boolean |
isFontBold()
Returns whether the font is bold. |
boolean |
isFontItalic()
Returns whether the font is italic. |
boolean |
isFontOutline()
Returns whether the font is outline. |
boolean |
isFontShadow()
Returns whether the font is shadow. |
boolean |
isFontStrikeout()
Returns whether the font is strikeout |
boolean |
isFontUnderline()
Returns whether the font is underline |
boolean |
isHidden()
Returns whether formulas are hidden |
boolean |
isLocked()
Returns whether the active cell is locked |
boolean |
isUndefined(short property)
Returns whether a CellFormat attribute has been defined. |
boolean |
isWordWrap()
Determines whether word wrap is enabled. |
void |
setBottomBorder(short bottom)
Sets the style for the bottom border. |
void |
setBottomBorderColor(java.awt.Color color)
Sets the color used to display the bottom edge of the cell. |
void |
setFontBold(boolean bold)
Sets the bold attribute of the font. |
void |
setFontColor(java.awt.Color color)
Sets the color used to display the font. |
void |
setFontItalic(boolean italic)
Sets the italic attribute of the font. |
void |
setFontName(java.lang.String name)
Sets the font name. |
void |
setFontOutline(boolean outline)
Sets the outline attribute of the font. |
void |
setFontShadow(boolean shadow)
Sets the shadow attribute of the font. |
void |
setFontSize(int size)
Sets the font size. |
void |
setFontSizeInPoints(double size)
Sets the font size in points. |
void |
setFontStrikeout(boolean strikeout)
Sets the strikeout attribute of the font. |
void |
setFontUnderline(boolean underline)
Sets the underline attribute of the font. |
void |
setHidden(boolean hidden1)
Sets the display status of an element. |
void |
setHorizontalAlignment(short alignment)
Sets the horizontal alignment. |
void |
setHorizontalInsideBorder(short horizontalInside)
Sets the horizontal inside border. |
void |
setHorizontalInsideBorderColor(java.awt.Color horizontalInside)
Sets the color of the horizontal inside border. |
void |
setLeftBorder(short left)
Sets the style for the left border |
void |
setLeftBorderColor(java.awt.Color color)
Sets the color used to display the left edge of the cell. |
void |
setLocked(boolean flag)
Sets the locked cell flag |
void |
setNumberFormat(java.lang.String format)
Sets the number format string in U. |
void |
setNumberFormatLocal(java.lang.String format)
Sets the number format string in the user's local language Each format string can have as many as four sections: one for positive numbers, one for negative numbers, one for zeros, and one for text. |
void |
setPattern(short pattern1)
Sets the pattern type |
void |
setPatternBG(java.awt.Color color)
Sets the color used to display the pattern backgroun |
void |
setPatternFG(java.awt.Color color)
Sets the color used to display the pattern foreground |
void |
setRightBorder(short right)
Sets the style for the right border. |
void |
setRightBorderColor(java.awt.Color color)
Sets the color used to display the right edge of the cell. |
void |
setTopBorder(short top)
Sets the style for the bottom border |
void |
setTopBorderColor(java.awt.Color color)
Sets the color used to display the top edge of the cell. |
void |
setUndefined(short property,
boolean undefined)
Sets whether a cell format attribute has been defined |
void |
setValidationRule(View view1,
java.lang.String rule)
Sets the validation rule expression in U. |
void |
setValidationRule(View view1,
java.lang.String rule,
int row,
int col)
Sets the validation rule expression in U. |
void |
setValidationText(java.lang.String text)
Sets the text to be displayed if a validation rule fails. |
void |
setVerticalAlignment(short alignment)
Sets the type of vertical alignment |
void |
setVerticalInsideBorder(short verticalInside)
Sets the border type for the vertical inside border |
void |
setVerticalInsideBorderColor(java.awt.Color verticalInside)
Sets the color used to display the vertical inside border |
void |
setWordWrap(boolean wrap)
Sets the wordwrap attribute |
java.lang.String |
toString()
|
void |
useAllFormats()
Instructs the CellFormat object to use all of the format settings. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short eFontName
public static final short eFontSize
public static final short eFontBold
public static final short eFontItalic
public static final short eFontUnderline
public static final short eFontStrikeout
public static final short eFontColor
public static final short eFontOutline
public static final short eFontShadow
public static final short eHorizontalAlignment
public static final short eVerticalAlignment
public static final short eWordWrap
public static final short ePattern
public static final short ePatternFG
public static final short ePatternBG
public static final short eNumberFormat
public static final short eNumberFormatType
public static final short eValidationRule
public static final short eValidationText
public static final short eTopBorder
public static final short eLeftBorder
public static final short eBottomBorder
public static final short eRightBorder
public static final short eVerticalInsideBorder
public static final short eHorizontalInsideBorder
public static final short eTopBorderColor
public static final short eLeftBorderColor
public static final short eBottomBorderColor
public static final short eRightBorderColor
public static final short eVerticalInsideBorderColor
public static final short eHorizontalInsideBorderColor
public static final short eHidden
public static final short eLocked
public static final short eHorizontalAlignmentGeneral
public static final short eHorizontalAlignmentLeft
public static final short eHorizontalAlignmentCenter
public static final short eHorizontalAlignmentRight
public static final short eHorizontalAlignmentFill
public static final short eHorizontalAlignmentJustify
public static final short eHorizontalAlignmentCenterAcrossCells
public static final short eVerticalAlignmentTop
public static final short eVerticalAlignmentCenter
public static final short eVerticalAlignmentBottom
public static final short kMaxPattern
public static final short eNumberFormatTypeGeneral
public static final short eNumberFormatTypeNumber
public static final short eNumberFormatTypeCurrency
public static final short eNumberFormatTypeDate
public static final short eNumberFormatTypeDateTime
public static final short eNumberFormatTypePercent
public static final short eNumberFormatTypeFraction
public static final short eNumberFormatTypeScientific
public static final short eNumberFormatTypeString
public static final short eBorderNone
public static final short eBorderThin
public static final short eBorderMedium
public static final short eBorderDashed
public static final short eBorderDotted
public static final short eBorderThick
public static final short eBorderDouble
public static final short eBorderHair
Method Detail |
public short getBottomBorder()
public java.awt.Color getBottomBorderColor()
public java.awt.Color getFontColor()
public java.lang.String getFontName()
public int getFontSize()
public double getFontSizeInPoints()
public short getHorizontalAlignment()
public short getHorizontalInsideBorder()
public java.awt.Color getHorizontalInsideBorderColor()
public short getLeftBorder()
public java.awt.Color getLeftBorderColor()
public java.lang.String getNumberFormat()
public java.lang.String getNumberFormatLocal()
public short getNumberFormatType()
public short getPattern()
public java.awt.Color getPatternBG()
public java.awt.Color getPatternFG()
public short getRightBorder()
public java.awt.Color getRightBorderColor()
public short getTopBorder()
public java.awt.Color getTopBorderColor()
public java.lang.String getValidationRule()
public java.lang.String getValidationText()
public short getVerticalAlignment()
public short getVerticalInsideBorder()
public java.awt.Color getVerticalInsideBorderColor()
public boolean isFontBold()
public boolean isFontItalic()
public boolean isFontOutline()
public boolean isFontShadow()
public boolean isFontStrikeout()
public boolean isFontUnderline()
public boolean isHidden()
public boolean isLocked()
public boolean isUndefined(short property) throws CellException
property
- - One of the following attributes: eFontName, eFontSize, eFontBold, eFontItalic, eFontUnderline, eFontStrikeout, eFontColor, eFontOutline, eFontShadow, eHorizontalAlignment, eVerticalAlignment, eWordWrap, eOrientation, ePattern, ePatternFG, ePatternBG, eNumberFormat, eNumberFormatType eValidationRule, eValidationText, eTopBorder, eLeftBorder, eBottomBorder, eRightBorder, eVerticalInsideBorder, eHorizontalInsideBorder, eTopBorderColor, eLeftBorderColor, eBottomBorderColor, eRightBorderColor, eVerticalInsideBorder, eHorizontalInsideBorder, eHidden, eLocked,
CellException
- invalid argumentpublic boolean isWordWrap()
public void setBottomBorder(short bottom) throws CellException
bottom
- - one of the following border types: eBorderNone = 0 eBorderThin = 1 eBorderMedium = 2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick = 5 eBorderDouble = 6 eBorderHair = 7
CellException
- invalid argumentpublic void setBottomBorderColor(java.awt.Color color) throws CellException
color
- - a java.awt.color that describes the border color.
CellException
- If there is no active cell.public void setFontBold(boolean bold)
bold
- - boolean True = bold, False = not bold.public void setFontColor(java.awt.Color color)
color
- - a java.awt.color that describes the border color.public void setFontItalic(boolean italic)
italic
- - boolean True = italic, False = not italic.public void setFontName(java.lang.String name)
name
- - a string that describes the font name.public void setFontSize(int size) throws CellException
size
- - a number that describes the font size
CellException
- if size is less than zero.public void setFontOutline(boolean outline)
outline
- - boolean True = outline, False = not outline.public void setFontShadow(boolean shadow)
shadow
- - boolean True = shadow, False = not shadow.public void setFontSizeInPoints(double size) throws CellException
size
- - a number that describes the font size.
CellException
- if size is less than zeropublic void setFontStrikeout(boolean strikeout)
strikeout
- - True = strikeout, False = not strikeout.public void setFontUnderline(boolean underline)
underline
- - boolean True = underline, False = not underline.public void setHidden(boolean hidden1)
hidden1
- - boolean True = hidden, False = visible.public void setHorizontalAlignment(short alignment) throws CellException
alignment
- - an integer describing the type of horizontal alignment, one of the following: eHorizontalAlignmentGeneral = 0 eHorizontalAlignmentLeft = 1 eHorizontalAlignmentCenter = 2 eHorizontalAlignmentRight = 3 eHorizontalAlignmentFill = 4 eHorizontalAlignmentJustify = 5 eHorizontalAlignmentCenterAcrossCells = 6
CellException
- if a parameter is invalidpublic void setHorizontalInsideBorder(short horizontalInside) throws CellException
horizontalInside
- - short integer representing one of the following border types: eBorderNone = 0 eBorderThin = 1 eBorderMedium = 2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick = 5 eBorderDouble = 6 eBorderHair = 7
CellException
public void setHorizontalInsideBorderColor(java.awt.Color horizontalInside)
horizontalInside
- - a java.awt.Color representing the colorpublic void setLeftBorder(short left) throws CellException
left
- - one of the following border types: eBorderNone = 0 eBorderThin = 1 eBorderMedium = 2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick = 5 eBorderDouble = 6 eBorderHair = 7
CellException
- If there is no active cell.public void setLeftBorderColor(java.awt.Color color)
color
- - a java.awt.color that describes the border color. see CellFormat#getLeftBorderColor()public void setLocked(boolean flag)
flag
- - set to True to lock the cell, False to unlock the cellpublic void setNumberFormat(java.lang.String format) throws CellException
format
- - the string defining the number format
CellException
public void setNumberFormatLocal(java.lang.String format) throws CellException
format
- - the string defining the number format
CellException
public void setPattern(short pattern1) throws CellException
pattern1
- - a number between 0 and 18. 0 means no pattern. At this time, 1-18 mean solid because the JDK does not support patterns. Pattern support will be available in JXCell when it is available in the JDK.
CellException
- if a parameter is invalidpublic void setPatternBG(java.awt.Color color)
color
- - a java.awt.Colorpublic void setPatternFG(java.awt.Color color)
color
- - a java.awt.Colorpublic void setRightBorder(short right) throws CellException
right
- - one of the following border types: eBorderNone = 0 eBorderThin = 1 eBorderMedium =2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick =5 eBorderDouble = 6 eBorderHair = 7
CellException
- If there is no active cell.public void setRightBorderColor(java.awt.Color color) throws CellException
color
- - a java.awt.color that describes the border color.
CellException
- If there is no active cell.public void setTopBorder(short top) throws CellException
top
- - one of the following border types: eBorderNone = 0 eBorderThin = 1 eBorderMedium =2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick =5 eBorderDouble = 6 eBorderHair = 7
CellException
- If there is no active cell.public void setTopBorderColor(java.awt.Color color) throws CellException
color
- - a java.awt.color that describes the border color.
CellException
- If there is no active cell.public void setUndefined(short property, boolean undefined) throws CellException
property
- - One of the following attributes: eFontName, eFontSize, eFontBold, eFontItalic, eFontUnderline, eFontStrikeout, eFontColor, eFontOutline, eFontShadow, eHorizontalAlignment, eVerticalAlignment, eWordWrap, eOrientation, ePattern, ePatternFG, ePatternBG, eNumberFormat, eNumberFormatType eValidationRule, eValidationText, eTopBorder, eLeftBorder, eBottomBorder, eRightBorder, eVerticalInsideBorder, eHorizontalInsideBorder, eTopBorderColor, eLeftBorderColor, eBottomBorderColor, eRightBorderColor, eVerticalInsideBorder, eHorizontalInsideBorder, eHidden, eLocked,undefined
- - True if the attribute is not defined, False if the attribute is not defined
CellException
- If there is no active cell.public void setValidationRule(View view1, java.lang.String rule) throws CellException
view1
- - the Formual One viewrule
- - the validation rule expression, such as "(A1 > 100)".
CellException
- if a parameter is invalidpublic void setValidationRule(View view1, java.lang.String rule, int row, int col) throws CellException
view1
- - the Formual One viewrule
- - 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 referencecol
- - the coordinate of the column used as the starting point for the calculated relative reference
CellException
- if a parameter is invalidpublic void setValidationText(java.lang.String text)
text
- - the text to be displayed if the entered data does not meet the condition specified by the validation expressionpublic void setVerticalAlignment(short alignment) throws CellException
alignment
- - One of the following alignment types eVerticalAlignmentTop = 0 eVerticalAlignmentCenter = 1 eVerticalAlignmentBottom = 2
CellException
- if a parameter is invalidpublic void setVerticalInsideBorder(short verticalInside) throws CellException
verticalInside
- - One of the following border types eBorderNone = 0 eBorderThin = 1 eBorderMedium =2 eBorderDashed = 3 eBorderDotted = 4 eBorderThick =5 eBorderDouble = 6 eBorderHair = 7
CellException
- if a parameter is invalidpublic void setVerticalInsideBorderColor(java.awt.Color verticalInside) throws CellException
verticalInside
- - a java.awt.color that describes the border color
CellException
- If there is no active cell.public void setWordWrap(boolean wrap)
wrap
- - boolean indicating whether wordwrap is enabledpublic void useAllFormats()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |