Documentation

Header extends AbstractPart

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

$escaper  : EscaperInterface
$colorTable  : array<string|int, mixed>
Color table
$fontTable  : array<string|int, mixed>
Font table
$parentWriter  : AbstractWriter
__construct()  : mixed
getColorTable()  : array<string|int, mixed>
Get color table.
getFontTable()  : array<string|int, mixed>
Get font table.
getParentWriter()  : AbstractWriter
setParentWriter()  : mixed
write()  : string
Write part
registerBorderColor()  : mixed
Register border colors.
registerFont()  : mixed
Register all fonts and colors in both named and inline styles to appropriate header table.
registerFontItems()  : mixed
Register fonts and colors.
registerTableItem()  : mixed
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 = array()

$fontTable

Font table

private array<string|int, mixed> $fontTable = array()

Methods

__construct()

public __construct() : mixed
Return values
mixed

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>

write()

Write part

public write() : string
Return values
string

registerBorderColor()

Register border colors.

private registerBorderColor(Border $style) : mixed
Parameters
$style : Border
Return values
mixed

registerFont()

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

private registerFont() : mixed
Return values
mixed

registerFontItems()

Register fonts and colors.

private registerFontItems(AbstractStyle $style) : mixed
Parameters
$style : AbstractStyle
Return values
mixed

registerTableItem()

Register individual font and color.

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

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

Search results