Zend Framework  1.12
Public Member Functions | Public Attributes | List of all members
Zend_Dojo_Form_Element_Editor Class Reference

Public Member Functions

 addCaptureEvent ($event)
 Add a single event to connect to the editing area.
 
 addCaptureEvents (array $events)
 Add multiple capture events.
 
 setCaptureEvents (array $events)
 Overwrite many capture events at once.
 
 getCaptureEvents ()
 Get all capture events.
 
 hasCaptureEvent ($event)
 Is a given capture event registered?
 
 removeCaptureEvent ($event)
 Remove a given capture event.
 
 clearCaptureEvents ()
 Clear all capture events.
 
 addEvent ($event)
 Add a single event to the dijit.
 
 addEvents (array $events)
 Add multiple events.
 
 setEvents (array $events)
 Overwrite many events at once.
 
 getEvents ()
 Get all events.
 
 hasEvent ($event)
 Is a given event registered?
 
 removeEvent ($event)
 Remove a given event.
 
 clearEvents ()
 Clear all events.
 
 addPlugin ($plugin)
 Add a single editor plugin.
 
 addPlugins (array $plugins)
 Add multiple plugins.
 
 setPlugins (array $plugins)
 Overwrite many plugins at once.
 
 getPlugins ()
 Get all plugins.
 
 hasPlugin ($plugin)
 Is a given plugin registered?
 
 removePlugin ($plugin)
 Remove a given plugin.
 
 clearPlugins ()
 Clear all plugins.
 
 setEditActionInterval ($interval)
 Set edit action interval.
 
 getEditActionInterval ()
 Get edit action interval; defaults to 3.
 
 setFocusOnLoad ($flag)
 Set focus on load flag.
 
 getFocusOnLoad ()
 Retrieve focus on load flag.
 
 setHeight ($height)
 Set editor height.
 
 getHeight ()
 Retrieve height.
 
 setInheritWidth ($flag)
 Set whether or not to inherit parent's width.
 
 getInheritWidth ()
 Whether or not to inherit the parent's width.
 
 setMinHeight ($minHeight)
 Set minimum height of editor.
 
 getMinHeight ()
 Get minimum height of editor.
 
 addStyleSheet ($styleSheet)
 Add a custom stylesheet.
 
 addStyleSheets (array $styleSheets)
 Add multiple custom stylesheets.
 
 setStyleSheets (array $styleSheets)
 Overwrite all stylesheets.
 
 getStyleSheets ()
 Get all stylesheets.
 
 hasStyleSheet ($styleSheet)
 Is a given stylesheet registered?
 
 removeStyleSheet ($styleSheet)
 Remove a single stylesheet.
 
 clearStyleSheets ()
 Clear all stylesheets.
 
 setUpdateInterval ($interval)
 Set update interval.
 
 getUpdateInterval ()
 Get update interval.
 
 addExtraPlugin ($plugin)
 Add a single editor extra plugin.
 
 addExtraPlugins (array $plugins)
 Add multiple extra plugins.
 
 setExtraPlugins (array $plugins)
 Overwrite many extra plugins at once.
 
 getExtraPlugins ()
 Get all extra plugins.
 
 hasExtraPlugin ($plugin)
 Is a given extra plugin registered?
 
 removeExtraPlugin ($plugin)
 Remove a given extra plugin.
 
 clearExtraPlugins ()
 Clear all extra plugins.
 
- Public Member Functions inherited from Zend_Dojo_Form_Element_Dijit
 __construct ($spec, $options=null)
 Constructor.
 
 setDijitParam ($key, $value)
 Set a dijit parameter.
 
 setDijitParams (array $params)
 Set multiple dijit params at once.
 
 hasDijitParam ($key)
 Does the given dijit parameter exist?
 
 getDijitParam ($key)
 Get a single dijit parameter.
 
 getDijitParams ()
 Retrieve all dijit parameters.
 
 removeDijitParam ($key)
 Remove a single dijit parameter.
 
 clearDijitParams ()
 Clear all dijit parameters.
 
 loadDefaultDecorators ()
 Load default decorators.
 
 setView (Zend_View_Interface $view=null)
 Set the view object.
 
