com.spire.xls
Class CellStyleObject

java.lang.Object
  com.spire.xls.CellStyleObject

All Implemented Interfaces:

IExtendedFormat, IOptimizedUpdate, IStyle

Direct Known Subclasses:

CellStyle

public class CellStyleObject
extends java.lang.Object
implements IStyle

Constructor Summary

CellStyleObject(IStyle style)
Creates object that will contain all styles that are used by range.

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.
IBorders	getBorders() Returns a borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).
boolean	getBuiltIn() True if the style is a built-in style.
ExcelPatternType	getFillPattern() Gets fill pattern type.
IFont	getFont() Returns a font object that represents the font of the specified object.
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, known color, line style, and weight border properties
boolean	getIncludeFont() True if the style includes the background, bold, color, known color, font style, italic, name, outline font, 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, known color, invert if negative, pattern, pattern color, and pattern known color interior properties.
boolean	getIncludeProtection() True if the style includes the formula hidden and Locked protection properties.
int	getIndentLevel() Returns the indent level for the style.
IInterior	getInterior() Returns interior object for this extended format.
boolean	getJustifyLast() Represents justify text alignment
ExcelColors	getKnownColor() Gets the cell shading excel color.
boolean	getLocked() True if the object is locked; False if the object can be modified when the sheet is protected.
java.lang.String	getName() Returns the name of the object.
java.lang.String	getNumberFormat() Returns the format code for the object.
int	getNumberFormatIndex() Gets format index.
java.lang.String	getNumberFormatLocal() Returns the format code for the object as a string in the language of the user.
INumberFormat	getNumberFormatSettings() Returns object that describes number format.
java.lang.Object	getParent()
java.awt.Color	getPatternColor() Returns the color of the interior pattern.
ExcelColors	getPatternKnownColor() Returns the excel color of the interior.
ReadingOrderType	getReadingOrder() Returns the reading order for the specified object.
int	getRotation() The text orientation.
boolean	getShrinkToFit() True if text automatically shrinks to fit in the available column width.
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	isFirstSymbolApostrophe(boolean isFirstSymbolApostrophe) If true then first symbol in cell is apostrophe.
boolean	isInitialized() Indicates whether style is initialized (differs from Normal style).
boolean	isModified()
void	setColor(java.awt.Color color) Sets the cell shading color.
void	setFillPattern(ExcelPatternType fillPattern) Sets fill pattern type.
void	setFormulaHidden(boolean formulaHidden) Sets if the formula will be hidden when the worksheet is protected.
void	setHorizontalAlignment(HorizontalAlignType horizontalAlignment) Sets the horizontal alignment for the specified object.
void	setIncludeAlignment(boolean includeAlignment) Sets if the style includes the add indent, horizontal alignment, vertical alignment, wrap text, and orientation properties.
void	setIncludeBorder(boolean includeBorder) Sets if the style includes the color, known color, line style, and weight border properties.
void	setIncludeFont(boolean includeFont) Sets if the style includes the background, bold, color, known color, font style, italic, name, outline font, shadow, size, strikethrough, subscript, superscript, and underline font properties.
void	setIncludeNumberFormat(boolean includeNumberFormat) True if the style includes the number format property.
void	setIncludePatterns(boolean includePatterns) True if the style includes the color, known color, invert if negative, pattern, pattern color, and pattern known color interior properties.
void	setIncludeProtection(boolean includeProtection) Sets if the style includes the formula hidden and Locked protection properties.
void	setIndentLevel(int indentLevel) Sets the indent level for the style.
void	setJustifyLast(boolean justifyLast) Sets justify text alignment
void	setKnownColor(ExcelColors knownColor) Sets the cell shading excel color.
void	setLocked(boolean locked) Sets true if the object is locked; False if the object can be modified when the sheet is protected.
void	setNumberFormat(java.lang.String numberFormat) Sets the format code for the object.
void	setNumberFormatIndex(int numberFormatIndex) Sets format index.
void	setNumberFormatLocal(java.lang.String numberFormatLocal) Sets the format code for the object as a string in the language of the user.
void	setPatternColor(java.awt.Color patternColor) Sets the color of the interior pattern.
void	setPatternKnownColor(ExcelColors patternKnownColor) Sets the excel color of the interior.
void	setReadingOrder(ReadingOrderType readingOrder) Sets the reading order for the specified object.
void	setRotation(int rotation) The text orientation.
void	setShrinkToFit(boolean shrinkToFit) True if text automatically shrinks to fit in the available column width.
void	setVerticalAlignment(VerticalAlignType verticalAlignment) Sets the vertical alignment of the specified object.
void	setWrapText(boolean wrapText) True if Microsoft Excel wraps the text in the object.

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

