API Documentation

Dojo/Form/Element/Editor.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Dojo
subpackage
Form_Element
version
$Id: Editor.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Dojo_Form_Element_Editor

Description

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.

Zend_Dojo_Form_Element_Editor

Extends from
Zend_Dojo_Form_Element_Dijit
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Dojo
subpackage
Form_Element
uses
Zend_Dojo_Form_Element_Dijit
Properties
$helper
Methods
addCaptureEvent
addCaptureEvents
setCaptureEvents
getCaptureEvents
hasCaptureEvent
removeCaptureEvent
clearCaptureEvents
addEvent
addEvents
setEvents
getEvents
hasEvent
removeEvent
clearEvents
addPlugin
addPlugins
setPlugins
getPlugins
hasPlugin
removePlugin
clearPlugins
setEditActionInterval
getEditActionInterval
setFocusOnLoad
getFocusOnLoad
setHeight
getHeight
setInheritWidth
getInheritWidth
setMinHeight
getMinHeight
addStyleSheet
addStyleSheets
setStyleSheets
getStyleSheets
hasStyleSheet
removeStyleSheet
clearStyleSheets
setUpdateInterval
getUpdateInterval

Description

Editor dijit

Properties

$helper

string $helper = 'Editor'

Details

$helper
string
View helper
visibility
public
default
Editor
final
false
static
false

Methods

addCaptureEvent

addCaptureEvent( string $event ) : Zend_Dojo_Form_Element_Editor

Add a single event to connect to the editing area

Arguments
$event
string
Details
visibility
public
final
false
static
false

addCaptureEvents

addCaptureEvents( array $events ) : Zend_Dojo_Form_Element_Editor

Add multiple capture events

Arguments
$events
array
Details
visibility
public
final
false
static
false

addEvent

addEvent( string $event ) : Zend_Dojo_Form_Element_Editor

Add a single event to the dijit

Arguments
$event
string
Details
visibility
public
final
false
static
false

addEvents

addEvents( array $events ) : Zend_Dojo_Form_Element_Editor

Add multiple events

Arguments
$events
array
Details
visibility
public
final
false
static
false

addPlugin

addPlugin( string $plugin ) : Zend_Dojo_Form_Element_Editor

Add a single editor plugin

Arguments
$plugin
string
Details
visibility
public
final
false
static
false

addPlugins

addPlugins( array $plugins ) : Zend_Dojo_Form_Element_Editor

Add multiple plugins

Arguments
$plugins
array
Details
visibility
public
final
false
static
false

addStyleSheet

addStyleSheet( string $styleSheet ) : Zend_Dojo_Form_Element_Editor

Add a custom stylesheet

Arguments
$styleSheet
string
Details
visibility
public
final
false
static
false

addStyleSheets

addStyleSheets( array $styleSheets ) : Zend_Dojo_Form_Element_Editor

Add multiple custom stylesheets

Arguments
$styleSheets
array
Details
visibility
public
final
false
static
false

clearCaptureEvents

clearCaptureEvents( ) : Zend_Dojo_Form_Element_Editor

Clear all capture events

Details
visibility
public
final
false
static
false

clearEvents

clearEvents( ) : Zend_Dojo_Form_Element_Editor

Clear all events

Details
visibility
public
final
false
static
false

clearPlugins

clearPlugins( ) : Zend_Dojo_Form_Element_Editor

Clear all plugins

Details
visibility
public
final
false
static
false

clearStyleSheets

clearStyleSheets( ) : Zend_Dojo_Form_Element_Editor

Clear all stylesheets

Details
visibility
public
final
false
static
false

getCaptureEvents

getCaptureEvents( ) : array

Get all capture events

Output
array
Details
visibility
public
final
false
static
false

getEditActionInterval

getEditActionInterval( ) : int

Get edit action interval; defaults to 3

Output
int
Details
visibility
public
final
false
static
false

getEvents

getEvents( ) : array

Get all events

Output
array
Details
visibility
public
final
false
static
false

getFocusOnLoad

getFocusOnLoad( ) : bool

Retrieve focus on load flag

Output
bool
Details
visibility
public
final
false
static
false

getHeight

getHeight( ) : string

Retrieve height

