Documentation

Cell extends Border

in package

• Application

Table cell style.

Table of Contents

Constants

DEFAULT_BORDER_COLOR  = '000000'

Default border color.

DEFAULT_MARGIN  = 1440

TEXT_DIR_BTLR  = 'btLr'

Bottom to Top, Left to Right.

TEXT_DIR_LRTB  = 'lrTb'

Left to Right, Top to Bottom.

TEXT_DIR_LRTBV  = 'lrTbV'

Left to Right, Top to Bottom Rotated.

TEXT_DIR_TBLRV  = 'tbLrV'

Top to Bottom, Left to Right Rotated.

TEXT_DIR_TBRL  = 'tbRl'

Top to Bottom, Right to Left.

TEXT_DIR_TBRLV  = 'tbRlV'

Top to Bottom, Right to Left Rotated.

VMERGE_CONTINUE  = 'continue'

VMERGE_RESTART  = 'restart'

Vertical merge (rowspan) constants.

Properties

$aliases  : array<string|int, mixed>

Aliases.

$borderBottomColor  : null|string

Border Bottom Color.

$borderBottomSize  : float|int

Border Bottom Size.

$borderBottomStyle  : string

Border Bottom Style.

$borderLeftColor  : null|string

Border Left Color.

$borderLeftSize  : float|int

Border Left Size.

$borderLeftStyle  : string

Border Left Style.

$borderRightColor  : null|string

Border Right Color.

$borderRightSize  : float|int

Border Right Size.

$borderRightStyle  : string

Border Right Style.

$borderTopColor  : null|string

Border Top Color.

$borderTopSize  : float|int

Border Top Size.

$borderTopStyle  : string

Border Top Style.

$index  : null|int

Index number in Style collection for named style.

$marginBottom  : float|int

Bottom margin spacing.

$marginLeft  : float|int

Left margin spacing.

$marginRight  : float|int

Right margin spacing.

$marginTop  : float|int

Top margin spacing.

$styleName  : string|null

Style name.

$gridSpan  : int

colspan.

$isAuto  : bool

Is this an automatic style? (Used primarily in OpenDocument driver).

$noWrap  : bool

Prevent text from wrapping in the cell.

$shading  : Shading

Shading.

$textDirection  : string

Text Direction.

$unit  : string

Width unit.

$vAlign  : null|string

Vertical align (top, center, both, bottom).

$vMerge  : null|string

rowspan (restart, continue).

$width  : int|null

Width.

Methods

getBgColor()  : string

Get background.

getBorderBottomColor()  : null|string

Get border bottom color.

getBorderBottomSize()  : float|int

Get border bottom size.

getBorderBottomStyle()  : string

Get border bottom style.

getBorderColor()  : array<string|int, null|string>

Get border color.

getBorderLeftColor()  : null|string

Get border left color.

getBorderLeftSize()  : float|int

Get border left size.

getBorderLeftStyle()  : string

Get border left style.

getBorderRightColor()  : null|string

Get border right color.

getBorderRightSize()  : float|int

Get border right size.

getBorderRightStyle()  : string

Get border right style.

getBorderSize()  : array<string|int, int>

Get border size.

getBorderStyle()  : array<string|int, string>

Get border style.

getBorderTopColor()  : null|string

Get border top color.

getBorderTopSize()  : float|int

Get border top size.

getBorderTopStyle()  : string

Get border top style.

getChildStyleValue()  : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.

getGridSpan()  : int

Get grid span (colspan).

getIndex()  : null|int

Get index number.

getMarginBottom()  : float|int

Get Margin Bottom.

getMarginLeft()  : float|int

Get Margin Left.

getMarginRight()  : float|int

Get Margin Right.

getMarginTop()  : float|int

Get Margin Top.

getNoWrap()  : bool

Get noWrap.

getShading()  : Shading

Get shading.

getStyleName()  : string|null

Get style name.

getTextDirection()  : string

Get text direction.

getUnit()  : string

Get width unit.

getVAlign()  : null|string

Get vertical align.

getVMerge()  : null|string

Get vertical merge (rowspan).

getWidth()  : int|null

Get cell width.

hasBorder()  : bool

Check if any of the border is not null.

isAuto()  : bool

Get is automatic style flag.

setAuto()  : self

Set is automatic style flag.

setBgColor()  : self

Set background.

setBorderBottomColor()  : self

Set border bottom color.

setBorderBottomSize()  : self

Set border bottom size.

setBorderBottomStyle()  : self

Set border bottom style.

setBorderColor()  : self

Set border color.

setBorderLeftColor()  : self

Set border left color.

setBorderLeftSize()  : self

Set border left size.

setBorderLeftStyle()  : self

Set border left style.

setBorderRightColor()  : self

Set border right color.

setBorderRightSize()  : self

Set border right size.

setBorderRightStyle()  : self

Set border right style.

setBorderSize()  : self

Set border size.

setBorderStyle()  : self

Set border style.

setBorderTopColor()  : self

Set border top color.

setBorderTopSize()  : self

Set border top size.

setBorderTopStyle()  : self

Set border top Style.

setGridSpan()  : self

Set grid span (colspan).

setIndex()  : self

Set index number.

setMarginBottom()  : self

Set Margin Bottom.

setMarginLeft()  : self

Set Margin Left.

setMarginRight()  : self

Set Margin Right.

setMarginTop()  : self

Set Margin Top.

setNoWrap()  : self

Set noWrap.

setShading()  : self

Set shading.

setStyleByArray()  : self

Set style by using associative array.

setStyleName()  : self

Set style name.

setStyleValue()  : self

Set style value template method.

setTextDirection()  : self

Set text direction.

setUnit()  : mixed

Set width unit.

setVAlign()  : self

Set vertical align.

setVMerge()  : self

Set vertical merge (rowspan).

setWidth()  : self

Set cell width.

setBoolVal()  : bool

Set bool value.

setEnumVal()  : mixed

Set enum value.

setFloatVal()  : null|float

Set float value: Convert string that contains only numeric into float.

setIntVal()  : null|int

Set integer value: Convert string that contains only numeric into integer.

setNonEmptyVal()  : string

Set default for null and empty value.

setNumericVal()  : null|float|int

Set numeric value.

setObjectVal()  : mixed

Set object value.

setPairedVal()  : self

Set $property value and set $pairProperty = false when $value = true.