- Public Member Functions inherited from Zend_Form_Element
 __construct ($spec, $options=null)
 Constructor.
 
 init ()
 Initialize object; used by extending classes.
 
 setDisableLoadDefaultDecorators ($flag)
 Set flag to disable loading default decorators.
 
 loadDefaultDecoratorsIsDisabled ()
 Should we load the default decorators?
 
 loadDefaultDecorators ()
 Load default decorators.
 
 setOptions (array $options)
 Set object state from options array.
 
 setConfig (Zend_Config $config)
 Set object state from Zend_Config object.
 
 setTranslator ($translator=null)
 Set translator object for localization.
 
 getTranslator ()
 Retrieve localization translator object.
 
 hasTranslator ()
 Does this element have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
 filterName ($value, $allowBrackets=false)
 Filter a name to only allow valid variable characters.
 
 setName ($name)
 Set element name.
 
 getName ()
 Return element name.
 
 getFullyQualifiedName ()
 Get fully qualified name.
 
 getId ()
 Get element id.
 
 setValue ($value)
 Set element value.
 
 getValue ()
 Retrieve filtered element value.
 
 getUnfilteredValue ()
 Retrieve unfiltered element value.
 
 setLabel ($label)
 Set element label.
 
 getLabel ()
 Retrieve element label.
 
 setOrder ($order)
 Set element order.
 
 getOrder ()
 Retrieve element order.
 
 setRequired ($flag=true)
 Set required flag.
 
 isRequired ()
 Is the element required?
 
 setAutoInsertNotEmptyValidator ($flag)
 Set flag indicating whether a NotEmpty validator should be inserted when element is required.
 
 autoInsertNotEmptyValidator ()
 Get flag indicating whether a NotEmpty validator should be inserted when element is required.
 
 setDescription ($description)
 Set element description.
 
 getDescription ()
 Retrieve element description.
 
 setAllowEmpty ($flag)
 Set 'allow empty' flag.
 
 getAllowEmpty ()
 Get 'allow empty' flag.
 
 setIgnore ($flag)
 Set ignore flag (used when retrieving values at form level)
 
 getIgnore ()
 Get ignore flag (used when retrieving values at form level)
 
 setIsArray ($flag)
 Set flag indicating if element represents an array.
 
 isArray ()
 Is the element representing an array?
 
 setBelongsTo ($array)
 Set array to which element belongs.
 
 getBelongsTo ()
 Return array name to which element belongs.
 
 getType ()
 Return element type.
 
 setAttrib ($name, $value)
 Set element attribute.
 
 setAttribs (array $attribs)
 Set multiple attributes at once.
 
 getAttrib ($name)
 Retrieve element attribute.
 
 getAttribs ()
 Return all attributes.
 
 setConcatJustValuesInErrorMessage ($concatJustValuesInErrorMessage)
 Use one error message for array elements with concatenated values.
 
 getConcatJustValuesInErrorMessage ()
 Use one error message for array elements with concatenated values.
 
 __get ($key)
 Overloading: retrieve object property.
 
 __set ($key, $value)
 Overloading: set object property.
 
 __call ($method, $args)
 Overloading: allow rendering specific decorators.
 
 setPluginLoader (Zend_Loader_PluginLoader_Interface $loader, $type)
 Set plugin loader to use for validator or filter chain.
 
 getPluginLoader ($type)
 Retrieve plugin loader for validator or filter chain.
 
 addPrefixPath ($prefix, $path, $type=null)
 Add prefix path for plugin loader.
 
 addPrefixPaths (array $spec)
 Add many prefix paths at once.
 
 addValidator ($validator, $breakChainOnFailure=false, $options=array())
 Add validator to validation chain.
 
 addValidators (array $validators)
 Add multiple validators.
 
 setValidators (array $validators)
 Set multiple validators, overwriting previous validators.
 
 getValidator ($name)
 Retrieve a single validator by name.
 
 getValidators ()
 Retrieve all validators.
 
 removeValidator ($name)
 Remove a single validator by name.
 
 clearValidators ()
 Clear all validators.
 
 isValid ($value, $context=null)
 Validate element value.
 
 addErrorMessage ($message)
 Add a custom error message to return in the event of failed validation.
 
 addErrorMessages (array $messages)
 Add multiple custom error messages to return in the event of failed validation.
 
 setErrorMessages (array $messages)
 Same as addErrorMessages(), but clears custom error message stack first.
 
 getErrorMessages ()
 Retrieve custom error messages.
 
 clearErrorMessages ()
 Clear custom error messages stack.
 
 getErrorMessageSeparator ()
 Get errorMessageSeparator.
 
 setErrorMessageSeparator ($separator)
 Set errorMessageSeparator.
 
 markAsError ()
 Mark the element as being in a failed validation state.
 
 addError ($message)
 Add an error message and mark element as failed validation.
 
 addErrors (array $messages)
 Add multiple error messages and flag element as failed validation.
 
 setErrors (array $messages)
 Overwrite any previously set error messages and flag as failed validation.
 
 hasErrors ()
 Are there errors registered?
 
 getErrors ()
 Retrieve validator chain errors.
 
 getMessages ()
 Retrieve error messages.
 
 addFilter ($filter, $options=array())
 Add a filter to the element.
 
 addFilters (array $filters)
 Add filters to element.
 
 setFilters (array $filters)
 Add filters to element, overwriting any already existing.
 
 getFilter ($name)
 Retrieve a single filter by name.
 
 getFilters ()
 Get all filters.
 
 removeFilter ($name)
 Remove a filter by name.
 
 clearFilters ()
 Clear all filters.
 
 setView (Zend_View_Interface $view=null)
 Set view object.
 
 getView ()
 Retrieve view object.
 
 addDecorator ($decorator, $options=null)
 Add a decorator for rendering the element.
 
 addDecorators (array $decorators)
 Add many decorators at once.
 
 setDecorators (array $decorators)
 Overwrite all decorators.
 
 getDecorator ($name)
 Retrieve a registered decorator.
 
 getDecorators ()
 Retrieve all decorators.
 
 removeDecorator ($name)
 Remove a single decorator.
 
 clearDecorators ()
 Clear all decorators.
 
 render (Zend_View_Interface $view=null)
 Render form element.
 
 __toString ()
 String representation of form element.
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

 $helper = 'Editor'
 