Output
string
Details
visibility
public
final
false
static
false

getInheritWidth

getInheritWidth( ) : bool

Whether or not to inherit the parent's width

Output
bool
Details
visibility
public
final
false
static
false

getMinHeight

getMinHeight( ) : string

Get minimum height of editor

Output
string
Details
visibility
public
final
false
static
false

getPlugins

getPlugins( ) : array

Get all plugins

Output
array
Details
visibility
public
final
false
static
false

getStyleSheets

getStyleSheets( ) : string

Get all stylesheets

Output
string
Details
visibility
public
final
false
static
false

getUpdateInterval

getUpdateInterval( ) : int

Get update interval

Output
int
Details
visibility
public
final
false
static
false

hasCaptureEvent

hasCaptureEvent( string $event ) : bool

Is a given capture event registered?

Arguments
$event
string
Output
bool
Details
visibility
public
final
false
static
false

hasEvent

hasEvent( string $event ) : bool

Is a given event registered?

Arguments
$event
string
Output
bool
Details
visibility
public
final
false
static
false

hasPlugin

hasPlugin( string $plugin ) : bool

Is a given plugin registered?

Arguments
$plugin
string
Output
bool
Details
visibility
public
final
false
static
false

hasStyleSheet

hasStyleSheet( string $styleSheet ) : bool

Is a given stylesheet registered?

Arguments
$styleSheet
string
Output
bool
Details
visibility
public
final
false
static
false

removeCaptureEvent

removeCaptureEvent( string $event ) : Zend_Dojo_Form_Element_Editor

Remove a given capture event

Arguments
$event
string
Details
visibility
public
final
false
static
false

removeEvent

removeEvent( string $event ) : Zend_Dojo_Form_Element_Editor

Remove a given event

Arguments
$event
string
Details
visibility
public
final
false
static
false

removePlugin

removePlugin( string $plugin ) : Zend_Dojo_Form_Element_Editor

Remove a given plugin

Arguments
$plugin
string
Details
visibility
public
final
false
static
false

removeStyleSheet

removeStyleSheet( string $styleSheet ) : Zend_Dojo_Form_Element_Editor

Remove a single stylesheet

Arguments
$styleSheet
string
Details
visibility
public
final
false
static
false

setCaptureEvents

setCaptureEvents( array $events ) : Zend_Dojo_Form_Element_Editor

Overwrite many capture events at once

Arguments
$events
array
Details
visibility
public
final
false
static
false

setEditActionInterval

setEditActionInterval( int $interval ) : Zend_Dojo_Form_Element_Editor

Set edit action interval

Arguments
$interval
int
Details
visibility
public
final
false
static
false

setEvents

setEvents( array $events ) : Zend_Dojo_Form_Element_Editor

Overwrite many events at once

Arguments
$events
array
Details
visibility
public
final
false
static
false

setFocusOnLoad

setFocusOnLoad( bool $flag ) : Zend_Dojo_Form_Element_Editor

Set focus on load flag

Arguments
$flag
bool
Details
visibility
public
final
false
static
false

setHeight

setHeight( string|int $height ) : Zend_Dojo_Form_Element_Editor

Set editor height

Arguments
$height
stringint
Details
visibility
public
final
false
static
false

setInheritWidth

setInheritWidth( bool $flag ) : Zend_Dojo_Form_Element_Editor

Set whether or not to inherit parent's width

Arguments
$flag
bool
Details
visibility
public
final
false
static
false

setMinHeight

setMinHeight( string|int $minHeight ) : Zend_Dojo_Form_Element_Editor

Set minimum height of editor

Arguments
$minHeight
stringint
Details
visibility
public
final
false
static
false

setPlugins

setPlugins( array $plugins ) : Zend_Dojo_Form_Element_Editor

Overwrite many plugins at once

Arguments
$plugins
array
Details
visibility
public
final
false
static
false

setStyleSheets

setStyleSheets( array $styleSheets ) : Zend_Dojo_Form_Element_Editor

Overwrite all stylesheets

Arguments
$styleSheets
array
Details
visibility
public
final
false
static
false

setUpdateInterval

setUpdateInterval( int $interval ) : Zend_Dojo_Form_Element_Editor

Set update interval

Arguments
$interval
int
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.