getColor

Constructor Detail

CellStyleObject

public CellStyleObject(IStyle style)

Creates object that will contain all styles that are used by range.

Parameters:

style - Range from which styles must be taken.

Method Detail

getJustifyLast

public boolean getJustifyLast()

Represents justify text alignment

Specified by:

getJustifyLast in interface IExtendedFormat

setJustifyLast

public void setJustifyLast(boolean justifyLast)

Sets justify text alignment

getNumberFormatLocal

public java.lang.String getNumberFormatLocal()

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

Specified by:

getNumberFormatLocal in interface IExtendedFormat

setNumberFormatLocal

public void setNumberFormatLocal(java.lang.String numberFormatLocal)

Sets the format code for the object as a string in the language of the user.

Specified by:

setNumberFormatLocal in interface IExtendedFormat

getInterior

public IInterior getInterior()

Description copied from interface: IStyle

Returns interior object for this extended format.

Specified by:

getInterior in interface IStyle

isModified

public boolean isModified()

Specified by:

isModified in interface IExtendedFormat

getBorders

public IBorders getBorders()

Returns a borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).

Specified by:

getBorders in interface IExtendedFormat

getBuiltIn

public boolean getBuiltIn()

True if the style is a built-in style.

Specified by:

getBuiltIn in interface IStyle

getFillPattern

public ExcelPatternType getFillPattern()

Gets fill pattern type.

Specified by:

getFillPattern in interface IExtendedFormat

setFillPattern

public void setFillPattern(ExcelPatternType fillPattern)

Sets fill pattern type.

Specified by:

setFillPattern in interface IExtendedFormat

getFont

public IFont getFont()

Returns a font object that represents the font of the specified object. Read-only.

Specified by:

getFont 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

setFormulaHidden

public void setFormulaHidden(boolean formulaHidden)

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

Specified by:

setFormulaHidden in interface IExtendedFormat

getHorizontalAlignment

public HorizontalAlignType getHorizontalAlignment()

Returns the horizontal alignment for the specified object.

Specified by:

getHorizontalAlignment in interface IExtendedFormat

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignType horizontalAlignment)

Sets the horizontal alignment for the specified object.

Specified by:

setHorizontalAlignment 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

setIncludeAlignment

public void setIncludeAlignment(boolean includeAlignment)

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

Specified by:

setIncludeAlignment in interface IExtendedFormat

getIncludeBorder

public boolean getIncludeBorder()

True if the style includes the color, known color, line style, and weight border properties

Specified by:

getIncludeBorder in interface IExtendedFormat

setIncludeBorder

public void setIncludeBorder(boolean includeBorder)

Sets if the style includes the color, known color, line style, and weight border properties.

getIncludeFont

public boolean getIncludeFont()

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

Specified by:

getIncludeFont in interface IExtendedFormat

setIncludeFont

public void setIncludeFont(boolean includeFont)

Sets if the style includes the background, bold, color, known color, font style, italic, name, outline font, shadow, size, strikethrough, subscript, superscript, and underline font properties.

Specified by:

setIncludeFont in interface IExtendedFormat

getIncludeNumberFormat

public boolean getIncludeNumberFormat()

True if the style includes the NumberFormat property.

Specified by:

getIncludeNumberFormat in interface IExtendedFormat

setIncludeNumberFormat

public void setIncludeNumberFormat(boolean includeNumberFormat)

True if the style includes the number format property.

Specified by:

setIncludeNumberFormat in interface IExtendedFormat

getIncludePatterns

public boolean getIncludePatterns()

True if the style includes the color, known color, invert if negative, pattern, pattern color, and pattern known color interior properties.

Specified by:

getIncludePatterns in interface IExtendedFormat

setIncludePatterns

public void setIncludePatterns(boolean includePatterns)

True if the style includes the color, known color, invert if negative, pattern, pattern color, and pattern known color interior properties.

Specified by:

setIncludePatterns in interface IExtendedFormat

getIncludeProtection

