Documentation

Font extends AbstractStyle

in package

• Application

Font style.

Table of Contents

Constants

FGCOLOR_BLACK  = 'black'

FGCOLOR_BLUE  = 'blue'

FGCOLOR_CYAN  = 'cyan'

FGCOLOR_DARKBLUE  = 'darkBlue'

FGCOLOR_DARKCYAN  = 'darkCyan'

FGCOLOR_DARKGRAY  = 'darkGray'

FGCOLOR_DARKGREEN  = 'darkGreen'

FGCOLOR_DARKMAGENTA  = 'darkMagenta'

FGCOLOR_DARKRED  = 'darkRed'

FGCOLOR_DARKYELLOW  = 'darkYellow'

FGCOLOR_LIGHTGRAY  = 'lightGray'

FGCOLOR_LIGHTGREEN  = 'green'

FGCOLOR_MAGENTA  = 'magenta'

FGCOLOR_RED  = 'red'

FGCOLOR_YELLOW  = 'yellow'

Foreground colors.

UNDERLINE_DASH  = 'dash'

UNDERLINE_DASHHEAVY  = 'dashHeavy'

UNDERLINE_DASHLONG  = 'dashLong'

UNDERLINE_DASHLONGHEAVY  = 'dashLongHeavy'

UNDERLINE_DOTDASH  = 'dotDash'

UNDERLINE_DOTDASHHEAVY  = 'dotDashHeavy'

UNDERLINE_DOTDOTDASH  = 'dotDotDash'

UNDERLINE_DOTDOTDASHHEAVY  = 'dotDotDashHeavy'

UNDERLINE_DOTTED  = 'dotted'

UNDERLINE_DOTTEDHEAVY  = 'dottedHeavy'

UNDERLINE_DOUBLE  = 'dbl'

UNDERLINE_HEAVY  = 'heavy'

UNDERLINE_NONE  = 'none'

Underline types.

UNDERLINE_SINGLE  = 'single'

UNDERLINE_WAVY  = 'wavy'

UNDERLINE_WAVYDOUBLE  = 'wavyDbl'

UNDERLINE_WAVYHEAVY  = 'wavyHeavy'

UNDERLINE_WORDS  = 'words'

Properties

$aliases  : array<string|int, mixed>

Aliases.

$index  : null|int

Index number in Style collection for named style.

$styleName  : string|null

Style name.

$allCaps  : bool

All caps.

$bold  : bool

Bold.

$color  : string

Font color.

$doubleStrikethrough  : bool

Double strikethrough.

$fallbackFont  : string

Generic font as fallback for html.

$fgColor  : string

Foreground/highlight.

$hidden  : bool

Hidden text.

$hint  : string

Font Content Type.

$isAuto  : bool

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

$italic  : bool

Italic.

$kerning  : float|int

Font kerning: halfpoint.

$lang  : null|Language

Languages.

$name  : string

Font name.

$noProof  : bool

noProof (disables AutoCorrect).

$paragraph  : Paragraph

Paragraph style.

$position  : int

Vertically Raised or Lowered Text.

$rtl  : bool|null

Right to left languages.

$scale  : int

Expanded/compressed text: 0-600 (percent).

$shading  : Shading

Shading.

$size  : float|int

Font size.

$smallCaps  : bool

Small caps.

$spacing  : float|int

Character spacing adjustment: twip.

$strikethrough  : bool

Strikethrough.

$subScript  : bool

Subscript.

$superScript  : bool

Superscript.

$type  : string

Font style type.

$underline  : string

Undeline.

$whiteSpace  : string

Preservation of white space in html.

Methods

__construct()  : mixed

Create new font style.

getBgColor()  : string

Get background.

getChildStyleValue()  : mixed

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

getColor()  : string

Get font color.

getFallbackFont()  : string

Get html fallback generic font.

getFgColor()  : string

Get foreground/highlight color.

getHint()  : string

Get Font Content Type.

getIndex()  : null|int

Get index number.

getKerning()  : float|int

Get font kerning.

getLang()  : null|Language

Get language.

getLineHeight()  : float|int

Get line height.

getName()  : string

Get font name.

getParagraph()  : Paragraph

Get paragraph style.

getPosition()  : int

Get position.

getScale()  : int

Get scale.

getShading()  : Shading

Get shading.

getSize()  : float|int

Get font size.

getSpacing()  : float|int

Get font spacing.

getStyleName()  : string|null

Get style name.

getStyleType()  : string

Get style type.

getStyleValues()  : array<string|int, mixed>

Get style values.

getUnderline()  : string

Get underline.

getWhiteSpace()  : string

Get html css white-space value.

isAllCaps()  : bool

Get all caps.

isAuto()  : bool

Get is automatic style flag.

isBold()  : bool

Get bold.

isDoubleStrikethrough()  : bool|null

Get double strikethrough.

isHidden()  : bool

Get hidden text.

isItalic()  : bool

Get italic.

isNoProof()  : bool

Get noProof (disables autocorrect).

isRTL()  : bool|null

Get rtl.

isSmallCaps()  : bool

Get small caps.

isStrikethrough()  : bool|null

Get strikethrough.

isSubScript()  : bool

Get subscript.

isSuperScript()  : bool

Get superscript.

setAllCaps()  : self

Set all caps.

setAuto()  : self

Set is automatic style flag.

setBgColor()  : Table

Set background.

setBold()  : self

Set bold.

setColor()  : self

Set font color.

setDoubleStrikethrough()  : self

Set double strikethrough.

setFallbackFont()  : self

Set generic font for fallback for html.

setFgColor()  : self

Set foreground/highlight color.

setHidden()  : self

Set hidden text.

setHint()  : self

Set Font Content Type.

setIndex()  : self

Set index number.

setItalic()  : self

Set italic.

setKerning()  : self

Set font kerning.

setLang()  : self

Set language.

setLineHeight()  : self

Set lineheight.

setName()  : self

Set font name.

setNoProof()  : $this

Set noProof (disables autocorrect).

setParagraph()  : self

Set Paragraph.

setPosition()  : self

Set position.

setRTL()  : self

Set rtl.

setScale()  : self

Set scale.

setShading()  : self

Set shading.

setSize()  : self

Set font size.

setSmallCaps()  : self

Set small caps.

setSpacing()  : self

Set font spacing.

setStrikethrough()  : self

Set strikethrough.

setStyleByArray()  : self

Set style by using associative array.

setStyleName()  : self

Set style name.

setStyleValue()  : self

Set style value template method.

setSubScript()  : self

Set subscript.

setSuperScript()  : self

Set superscript.

setUnderline()  : self

Set underline.

setWhiteSpace()  : self

Set html css white-space value. It is expected that only pre-wrap and normal (default) are useful.

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.