Class CellProperties
java.lang.Object
com.independentsoft.office.odf.styles.CellProperties
Represents formatting properties for cells.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Creates a new object that is a deep copy of the current instance.Gets the background color for cell.Gets the background image.Gets the border for cell.Gets the widths of borders.Gets the bottom border for cell.Gets the bottom widths of borders.Gets the bottom margin.Gets the bottom padding.Specifies how a cell is protected.intGets the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself.Gets the direction of characters.Gets the left border for cell.Gets the left widths of borders.Gets the left margin.Gets the left padding.Gets the margin.Gets the padding.Gets the right border for cell.Gets the right widths of borders.Gets the right margin.Gets the right padding.Specifies how the edge of the text in a cell is aligned after a rotation.intGet the rotation angle of content.Gets the shadow of the cell.Gets the source of a text-align attribute.Gets the top border for cell.Gets the top widths of borders.Gets the top margin.Gets the top padding.Specifies how to vertically align a line that is less than 100% of its height within the columned area.Gets the vertical glyph orientation.Gets the writing mode.booleanIf wrapping is disabled, it is implementation defined whether the clipped text is visible or hidden.booleanSpecifies if content is printed.booleanSpecifies whether text content of a cell is displayed as many times as there is space left in the cell's writing direction.booleanSpecifies whether content is reduced in size to fit within a cell or drawing object.voidsetBackgroundColor(String backgroundColor)Sets the background color for cell.voidsetBackgroundImage(BackgroundImage backgroundImage)Sets the background image.voidSets the border for cell.voidsetBorderLineWidth(BorderLineWidth borderLineWidth)Sets the widths of borders.voidsetBottomBorder(Border bottomBorder)Sets the bottom border for cell.voidsetBottomBorderLineWidth(BorderLineWidth bottomBorderLineWidth)Sets the bottom widths of borders.voidsetBottomMargin(Size bottomMargin)Sets the bottom margin.voidsetBottomPadding(Size bottomPadding)Sets the bottom padding.voidsetCellProtect(CellProtectType cellProtect)Specifies how a cell is protected.voidsetDecimalPlaces(int decimalPlaces)Sets the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself.voidsetDirection(Direction direction)Sets the direction of characters.voidsetEnableWrap(boolean enableWrap)If wrapping is disabled, it is implementation defined whether the clipped text is visible or hidden.voidsetLeftBorder(Border leftBorder)Sets the left border for cell.voidsetLeftBorderLineWidth(BorderLineWidth leftBorderLineWidth)Sets the left widths of borders.voidsetLeftMargin(Size leftMargin)Sets the left margin.voidsetLeftPadding(Size leftPadding)Sets the left padding.voidSets the margin.voidsetPadding(Size padding)Sets the padding.voidsetPrintContent(boolean printContent)Specifies if content is printed.voidsetRepeatContent(boolean repeatContent)Specifies whether text content of a cell is displayed as many times as there is space left in the cell's writing direction.voidsetRightBorder(Border rightBorder)Sets the right border for cell.voidsetRightBorderLineWidth(BorderLineWidth rightBorderLineWidth)Sets the right widths of borders.voidsetRightMargin(Size rightMargin)Sets the right margin.voidsetRightPadding(Size rightPadding)Sets the right padding.voidsetRotationAlignment(RotationAlignment rotationAlignment)Specifies how the edge of the text in a cell is aligned after a rotation.voidsetRotationAngle(int rotationAngle)Sets the rotation angle of content.voidSets the shadow of the cell.voidsetShrinkToFit(boolean shrinkToFit)Specifies whether content is reduced in size to fit within a cell or drawing object.voidsetTextAlignmentSource(TextAlignmentSource textAlignmentSource)Sets the source of a text-align attribute.voidsetTopBorder(Border topBorder)Sets the top border for cell.voidsetTopBorderLineWidth(BorderLineWidth topBorderLineWidth)Sets the top widths of borders.voidsetTopMargin(Size topMargin)Sets the top margin.voidsetTopPadding(Size topPadding)Sets the top padding.voidsetVerticalAlignment(CellVerticalAlignment verticalAlignment)Specifies how to vertically align a line that is less than 100% of its height within the columned area.voidsetVerticalGlyphOrientation(VerticalGlyphOrientation verticalGlyphOrientation)Sets the vertical glyph orientation.voidsetWritingMode(WritingMode writingMode)Sets the writing mode.toString()Converts the value of the current CellProperties object to its equivalent string representation.
-
Constructor Details
-
CellProperties
public CellProperties()Initializes a new instance of the CellProperties class.
-
-
Method Details
-
clone
Creates a new object that is a deep copy of the current instance. -
toString
Converts the value of the current CellProperties object to its equivalent string representation. -
getVerticalAlignment
Specifies how to vertically align a line that is less than 100% of its height within the columned area.- Returns:
- the vertical alignment
-
setVerticalAlignment
Specifies how to vertically align a line that is less than 100% of its height within the columned area.- Parameters:
verticalAlignment- the new vertical alignment
-
getBackgroundColor
Gets the background color for cell.- Returns:
- the background color
-
setBackgroundColor
Sets the background color for cell.- Parameters:
backgroundColor- the new background color
-
getBorder
Gets the border for cell.- Returns:
- the border
-
setBorder
Sets the border for cell.- Parameters:
border- the new border
-
getLeftBorder
Gets the left border for cell.- Returns:
- the left border
-
setLeftBorder
Sets the left border for cell.- Parameters:
leftBorder- the new left border
-
getRightBorder
Gets the right border for cell.- Returns:
- the right border
-
setRightBorder
Sets the right border for cell.- Parameters:
rightBorder- the new right border
-
getTopBorder
Gets the top border for cell.- Returns:
- the top border
-
setTopBorder
Sets the top border for cell.- Parameters:
topBorder- the new top border
-
getBottomBorder
Gets the bottom border for cell.- Returns:
- the bottom border
-
setBottomBorder
Sets the bottom border for cell.- Parameters:
bottomBorder- the new bottom border
-
getBorderLineWidth
Gets the widths of borders.- Returns:
- the border line width
-
setBorderLineWidth
Sets the widths of borders.- Parameters:
borderLineWidth- the new border line width
-
getLeftBorderLineWidth
Gets the left widths of borders.- Returns:
- the left border line width
-
setLeftBorderLineWidth
Sets the left widths of borders.- Parameters:
leftBorderLineWidth- the new left border line width
-
getRightBorderLineWidth
Gets the right widths of borders.- Returns:
- the right border line width
-
setRightBorderLineWidth
Sets the right widths of borders.- Parameters:
rightBorderLineWidth- the new right border line width
-
getTopBorderLineWidth
Gets the top widths of borders.- Returns:
- the top border line width
-
setTopBorderLineWidth
Sets the top widths of borders.- Parameters:
topBorderLineWidth- the new top border line width
-
getBottomBorderLineWidth
Gets the bottom widths of borders.- Returns:
- the bottom border line width
-
setBottomBorderLineWidth
Sets the bottom widths of borders.- Parameters:
bottomBorderLineWidth- the new bottom border line width
-
getPadding
Gets the padding.- Returns:
- the padding
-
setPadding
Sets the padding.- Parameters:
padding- the new padding
-
getLeftPadding
Gets the left padding.- Returns:
- the left padding
-
setLeftPadding
Sets the left padding.- Parameters:
leftPadding- the new left padding
-
getRightPadding
Gets the right padding.- Returns:
- the right padding
-
setRightPadding
Sets the right padding.- Parameters:
rightPadding- the new right padding
-
getTopPadding
Gets the top padding.- Returns:
- the top padding
-
setTopPadding
Sets the top padding.- Parameters:
topPadding- the new top padding
-
getBottomPadding
Gets the bottom padding.- Returns:
- the bottom padding
-
setBottomPadding
Sets the bottom padding.- Parameters:
bottomPadding- the new bottom padding
-
getMargin
Gets the margin.- Returns:
- the margin
-
setMargin
Sets the margin.- Parameters:
margin- the new margin
-
getLeftMargin
Gets the left margin.- Returns:
- the left margin
-
setLeftMargin
Sets the left margin.- Parameters:
leftMargin- the new left margin
-
getRightMargin
Gets the right margin.- Returns:
- the right margin
-
setRightMargin
Sets the right margin.- Parameters:
rightMargin- the new right margin
-
getTopMargin
Gets the top margin.- Returns:
- the top margin
-
setTopMargin
Sets the top margin.- Parameters:
topMargin- the new top margin
-
getBottomMargin
Gets the bottom margin.- Returns:
- the bottom margin
-
setBottomMargin
Sets the bottom margin.- Parameters:
bottomMargin- the new bottom margin
-
getTextAlignmentSource
Gets the source of a text-align attribute.- Returns:
- the text alignment source
-
setTextAlignmentSource
Sets the source of a text-align attribute.- Parameters:
textAlignmentSource- the new text alignment source
-
getDirection
Gets the direction of characters.- Returns:
- the direction
-
setDirection
Sets the direction of characters.- Parameters:
direction- the new direction
-
getVerticalGlyphOrientation
Gets the vertical glyph orientation.- Returns:
- the vertical glyph orientation
-
setVerticalGlyphOrientation
Sets the vertical glyph orientation.- Parameters:
verticalGlyphOrientation- the new vertical glyph orientation
-
isShrinkToFit
public boolean isShrinkToFit()Specifies whether content is reduced in size to fit within a cell or drawing object.- Returns:
- true, if is shrink to fit
-
setShrinkToFit
public void setShrinkToFit(boolean shrinkToFit)Specifies whether content is reduced in size to fit within a cell or drawing object.- Parameters:
shrinkToFit- the new shrink to fit
-
isRepeatContent
public boolean isRepeatContent()Specifies whether text content of a cell is displayed as many times as there is space left in the cell's writing direction.- Returns:
- true, if is repeat content
-
setRepeatContent
public void setRepeatContent(boolean repeatContent)Specifies whether text content of a cell is displayed as many times as there is space left in the cell's writing direction.- Parameters:
repeatContent- the new repeat content
-
getDecimalPlaces
public int getDecimalPlaces()Gets the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself.- Returns:
- the decimal places
-
setDecimalPlaces
public void setDecimalPlaces(int decimalPlaces)Sets the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself.- Parameters:
decimalPlaces- the new decimal places
-
isPrintContent
public boolean isPrintContent()Specifies if content is printed.- Returns:
- true, if is prints the content
-
setPrintContent
public void setPrintContent(boolean printContent)Specifies if content is printed.- Parameters:
printContent- the new prints the content
-
getCellProtect
Specifies how a cell is protected.- Returns:
- the cell protect
-
setCellProtect
Specifies how a cell is protected.- Parameters:
cellProtect- the new cell protect
-
getRotationAlignment
Specifies how the edge of the text in a cell is aligned after a rotation.- Returns:
- the rotation alignment
-
setRotationAlignment
Specifies how the edge of the text in a cell is aligned after a rotation.- Parameters:
rotationAlignment- the new rotation alignment
-
getRotationAngle
public int getRotationAngle()Get the rotation angle of content.- Returns:
- the rotation angle
-
setRotationAngle
public void setRotationAngle(int rotationAngle)Sets the rotation angle of content.- Parameters:
rotationAngle- the new rotation angle
-
isEnableWrap
public boolean isEnableWrap()If wrapping is disabled, it is implementation defined whether the clipped text is visible or hidden. If the text is hidden consumers may support a scrolling mechanism to access the text.- Returns:
- true, if is enable wrap
-
setEnableWrap
public void setEnableWrap(boolean enableWrap)If wrapping is disabled, it is implementation defined whether the clipped text is visible or hidden. If the text is hidden consumers may support a scrolling mechanism to access the text.- Parameters:
enableWrap- the new enable wrap
-
getShadow
Gets the shadow of the cell.- Returns:
- the shadow
-
setShadow
Sets the shadow of the cell.- Parameters:
shadow- the new shadow
-
getWritingMode
Gets the writing mode.- Returns:
- the writing mode
-
setWritingMode
Sets the writing mode.- Parameters:
writingMode- the new writing mode
-
getBackgroundImage
Gets the background image.- Returns:
- the background image
-
setBackgroundImage
Sets the background image.- Parameters:
backgroundImage- the new background image
-