public boolean getIncludeProtection()

True if the style includes the formula hidden and Locked protection properties.

Specified by:

getIncludeProtection in interface IExtendedFormat

setIncludeProtection

public void setIncludeProtection(boolean includeProtection)

Sets if the style includes the formula hidden and Locked protection properties.

Specified by:

setIncludeProtection in interface IExtendedFormat

getIndentLevel

public int getIndentLevel()

Returns the indent level for the style.

Specified by:

getIndentLevel in interface IExtendedFormat

setIndentLevel

public void setIndentLevel(int indentLevel)

Sets the indent level for the style.

Specified by:

setIndentLevel in interface IExtendedFormat

isInitialized

public boolean isInitialized()

Indicates whether style is initialized (differs from Normal style). Read-only.

Specified by:

isInitialized in interface IStyle

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

setLocked

public void setLocked(boolean locked)

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

Specified by:

setLocked in interface IExtendedFormat

getName

public java.lang.String getName()

Returns the name of the object. Read-only string.

Specified by:

getName in interface IStyle

getNumberFormat

public java.lang.String getNumberFormat()

Returns the format code for the object.

Specified by:

getNumberFormat in interface IExtendedFormat

setNumberFormat

public void setNumberFormat(java.lang.String numberFormat)

Sets the format code for the object.

Specified by:

setNumberFormat in interface IExtendedFormat

getNumberFormatIndex

public int getNumberFormatIndex()

Gets format index.

Specified by:

getNumberFormatIndex in interface IExtendedFormat

setNumberFormatIndex

public void setNumberFormatIndex(int numberFormatIndex)

Sets format index.

Specified by:

setNumberFormatIndex in interface IExtendedFormat

getNumberFormatSettings

public INumberFormat getNumberFormatSettings()

Returns object that describes number format. Read-only.

Specified by:

getNumberFormatSettings 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

setRotation

public void setRotation(int rotation)

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

Specified by:

setRotation 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

setShrinkToFit

public void setShrinkToFit(boolean shrinkToFit)

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

Specified by:

setShrinkToFit in interface IExtendedFormat

getVerticalAlignment

public VerticalAlignType getVerticalAlignment()

Returns the vertical alignment of the specified object.

Specified by:

getVerticalAlignment in interface IExtendedFormat

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignType verticalAlignment)

Sets the vertical alignment of the specified object.

Specified by:

setVerticalAlignment in interface IExtendedFormat

getWrapText

public boolean getWrapText()

True if microsoft excel wraps the text in the object.

Specified by:

getWrapText in interface IExtendedFormat

setWrapText

public void setWrapText(boolean wrapText)

True if Microsoft Excel wraps the text in the object.

Specified by:

setWrapText in interface IExtendedFormat

getReadingOrder

public ReadingOrderType getReadingOrder()

Returns the reading order for the specified object.

Specified by:

getReadingOrder in interface IExtendedFormat

setReadingOrder

public void setReadingOrder(ReadingOrderType readingOrder)

Sets the reading order for the specified object.

Specified by:

setReadingOrder in interface IExtendedFormat

isFirstSymbolApostrophe

public boolean isFirstSymbolApostrophe()

If true then first symbol in cell is apostrophe.

Specified by:

isFirstSymbolApostrophe in interface IExtendedFormat

isFirstSymbolApostrophe

public void isFirstSymbolApostrophe(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

setPatternKnownColor

public void setPatternKnownColor(ExcelColors patternKnownColor)

Sets the excel color of the interior.

Specified by:

setPatternKnownColor in interface IExtendedFormat

getPatternColor

public java.awt.Color getPatternColor()

Returns the color of the interior pattern.

Specified by:

getPatternColor in interface IExtendedFormat

setPatternColor

public void setPatternColor(java.awt.Color patternColor)

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

setKnownColor

public void setKnownColor(ExcelColors knownColor)

Sets the cell shading excel color.

Specified by:

setKnownColor in interface IExtendedFormat

setColor

public void setColor(java.awt.Color color)

Sets the cell shading color.

Specified by:

setColor in interface IExtendedFormat

getParent

public java.lang.Object getParent()

beginUpdate

public void beginUpdate()

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

Specified by:

beginUpdate in interface IOptimizedUpdate

endUpdate

public void endUpdate()

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

Specified by:

endUpdate in interface IOptimizedUpdate