Class htmlarea_config

Description

A container class for configuration settings for the HTMLArea

internal configuration structure. We provide a selection of all the possible HTMLArea parameters, which represents a subset. This also renders the Javascript definition for the config @see render()

Located in /htmlarea-defs.php (line 206)


	
			
Variable Summary
Method Summary
 htmlarea_config htmlarea_config ()
 void render (mixed $configvar)
Variables
mixed $blockformats (line 245)

The list of block format styles to allow user to choose from

mixed $fontnames (line 239)

The list of font families to allow user to choose from

mixed $fontsizes (line 242)

The list of font sizes to allow user to choose from

mixed $fullPage (line 224)

if true then HTMLArea will retrieve the full HTML, starting

mixed $height (line 210)

Height of HTMLarea element (default 'auto')

mixed $htmlareaPaste (line 216)

intercept ^V and use the HTMLArea paste command

mixed $htmlRemoveTags (line 232)

HTML tags to disallow (these have to be a regexp, or null

mixed $killWordOnPaste (line 229)

set to true if you want Word code to be cleaned upon Paste

mixed $pageStyle (line 226)

style included in the iframe document (default nullstring)

mixed $sizeIncludesToolbar (line 221)

the next parameter specifies whether the toolbar should

mixed $statusBar (line 212)

enable creation of a status bar? (default true)

mixed $toolbar (line 236)

The toolbar. This takes the form of an array of arrays of toolbar

mixed $toolbar_basic = array(
array(
"fontname", "space",
"fontsize", "space",
"formatblock", "space",
"bold", "italic", "underline", "separator",
"undo", "redo", "space", "removeformat"
),array("space"))
(line 250)

A basic toolbar definition. Use for entering text in given

mixed $toolbar_full = array(
array(
"fontname", "space",
"fontsize", "space",
"formatblock", "space",
"bold", "italic", "underline", "strikethrough", "separator",
"subscript", "superscript", "separator",
"copy", "cut", "paste"
),array("justifyleft","justifycenter","justifyright","justifyfull","separator","lefttoright","righttoleft","separator","orderedlist","unorderedlist","outdent","indent"),array("undo","redo","space","removeformat","forecolor","hilitecolor","separator","inserthorizontalrule","createlink","insertimage","inserttable","htmlmode","separator","popupeditor","killword","separator","showhelp","about"))
(line 282)

A fully-populated toolbar definition for power users

mixed $toolbar_medium = array(
array(
"fontname", "space",
"fontsize", "space",
"formatblock", "space",
"bold", "italic", "underline", "strikethrough", "separator",
"copy", "cut", "paste", "space", "undo", "redo", "space", "removeformat"
),array("justifyleft","justifycenter","justifyright","justifyfull","separator","orderedlist","unorderedlist","outdent","indent","separator","forecolor","hilitecolor","separator","inserthorizontalrule","createlink","htmlmode","separator","popupeditor","separator","showhelp","about"),)
(line 263)

A medium toolbar definition, adds colour, links, raw HTML editing,

mixed $undoSteps (line 218)

maximum size of the undo queue (default 20)

mixed $width (line 208)

Width of HTMLarea element (default 'auto')

Methods
Constructor htmlarea_config (line 305)

Constructor for new HTMLArea configuration object

htmlarea_config htmlarea_config ()
render (line 313)

Render this config as a string of Javascript which could be put into a webapage and used to set the configuration of a real HTMLArea object.

void render (mixed $configvar)

Documentation generated by phpDocumentor 1.3.0RC3