com.spire.xls.core.spreadsheet
Class AddtionalFormatWrapper

java.lang.Object
  com.spire.xls.core.spreadsheet.CommonWrapper
      com.spire.xls.core.spreadsheet.AddtionalFormatWrapper

All Implemented Interfaces:

IExtendedFormat, IOptimizedUpdate, IStyle

Direct Known Subclasses:

CellBaseStyle

public class AddtionalFormatWrapper
extends CommonWrapper
implements IStyle

Constructor Summary

AddtionalFormatWrapper(XlsWorkbook book)

Method Summary

void	beginUpdate() This method should be called before several updates to the object will take place.
void	endUpdate() This method should be called after several updates to the object took place.
java.awt.Color	getBackgroundColor() Gets fill background color.
ExcelColors	getBackgroundKnownColor() Gets index of fill background excel color.
OColor	getBottomBorderColor() Gets bottom border color.
LineStyleType	getBottomBorderLineStyle() Gets line style of the bottom border.
java.awt.Color	getColor() Gets the cell shading color.
OColor	getDiagonalBorderColor() Gets diagonal border color.
LineStyleType	getDiagonalDownBorderLineStyle() Gets line style of the diagonal border.
boolean	getDiagonalDownVisible() Indicates whether diagonal down line is visible.
LineStyleType	getDiagonalUpBorderLineStyle() Gets line style of the diagonal border.
boolean	getDiagonalUpVisible() Indicates whether diagonal up line is visible.
int	getExtendedFormatIndex() Gets extended format index.
ExcelPatternType	getFillPattern() Gets fill pattern type.
com.spire.ms.System.Drawing.Color	getForegroundColor() Gets fill foreground color.
ExcelColors	getForegroundKnownColor() Gets fill foreground excel color.
boolean	getFormulaHidden() True if the formula will be hidden when the worksheet is protected.
HorizontalAlignType	getHorizontalAlignment() Returns the horizontal alignment for the specified object.
boolean	getIncludeAlignment() True if the style includes the add indent, horizontal alignment, vertical alignment, wrap text, and orientation properties.
boolean	getIncludeBorder() True if the style includes the color, knowncolor, linestyle, and weight border properties
boolean	getIncludeFont() True if the style includes the background, bold, color, knowncolor, fontstyle, italic, name, outlinefont, shadow, size, strikethrough, subscript, superscript, and underline font properties.
boolean	getIncludeNumberFormat() True if the style includes the numberformat property.
boolean	getIncludePatterns() True if the style includes the color, knowncolor, invertifnegative, pattern, patterncolor, and patternknowncolor interior properties.
boolean	getIncludeProtection() True if the style includes the FormulaHidden and Locked protection properties.
int	getIndentLevel() Returns or sets the indent level for the style.
boolean	getJustifyLast() Represents justify text alignment
ExcelColors	getKnownColor() Gets the cell shading excel color.
OColor	getLeftBorderColor() Gets left border color.
LineStyleType	getLeftBorderLineStyle() Gets line style of the left border.
boolean	getLocked() True if the object is locked; False if the object can be modified when the sheet is protected.
java.lang.String	getNumberFormat() Returns or sets the format code for the object.
int	getNumberFormatIndex() Gets format index.
java.lang.String	getNumberFormatLocal() Returns or sets the format code for the object as a string in the language of the user.
INumberFormat	getNumberFormatSettings() Returns object that describes number format.
java.awt.Color	getPatternColor() Returns the color of the interior pattern.
ExcelColors	getPatternKnownColor() Returns the excel color of the interior.
ReadingOrderType	getReadingOrder() Returns or sets the reading order for the specified object.
OColor	getRightBorderColor() Gets right border color.
LineStyleType	getRightBorderLineStyle() Gets line style of the right border.
int	getRotation() The text orientation.
boolean	getShrinkToFit() True if text automatically shrinks to fit in the available column width.
OColor	getTopBorderColor() Gets top border color.
LineStyleType	getTopBorderLineStyle() Gets line style of the top border.
VerticalAlignType	getVerticalAlignment() Returns the vertical alignment of the specified object.
boolean	getWrapText() True if microsoft excel wraps the text in the object.
boolean	isFirstSymbolApostrophe() If true then first symbol in cell is apostrophe.
void	setBackgroundColor(java.awt.Color color) Sets fill background color.
void	setColor(java.awt.Color color) sets the cell shading color.
void	setPatternColor(java.awt.Color color) Sets the color of the interior pattern.

