Ibuildings - Docs For Class FCKeditor

Home

Documentation home

Atk index

Docs For Class FCKeditor [ package: atk ]

Class: FCKeditor

Source Location: /attributes/fck/fckeditor_php4.php

Class FCKeditor

Class Overview

Located in /attributes/fck/fckeditor_php4.php [line 74]

Wiki documentation

Properties

Methods

[ Top ]

Property Summary

string	$BasePath	Path to FCKeditor relative to the document root.
array	$Config	This is where additional configuration can be passed.
mixed	$Height	Height of the FCKeditor.
string	$InstanceName	Name of the FCKeditor instance.
string	$ToolbarSet	Name of the toolbar to load.
string	$Value	Initial value.
mixed	$Width	Width of the FCKeditor.

[ Top ]

Method Summary

FCKeditor	FCKeditor()	Main Constructor.
void	Create()	Display FCKeditor.
string	CreateHtml()	Return the HTML code required to run FCKeditor.
string	EncodeConfig()	Encode characters that may break the configuration string generated by GetConfigFieldString().
string	GetConfigFieldString()	Get settings from Config array as a single string.
boolean	IsCompatible()	Returns true if browser is compatible with FCKeditor.

[ Top ]

Properties

string $BasePath [line 88]

Path to FCKeditor relative to the document root.

[ Top ]

array $Config [line 122]

This is where additional configuration can be passed.

Example: $oFCKeditor->Config['EnterMode'] = 'br';

[ Top ]

mixed $Height [line 102]

Height of the FCKeditor.

Examples: 400, 50%

[ Top ]

string $InstanceName [line 82]

Name of the FCKeditor instance.

API Tags:

Access:

protected

[ Top ]

string $ToolbarSet [line 108]

Name of the toolbar to load.

[ Top ]

string $Value [line 114]

Initial value.

[ Top ]

mixed $Width [line 95]

Width of the FCKeditor.

Examples: 100%, 600

[ Top ]

Methods

Constructor FCKeditor [line 130]

FCKeditor FCKeditor(
string
$instanceName 
)

Main Constructor.

Refer to the _samples/php directory for examples.

Parameters:

string

$instanceName:

[ Top ]

Create [line 146]

void Create(
)

Display FCKeditor.

[ Top ]

CreateHtml [line 156]

string CreateHtml(
)

Return the HTML code required to run FCKeditor.

[ Top ]

EncodeConfig [line 253]

string EncodeConfig(
string
$valueToEncode 
)

Encode characters that may break the configuration string generated by GetConfigFieldString().

Parameters:

string

$valueToEncode:

API Tags:

Access:

protected

[ Top ]

GetConfigFieldString [line 222]

string GetConfigFieldString(
)

Get settings from Config array as a single string.

API Tags:

Access:

protected

[ Top ]

IsCompatible [line 211]

boolean IsCompatible(
)

Returns true if browser is compatible with FCKeditor.

[ Top ]