Docs For Class ParFormat

Description

Paragraph formating class.

Method Summary

ParFormat ParFormat ([ $alignment = 'left'], string $alignment.)

string getContent ( &$rtf, Rtf $rtf)

void setBackColor (string $backColor)

void setBorders (BorderFormat &$borderFormat, [boolean $left = true], [boolean $top = true], [boolean $right = true], [boolean $bottom = true])

void setIndentFirst (float $indentFirst)

void setIndentLeft (float $indentLeft)

void setIndentRight (float $indentRight)

void setShading (integer $shading)

void setSpaceAfter (integer $spaceAfter)

void setSpaceBefore (integer $spaceBefore)

void setSpaceBetweenLines (integer $spaceBetweenLines)

Methods

Constructor ParFormat (line 40)

ParFormat Constructor

access: public

ParFormat ParFormat ([ $alignment = 'left'], string $alignment.)

string $alignment.: Possible values:
'left'- left alignment
'right'- right alignment
'center'- centera lignment
'justify'- justify alignment
$alignment

getContent (line 162)

Gets rtf code of paragraph format. Internal use.

access: public

string getContent ( &$rtf, Rtf $rtf)

Rtf $rtf: Rtf object
&$rtf

setBackColor (line 135)

Sets background color.

access: public

void setBackColor (string $backColor)

string $backColor

setBorders (line 148)

Sets borders of element.

access: public

void setBorders (BorderFormat &$borderFormat, [boolean $left = true], [boolean $top = true], [boolean $right = true], [boolean $bottom = true])

BorderFormat &$borderFormat
boolean $left: If false, left border is not set (default true)
boolean $top: If false, top border is not set (default true)
boolean $right: If false, right border is not set (default true)
boolean $bottom: If false, bottom border is not set (default true)

setIndentFirst (line 69)

Sets first line indent (default 0)

access: public

void setIndentFirst (float $indentFirst)

float $indentFirst

setIndentLeft (line 78)

Sets left indent (default 0)

access: public

void setIndentLeft (float $indentLeft)

float $indentLeft

setIndentRight (line 87)

Sets right indent (default 0)

access: public

void setIndentRight (float $indentRight)

float $indentRight

setShading (line 126)

Sets shading.

access: public

void setShading (integer $shading)

integer $shading: Shading value in percents (from 0 till 100)

setSpaceAfter (line 106)

Sets the vertical spacing after this paragraph.

todo: documentation
access: public

void setSpaceAfter (integer $spaceAfter)

integer $spaceAfter: Space after

setSpaceBefore (line 96)

Sets the vertical spacing before this paragraph.

access: public

void setSpaceBefore (integer $spaceBefore)

integer $spaceBefore: Space before

setSpaceBetweenLines (line 116)

Sets the vertical spacing between paragraph lines.

todo: documentation
access: public

void setSpaceBetweenLines (integer $spaceBetweenLines)

integer $spaceBetweenLines: Vertical space between lines