Methods inherited from interface com.spire.xls.core.IStyle

getBuiltIn, getInterior, getName, isInitialized

Methods inherited from interface com.spire.xls.core.IExtendedFormat

getBorders, getFont, isFirstSymbolApostrophe, isModified, setFillPattern, setFormulaHidden, setHorizontalAlignment, setIncludeAlignment, setIncludeFont, setIncludeNumberFormat, setIncludePatterns, setIncludeProtection, setIndentLevel, setKnownColor, setLocked, setNumberFormat, setNumberFormatIndex, setNumberFormatLocal, setPatternKnownColor, setReadingOrder, setRotation, setShrinkToFit, setVerticalAlignment, setWrapText

Constructor Detail

AddtionalFormatWrapper

public AddtionalFormatWrapper(XlsWorkbook book)

Method Detail

getBottomBorderColor

public OColor getBottomBorderColor()

Gets bottom border color.

getTopBorderColor

public OColor getTopBorderColor()

Gets top border color.

getLeftBorderColor

public OColor getLeftBorderColor()

Gets left border color.

getRightBorderColor

public OColor getRightBorderColor()

Gets right border color.

getDiagonalBorderColor

public OColor getDiagonalBorderColor()

Gets diagonal border color.

getLeftBorderLineStyle

public LineStyleType getLeftBorderLineStyle()

Gets line style of the left border.

getRightBorderLineStyle

public LineStyleType getRightBorderLineStyle()

Gets line style of the right border.

getTopBorderLineStyle

public LineStyleType getTopBorderLineStyle()

Gets line style of the top border.

getBottomBorderLineStyle

public LineStyleType getBottomBorderLineStyle()

Gets line style of the bottom border.

getDiagonalUpBorderLineStyle

public LineStyleType getDiagonalUpBorderLineStyle()

Gets line style of the diagonal border.

getDiagonalDownBorderLineStyle

public LineStyleType getDiagonalDownBorderLineStyle()

Gets line style of the diagonal border.

getDiagonalUpVisible

public boolean getDiagonalUpVisible()

Indicates whether diagonal up line is visible.

getDiagonalDownVisible

public boolean getDiagonalDownVisible()

Indicates whether diagonal down line is visible.

getFillPattern

public ExcelPatternType getFillPattern()

Gets fill pattern type.

Specified by:

getFillPattern in interface IExtendedFormat

getExtendedFormatIndex

public int getExtendedFormatIndex()

Gets extended format index.

getBackgroundKnownColor

public ExcelColors getBackgroundKnownColor()

Gets index of fill background excel color.

getBackgroundColor

public java.awt.Color getBackgroundColor()

Gets fill background color.

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets fill background color.

getForegroundKnownColor

public ExcelColors getForegroundKnownColor()

Gets fill foreground excel color.

getForegroundColor

public com.spire.ms.System.Drawing.Color getForegroundColor()

Gets fill foreground color.

getNumberFormatIndex

public int getNumberFormatIndex()

Gets format index.

Specified by:

getNumberFormatIndex in interface IExtendedFormat

getHorizontalAlignment

public HorizontalAlignType getHorizontalAlignment()

Returns the horizontal alignment for the specified object.

Specified by:

getHorizontalAlignment in interface IExtendedFormat

getIncludeAlignment

public boolean getIncludeAlignment()

True if the style includes the add indent, horizontal alignment, vertical alignment, wrap text, and orientation properties.

Specified by:

getIncludeAlignment in interface IExtendedFormat

getIncludeBorder

public boolean getIncludeBorder()

True if the style includes the color, knowncolor, linestyle, and weight border properties

Specified by:

getIncludeBorder in interface IExtendedFormat

getIncludeFont

public boolean getIncludeFont()

True if the style includes the background, bold, color, knowncolor, fontstyle, italic, name, outlinefont, shadow, size, strikethrough, subscript, superscript, and underline font properties.

Specified by:

