Documentation

Header extends AbstractPart
in package

RTF header part writer.

  • Character set
  • Font table
  • File table (not supported yet)
  • Color table
  • Style sheet (not supported yet)
  • List table (not supported yet)
Tags
since
0.11.0
see
http://www.biblioscape.com/rtf15_spec.htm#Heading6

Table of Contents

Properties

$escaper  : EscaperInterface
$colorTable  : array<string|int, mixed>
Color table.
$fontTable  : array<string|int, mixed>
Font table.
$parentWriter  : RTF

Methods

__construct()  : mixed
getColorTable()  : array<string|int, mixed>
Get color table.
getFontTable()  : array<string|int, mixed>
Get font table.
getParentWriter()  : RTF
setParentWriter()  : void
write()  : string
Write part.
registerBorderColor()  : void
Register border colors.
registerFont()  : void
Register all fonts and colors in both named and inline styles to appropriate header table.
registerFontItems()  : void
Register fonts and colors.
registerTableItem()  : void
Register individual font and color.
writeCharset()  : string
Write character set.
writeColorTable()  : string
Write color table.
writeDefaults()  : string
Write header defaults.
writeFontTable()  : string
Write font table.
writeGenerator()  : string
Write.

Properties

$colorTable

Color table.

private array<string|int, mixed> $colorTable = []

$fontTable

Font table.

private array<string|int, mixed> $fontTable = []

Methods

getColorTable()

Get color table.

public getColorTable() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFontTable()

Get font table.

public getFontTable() : array<string|int, mixed>
Return values
array<string|int, mixed>

setParentWriter()

public setParentWriter([RTF $writer = null ]) : void
Parameters
$writer : RTF = null

write()

Write part.

public write() : string
Return values
string

registerBorderColor()

Register border colors.

private registerBorderColor(Border $style) : void
Parameters
$style : Border

registerFont()

Register all fonts and colors in both named and inline styles to appropriate header table.

private registerFont() : void

registerTableItem()

Register individual font and color.

private registerTableItem(array<string|int, mixed> &$table, string $value[, string $default = null ]) : void
Parameters
$table : array<string|int, mixed>
$value : string
$default : string = null

writeCharset()

Write character set.

private writeCharset() : string
Return values
string

writeColorTable()

Write color table.

private writeColorTable() : string
Return values
string

writeDefaults()

Write header defaults.

private writeDefaults() : string
Return values
string

writeFontTable()

Write font table.

private writeFontTable() : string
Return values
string

writeGenerator()

Write.

private writeGenerator() : string
Return values
string

        
On this page

Search results