- Public Attributes inherited from Zend_Dojo_Form_Element_Dijit
 $dijitParams = array()
 
 $helper
 
- Public Attributes inherited from Zend_Form_Element
const DECORATOR = 'DECORATOR'
 Element Constants.
 
const FILTER = 'FILTER'
 
const VALIDATE = 'VALIDATE'
 
 $helper = 'formText'
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Form_Element
static resolveElementId (Zend_Form_Decorator_Interface $decorator)
 Used to resolve and return an element ID.
 
- Protected Member Functions inherited from Zend_Form_Element
 _filterValue (&$value, &$key)
 Filter a value.
 
 _getDecorator ($name, $options)
 Instantiate a decorator based on class name or class name fragment.
 
 _loadFilter (array $filter)
 Lazy-load a filter.
 
 _loadValidator (array $validator)
 Lazy-load a validator.
 
 _loadDecorator (array $decorator, $name)
 Lazy-load a decorator.
 
 _getErrorMessages ()
 Retrieve error messages and perform translation and value substitution.
 
 _hasErrorMessages ()
 Are there custom error messages registered?
 
- Protected Attributes inherited from Zend_Form_Element
 $_allowEmpty = true
 
 $_autoInsertNotEmptyValidator = true
 
 $_belongsTo
 
 $_decorators = array()
 
 $_description
 
 $_disableLoadDefaultDecorators = false
 
 $_errorMessages = array()
 
 $_errors = array()
 
 $_errorMessageSeparator = '; '
 
 $_filters = array()
 
 $_ignore = false
 
 $_isArray = false
 
 $_isError = false
 
 $_isErrorForced = false
 
 $_label
 
 $_loaders = array()
 
 $_messages = array()
 
 $_name
 
 $_order
 
 $_required = false
 
 $_translator
 
 $_translatorDisabled = false
 
 $_type
 
 $_validators = array()
 
 $_validatorRules = array()
 
 $_value
 
 $_view
 
 $_isPartialRendering = false
 
 $_concatJustValuesInErrorMessage = false
 

Member Function Documentation

addCaptureEvent (   $event)

Add a single event to connect to the editing area.

Parameters
string$event
Returns
Zend_Dojo_Form_Element_Editor
addCaptureEvents ( array  $events)

Add multiple capture events.

Parameters
array$events
Returns
Zend_Dojo_Form_Element_Editor
addEvent (   $event)

Add a single event to the dijit.

Parameters
string$event
Returns
Zend_Dojo_Form_Element_Editor
addEvents ( array  $events)

Add multiple events.

Parameters
array$events
Returns
Zend_Dojo_Form_Element_Editor
addExtraPlugin (   $plugin)

Add a single editor extra plugin.

Parameters
string$plugin
Returns
Zend_Dojo_Form_Element_Editor
addExtraPlugins ( array  $plugins)

Add multiple extra plugins.

Parameters
array$extraPlugins
Returns
Zend_Dojo_Form_Element_Editor
addPlugin (   $plugin)

Add a single editor plugin.

Parameters
string$plugin
Returns
Zend_Dojo_Form_Element_Editor
addPlugins ( array  $plugins)

Add multiple plugins.

Parameters
array$plugins
Returns
Zend_Dojo_Form_Element_Editor
addStyleSheet (   $styleSheet)

