OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler Class Reference

Public Member Functions
	renderTextEditor ($width, $height, $objectValue, $fieldName)
	renderPlainTextEditor ($width, $height, $objectValue, $fieldName)
	renderRichTextEditor ($width, $height, $objectValue, $fieldName)
	setStyleSheet ($stylesheet)
	getStyleSheet ()
	disableTextEditor ()
	isTextEditorDisabled ()

Protected Attributes
	$textEditorDisabled = false

Private Attributes
	$stylesheet = null

Detailed Description

Responsible for generation of text editor output.

Class TextEditorHandler

Member Function Documentation

disableTextEditor()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::disableTextEditor

(

)

Mark text editor disabled: information in it should not be editable.

getStyleSheet()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::getStyleSheet

(

)

Get the style sheet for the editor.

Returns

string The stylesheet for the editor.

isTextEditorDisabled()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::isTextEditorDisabled

(

)

If information in text editor is not editable.

Returns

bool

renderPlainTextEditor()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::renderPlainTextEditor	(		$width,
			$height,
			$objectValue,
			$fieldName
	)

Returns simple textarea element filled with object text to edit.

Parameters

int	$width	The editor width.
int	$height	The editor height.
object	$objectValue	The object value passed to editor.
string	$fieldName	The name of object field which content is passed to editor.

Returns

string The Editor output.

renderRichTextEditor()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::renderRichTextEditor	(		$width,
			$height,
			$objectValue,
			$fieldName
	)

Returns the generated output of wysiwyg editor.

Parameters

int	$width	The editor width.
int	$height	The editor height.
object	$objectValue	The object value passed to editor.
string	$fieldName	The name of object field which content is passed to editor.

Returns

string The Editor output.

renderTextEditor()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::renderTextEditor	(		$width,
			$height,
			$objectValue,
			$fieldName
	)

Render text editor.

Parameters

int	$width	The editor width.
int	$height	The editor height.
object	$objectValue	The object value passed to editor.
string	$fieldName	The name of object field which content is passed to editor.

Returns

string The Editor output.

setStyleSheet()

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::setStyleSheet

(

$stylesheet

)

Set the style sheet for the editor.

Parameters

string

$stylesheet

The stylesheet for editor.

Member Data Documentation

$stylesheet

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::$stylesheet = null

private

$textEditorDisabled

OxidEsales\EshopCommunity\Application\Controller\TextEditorHandler::$textEditorDisabled = false

protected

---

The documentation for this class was generated from the following file:

• /oxideshop-ce/source/Application/Controller/TextEditorHandler.php