Dojo/Form/Element/Editor.php

Show:

inherited

Classes
- \Zend_Dojo_Form_Element_Editor

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Dojo
Subpackage: Form_Element
Version: $Id$

\Zend_Dojo_Form_Element_Editor
jump to top

Package: Zend_Dojo\Form_Element

Editor dijit

Parent(s): \Zend_Dojo_Form_Element_Dijit < \Zend_Form_Element
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses

Properties

string $helper = 'Editor'

View helper

Default value'Editor'Details

Type: string

Methods

addCaptureEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Add a single event to connect to the editing area

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addCaptureEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Add multiple capture events

Parameters

Name	Type	Description
$events	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Add a single event to the dijit

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Add multiple events

Parameters

Name	Type	Description
$events	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addExtraPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Add a single editor extra plugin.

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addExtraPlugins( $plugins) : \Zend_Dojo_Form_Element_Editor

Add multiple extra plugins.

Parameters

Name	Type	Description
$plugins

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Add a single editor plugin

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Add multiple plugins

Parameters

Name	Type	Description
$plugins	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addStyleSheet(string $styleSheet) : \Zend_Dojo_Form_Element_Editor

Add a custom stylesheet

Parameters

Name	Type	Description
$styleSheet	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

addStyleSheets(array $styleSheets) : \Zend_Dojo_Form_Element_Editor

Add multiple custom stylesheets

Parameters

Name	Type	Description
$styleSheets	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

clearCaptureEvents() : \Zend_Dojo_Form_Element_Editor

Clear all capture events

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

clearEvents() : \Zend_Dojo_Form_Element_Editor

Clear all events

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

clearExtraPlugins() : \Zend_Dojo_Form_Element_Editor

Clear all extra plugins.

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

clearPlugins() : \Zend_Dojo_Form_Element_Editor

Clear all plugins

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

clearStyleSheets() : \Zend_Dojo_Form_Element_Editor

Clear all stylesheets

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

getCaptureEvents() : array

Get all capture events

Returns

Type	Description
array

getEditActionInterval() : int

Get edit action interval; defaults to 3

Returns

Type	Description
int

getEvents() : array

Get all events

Returns

Type	Description
array

getExtraPlugins() : array

Get all extra plugins.

Returns

Type	Description
array

getFocusOnLoad() : bool

Retrieve focus on load flag

Returns

Type	Description
bool

getHeight() : string

Retrieve height

Returns

Type	Description
string

getInheritWidth() : bool

Whether or not to inherit the parent's width

Returns

Type	Description
bool

getMinHeight() : string

Get minimum height of editor

Returns

Type	Description
string

getPlugins() : array

Get all plugins

Returns

Type	Description
array

getStyleSheets() : string

Get all stylesheets

Returns

Type	Description
string

getUpdateInterval() : int

Get update interval

Returns

Type	Description
int

hasCaptureEvent(string $event) : bool

Is a given capture event registered?

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
bool

hasEvent(string $event) : bool

Is a given event registered?

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
bool

hasExtraPlugin(string $plugin) : bool

Is a given extra plugin registered?

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
bool

hasPlugin(string $plugin) : bool

Is a given plugin registered?

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
bool

hasStyleSheet(string $styleSheet) : bool

Is a given stylesheet registered?

Parameters

Name	Type	Description
$styleSheet	string

Returns

Type	Description
bool

removeCaptureEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Remove a given capture event

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

removeEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Remove a given event

Parameters

Name	Type	Description
$event	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

removeExtraPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Remove a given extra plugin.

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

removePlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Remove a given plugin

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

removeStyleSheet(string $styleSheet) : \Zend_Dojo_Form_Element_Editor

Remove a single stylesheet

Parameters

Name	Type	Description
$styleSheet	string

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setCaptureEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Overwrite many capture events at once

Parameters

Name	Type	Description
$events	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setEditActionInterval(int $interval) : \Zend_Dojo_Form_Element_Editor

Set edit action interval

Parameters

Name	Type	Description
$interval	int

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Overwrite many events at once

Parameters

Name	Type	Description
$events	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setExtraPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Overwrite many extra plugins at once.

Parameters

Name	Type	Description
$plugins	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setFocusOnLoad(bool $flag) : \Zend_Dojo_Form_Element_Editor

Set focus on load flag

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setHeight(string | int $height) : \Zend_Dojo_Form_Element_Editor

Set editor height

Parameters

Name	Type	Description
$height	string \| int

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setInheritWidth(bool $flag) : \Zend_Dojo_Form_Element_Editor

Set whether or not to inherit parent's width

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setMinHeight(string | int $minHeight) : \Zend_Dojo_Form_Element_Editor

Set minimum height of editor

Parameters

Name	Type	Description
$minHeight	string \| int

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Overwrite many plugins at once

Parameters

Name	Type	Description
$plugins	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setStyleSheets(array $styleSheets) : \Zend_Dojo_Form_Element_Editor

Overwrite all stylesheets

Parameters

Name	Type	Description
$styleSheets	array

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

setUpdateInterval(int $interval) : \Zend_Dojo_Form_Element_Editor

Set update interval

Parameters

Name	Type	Description
$interval	int

Returns

Type	Description
\Zend_Dojo_Form_Element_Editor

Dojo/Form/Element/Editor.php

\Zend_Dojo_Form_Element_Editorjump to top

Properties

Methods

\Zend_Dojo_Form_Element_Editor
jump to top