getIncludeFont in interface IExtendedFormat

getIncludeNumberFormat

public boolean getIncludeNumberFormat()

True if the style includes the numberformat property.

Specified by:

getIncludeNumberFormat in interface IExtendedFormat

getIncludePatterns

public boolean getIncludePatterns()

True if the style includes the color, knowncolor, invertifnegative, pattern, patterncolor, and patternknowncolor interior properties.

Specified by:

getIncludePatterns in interface IExtendedFormat

getIncludeProtection

public boolean getIncludeProtection()

True if the style includes the FormulaHidden and Locked protection properties.

Specified by:

getIncludeProtection in interface IExtendedFormat

getIndentLevel

public int getIndentLevel()

Returns or sets the indent level for the style.

Specified by:

getIndentLevel in interface IExtendedFormat

getFormulaHidden

public boolean getFormulaHidden()

True if the formula will be hidden when the worksheet is protected.

Specified by:

getFormulaHidden in interface IExtendedFormat

getLocked

public boolean getLocked()

True if the object is locked; False if the object can be modified when the sheet is protected.

Specified by:

getLocked in interface IExtendedFormat

getJustifyLast

public boolean getJustifyLast()

Represents justify text alignment

Specified by:

getJustifyLast in interface IExtendedFormat

getNumberFormat

public java.lang.String getNumberFormat()

Returns or sets the format code for the object.

Specified by:

getNumberFormat in interface IExtendedFormat

getNumberFormatLocal

public java.lang.String getNumberFormatLocal()

Returns or sets the format code for the object as a string in the language of the user.

Specified by:

getNumberFormatLocal in interface IExtendedFormat

getNumberFormatSettings

public INumberFormat getNumberFormatSettings()

Returns object that describes number format. Read-only.

Specified by:

getNumberFormatSettings in interface IExtendedFormat

getReadingOrder

public ReadingOrderType getReadingOrder()

Returns or sets the reading order for the specified object.

Specified by:

getReadingOrder in interface IExtendedFormat

getRotation

public int getRotation()

The text orientation. Can be an integer value from 1 to 180 degrees

Specified by:

getRotation in interface IExtendedFormat

getShrinkToFit

public boolean getShrinkToFit()

True if text automatically shrinks to fit in the available column width.

Specified by:

getShrinkToFit in interface IExtendedFormat

getVerticalAlignment

public VerticalAlignType getVerticalAlignment()

Returns the vertical alignment of the specified object.

Specified by:

getVerticalAlignment in interface IExtendedFormat

getWrapText

public boolean getWrapText()

True if microsoft excel wraps the text in the object.

Specified by:

getWrapText in interface IExtendedFormat

isFirstSymbolApostrophe

public boolean isFirstSymbolApostrophe()

If true then first symbol in cell is apostrophe.

Specified by:

isFirstSymbolApostrophe in interface IExtendedFormat

getPatternKnownColor

public ExcelColors getPatternKnownColor()

Returns the excel color of the interior.

Specified by:

getPatternKnownColor in interface IExtendedFormat

getPatternColor

public java.awt.Color getPatternColor()

Returns the color of the interior pattern.

Specified by:

getPatternColor in interface IExtendedFormat

Returns:

pattern color

setPatternColor

public void setPatternColor(java.awt.Color color)

Sets the color of the interior pattern.

Specified by:

setPatternColor in interface IExtendedFormat

getKnownColor

public ExcelColors getKnownColor()

Gets the cell shading excel color.

Specified by:

getKnownColor in interface IExtendedFormat

Returns:

shading excel color

getColor

public java.awt.Color getColor()

Gets the cell shading color.

Specified by:

getColor in interface IExtendedFormat

Returns:

shading Color

setColor

public void setColor(java.awt.Color color)

sets the cell shading color.

Specified by:

setColor in interface IExtendedFormat

beginUpdate

public void beginUpdate()

This method should be called before several updates to the object will take place.

Specified by:

beginUpdate in interface IOptimizedUpdate

Overrides:

beginUpdate in class CommonWrapper

endUpdate

public void endUpdate()

This method should be called after several updates to the object took place.

Specified by:

endUpdate in interface IOptimizedUpdate

Overrides:

endUpdate in class CommonWrapper