WIKINDX API trunk

LISTS

Table of Contents

Constants

HANGING  : mixed = 360
INDENT  : mixed = 720
MAX_LEVEL  : mixed = 8
OL_LIST  : mixed = [0 => 'decimal', 1 => 'lowerLetter', 2 => 'lowe...
START_LEVEL  : mixed = -1
UL_FONTS  : mixed = [0 => ['ascii' => 'Symbol', 'hAnsi' => 'Symbol'...
UL_LIST  : mixed = [ 0 => '•', // Symbol 1 => 'o', // Courier New...

Functions

lists()  : mixed
Set and get methods for dealing with lists.
numIds()  : array<string|int, mixed>
Build up the numIds array
abstractNumIds()  : array<string|int, mixed>
Build up the abstractNumIds array
startListItem()  : void
Start a list (ul or ol)
listItemProps()  : void
List item (li)
endListItem()  : void
End a list (ul or ol)

Constants

HANGING

public mixed HANGING = 360

INDENT

public mixed INDENT = 720

MAX_LEVEL

public mixed MAX_LEVEL = 8

OL_LIST

public mixed OL_LIST = [0 => 'decimal', 1 => 'lowerLetter', 2 => 'lowerRoman']

START_LEVEL

public mixed START_LEVEL = -1

UL_FONTS

public mixed UL_FONTS = [0 => ['ascii' => 'Symbol', 'hAnsi' => 'Symbol'], 1 => ['ascii' => 'Courier New', 'hAnsi' => 'Courier New'], 2 => ['ascii' => 'Wingdings', 'hAnsi' => 'Wingdings']]

UL_LIST

public mixed UL_LIST = [ 0 => '•', // Symbol 1 => 'o', // Courier New 2 => '§', ]

Functions

lists()

Set and get methods for dealing with lists.

lists(string $method[, XMLWriter $xml = null ][, string $list = 'ul' ][, string $attr = '' ]) : mixed

$list can be either 'ul' or 'ol'. If $list is 'ul' and $attr is '', then this is the initial bullet of the UL_LIST array—an array of three bullet types we cycle through. If $list is 'ol' and $attr is '', then this is a numbered list. In tinyMCE, unless specified, a numbered list levels stay on numbered.

Parameters
$method : string
$xml : XMLWriter = null

Default NULL

$list : string = 'ul'

Default 'ul'

$attr : string = ''

Default ''

numIds()

Build up the numIds array

numIds(int $numId, int $abstractNumId) : array<string|int, mixed>
Parameters
$numId : int
$abstractNumId : int
Return values
array<string|int, mixed>

abstractNumIds()

Build up the abstractNumIds array

abstractNumIds(int $level, string $numFmt, mixed $lvlText) : array<string|int, mixed>
Parameters
$level : int
$numFmt : string
$lvlText : mixed
Return values
array<string|int, mixed>

startListItem()

Start a list (ul or ol)

startListItem(XMLWriter $xml) : void
Parameters
$xml : XMLWriter

listItemProps()

List item (li)

listItemProps(XMLWriter $xml, int $ilvl, int $numId) : void
Parameters
$xml : XMLWriter
$ilvl : int
$numId : int

endListItem()

End a list (ul or ol)

endListItem(XMLWriter $xml) : void
Parameters
$xml : XMLWriter

        
On this page

Search results