Add a custom stylesheet.

Parameters
string$styleSheet
Returns
Zend_Dojo_Form_Element_Editor
addStyleSheets ( array  $styleSheets)

Add multiple custom stylesheets.

Parameters
array$styleSheets
Returns
Zend_Dojo_Form_Element_Editor
clearCaptureEvents ( )

Clear all capture events.

Returns
Zend_Dojo_Form_Element_Editor
clearEvents ( )

Clear all events.

Returns
Zend_Dojo_Form_Element_Editor
clearExtraPlugins ( )

Clear all extra plugins.

Returns
Zend_Dojo_Form_Element_Editor
clearPlugins ( )

Clear all plugins.

Returns
Zend_Dojo_Form_Element_Editor
clearStyleSheets ( )

Clear all stylesheets.

Returns
Zend_Dojo_Form_Element_Editor
getCaptureEvents ( )

Get all capture events.

Returns
array
getEditActionInterval ( )

Get edit action interval; defaults to 3.

Returns
int
getEvents ( )

Get all events.

Returns
array
getExtraPlugins ( )

Get all extra plugins.

Returns
array
getFocusOnLoad ( )

Retrieve focus on load flag.

Returns
bool
getHeight ( )

Retrieve height.

Returns
string
getInheritWidth ( )

Whether or not to inherit the parent's width.

Returns
bool
getMinHeight ( )

Get minimum height of editor.

Returns
string
getPlugins ( )

Get all plugins.

Returns
array
getStyleSheets ( )

Get all stylesheets.

Returns
string
getUpdateInterval ( )

Get update interval.

Returns
int
hasCaptureEvent (   $event)

Is a given capture event registered?

Parameters
string$event
Returns
bool
hasEvent (   $event)

Is a given event registered?

Parameters
string$event
Returns
bool
hasExtraPlugin (   $plugin)

Is a given extra plugin registered?

Parameters
string$plugin
Returns
bool
hasPlugin (   $plugin)

Is a given plugin registered?

Parameters
string$plugin
Returns
bool
hasStyleSheet (   $styleSheet)

Is a given stylesheet registered?

Parameters
string$styleSheet
Returns
bool
removeCaptureEvent (   $event)

Remove a given capture event.

Parameters
string$event
Returns
Zend_Dojo_Form_Element_Editor
removeEvent (   $event)

Remove a given event.

Parameters
string$event
Returns
Zend_Dojo_Form_Element_Editor
removeExtraPlugin (   $plugin)

Remove a given extra plugin.

Parameters
string$plugin
Returns
Zend_Dojo_Form_Element_Editor
removePlugin (   $plugin)

Remove a given plugin.

Parameters
string$plugin
Returns
Zend_Dojo_Form_Element_Editor
removeStyleSheet (   $styleSheet)

Remove a single stylesheet.

Parameters
string$styleSheet
Returns
Zend_Dojo_Form_Element_Editor
setCaptureEvents ( array  $events)

Overwrite many capture events at once.

Parameters
array$events
Returns
Zend_Dojo_Form_Element_Editor
setEditActionInterval (   $interval)

Set edit action interval.

Parameters
int$interval
Returns
Zend_Dojo_Form_Element_Editor
setEvents ( array  $events)

Overwrite many events at once.

Parameters
array$events
Returns
Zend_Dojo_Form_Element_Editor
setExtraPlugins ( array  $plugins)

Overwrite many extra plugins at once.

Parameters
array$plugins
Returns
Zend_Dojo_Form_Element_Editor
setFocusOnLoad (   $flag)

Set focus on load flag.

Parameters
bool$flag
Returns
Zend_Dojo_Form_Element_Editor
setHeight (   $height)

Set editor height.

Parameters
string | int$height
Returns
Zend_Dojo_Form_Element_Editor
setInheritWidth (   $flag)

Set whether or not to inherit parent's width.

Parameters
bool$flag
Returns
Zend_Dojo_Form_Element_Editor
setMinHeight (   $minHeight)

Set minimum height of editor.

Parameters
string | int$minHeight
Returns
Zend_Dojo_Form_Element_Editor
setPlugins ( array  $plugins)

Overwrite many plugins at once.

Parameters
array$plugins
Returns
Zend_Dojo_Form_Element_Editor
setStyleSheets ( array  $styleSheets)

Overwrite all stylesheets.

Parameters
array$styleSheets
Returns
Zend_Dojo_Form_Element_Editor
setUpdateInterval (   $interval)

Set update interval.

Parameters
int$interval
Returns
Zend_Dojo_Form_Element_Editor

Member Data Documentation

$helper = 'Editor'