API Documentation

Zend/Dojo/Form/Element/Editor.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Dojo  
Subpackage
Form_Element  
Version
$Id: Editor.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Dojo_Form_Element_Editor

Package: Zend\Dojo\Form\Element

Editor dijit

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

Properties

Propertypublicstring  $helper= ''Editor''

View helper
Default value'Editor'Details
Type
string

Methods

methodpublicaddCaptureEvent( 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
methodpublicaddCaptureEvents( 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
methodpublicaddEvent( 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
methodpublicaddEvents( array $events ) : \Zend_Dojo_Form_Element_Editor

Add multiple events

Parameters
Name Type Description
$events array
Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicaddPlugin( 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
methodpublicaddPlugins( array $plugins ) : \Zend_Dojo_Form_Element_Editor

Add multiple plugins

Parameters
Name Type Description
$plugins array
Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicaddStyleSheet( 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
methodpublicaddStyleSheets( 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
methodpublicclearCaptureEvents( ) : \Zend_Dojo_Form_Element_Editor

Clear all capture events

Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicclearEvents( ) : \Zend_Dojo_Form_Element_Editor

Clear all events

Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicclearPlugins( ) : \Zend_Dojo_Form_Element_Editor

Clear all plugins

Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicclearStyleSheets( ) : \Zend_Dojo_Form_Element_Editor

Clear all stylesheets

Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicgetCaptureEvents( ) : array

Get all capture events

Returns
Type Description
array
methodpublicgetEditActionInterval( ) : int

Get edit action interval; defaults to 3

Returns
Type Description
int
methodpublicgetEvents( ) : array

Get all events

Returns
Type Description
array
methodpublicgetFocusOnLoad( ) : bool

Retrieve focus on load flag

Returns
Type Description
bool
methodpublicgetHeight( ) : string

Retrieve height

Returns
Type Description
string
methodpublicgetInheritWidth( ) : bool

Whether or not to inherit the parent's width

Returns
Type Description
bool
methodpublicgetMinHeight( ) : string

Get minimum height of editor

Returns
Type Description
string
methodpublicgetPlugins( ) : array

Get all plugins

Returns
Type Description
array
methodpublicgetStyleSheets( ) : string

Get all stylesheets

Returns
Type Description
string
methodpublicgetUpdateInterval( ) : int

Get update interval

Returns
Type Description
int
methodpublichasCaptureEvent( string $event ) : bool

Is a given capture event registered?

Parameters
Name Type Description
$event string
Returns
Type Description
bool
methodpublichasEvent( string $event ) : bool

Is a given event registered?

Parameters
Name Type Description
$event string
Returns
Type Description
bool
methodpublichasPlugin( string $plugin ) : bool

Is a given plugin registered?

Parameters
Name Type Description
$plugin string
Returns
Type Description
bool
methodpublichasStyleSheet( string $styleSheet ) : bool

Is a given stylesheet registered?

Parameters
Name Type Description
$styleSheet string
Returns
Type Description
bool
methodpublicremoveCaptureEvent( 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
methodpublicremoveEvent( 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
methodpublicremovePlugin( 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
methodpublicremoveStyleSheet( 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
methodpublicsetCaptureEvents( 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
methodpublicsetEditActionInterval( 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
methodpublicsetEvents( 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
methodpublicsetFocusOnLoad( 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
methodpublicsetHeight( 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
methodpublicsetInheritWidth( 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
methodpublicsetMinHeight( 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
methodpublicsetPlugins( 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
methodpublicsetStyleSheets( array $styleSheets ) : \Zend_Dojo_Form_Element_Editor

Overwrite all stylesheets

Parameters
Name Type Description
$styleSheets array
Returns
Type Description
\Zend_Dojo_Form_Element_Editor
methodpublicsetUpdateInterval( int $interval ) : \Zend_Dojo_Form_Element_Editor

Set update interval

Parameters
Name Type Description
$interval int
Returns
Type Description
\Zend_Dojo_Form_Element_Editor
Documentation was generated by DocBlox 0.15.1.