PhpExt : [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Editor

Source Location: /PhpExt/Editor.php

Class PhpExt_Editor

Descendants
Child Class Description
PhpExt_GridEditor A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.
PhpExt_TreeEditor A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Component

PhpExt_Component::$_layoutData
PhpExt_Component::$_ownerCollection
PhpExt_Component::$_plugins
PhpExt_Component::$_xType

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName
PhpExt_Object::$_extConfigProperties
PhpExt_Object::$_validExtConfigProperties
PhpExt_Object::$_varName

Inherited From PhpExt_Component

PhpExt_Component::__construct()
** Overrides ***
PhpExt_Component::getAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::getApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
PhpExt_Component::getAutoShow()
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
PhpExt_Component::getConfigParams()
PhpExt_Component::getContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::getCssClass()
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
PhpExt_Component::getCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::getDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::getEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::getHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::getHideParent()
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.
PhpExt_Component::getId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::getLayoutData()
PhpExt_Component::getOwnerCollection()
PhpExt_Component::getPlugins()
An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.
PhpExt_Component::getRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
PhpExt_Component::render()
** Ext Object Methods ***
PhpExt_Component::setAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::setApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
PhpExt_Component::setAutoShow()
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
PhpExt_Component::setContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::setCssClass()
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
PhpExt_Component::setCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::setDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::setEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::setExtClassInfo()
PhpExt_Component::setHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::setHideParent()
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.
PhpExt_Component::setId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::setLayoutData()
Layout specific properties for the corresponding layout of the container.
PhpExt_Component::setOwnerCollection()
PhpExt_Component::setRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()
PhpExt_Observable::attachListener()
Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.
PhpExt_Observable::getConfigParams()
PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()
PhpExt_Object::addValidConfigProperties()
PhpExt_Object::createMethodSignature()
PhpExt_Object::getConfigParams()
PhpExt_Object::getExtConfigProperty()
PhpExt_Object::getJavascript()
PhpExt_Object::getMethodInvokeStm()
PhpExt_Object::isExtObject()
PhpExt_Object::paramToString()
PhpExt_Object::setExtClassInfo()
PhpExt_Object::setExtConfigProperty()
PhpExt_Object::__get()
PhpExt_Object::__set()

Inherited From PhpExt_Component

PhpExt_Component::HIDE_MODE_DISPLAY
PhpExt_Component::HIDE_MODE_OFFSETS
PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]
Method Summary
PhpExt_Editor   __construct()  
string   getAlignment()   The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").
string|boolean   getAutoSize()   True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "height" to adopt the height only (defaults to false)
boolean   getCancelOnEsc()   True to cancel the edit when the escape key is pressed (defaults to false)
boolean   getCompleteOnEnter()   True to complete the edit when the enter key is pressed (defaults to false)
boolean   getContrain()   True to constrain the editor to the viewport
PhpExt_Form_Field   getField()   A PhpExt_Form_Field object (or descendant) to use as editor
boolean   getHideElement()   False to keep the bound element visible while the editor is displayed (defaults to true)
boolean   getIgnoreNoChange()   True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed (defaults to false). Applies only to string values - edits for other data types will never be ignored.
void   getJavascript()  
boolean   getRevertInvalid()   True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true)
string   getShadow()   PhpExt_Shadow::MODE_SIDES for sides/bottom only, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_FRAME)
boolean   getSwallowKeys()   Handle the keydown/keypress events so they don't propagate (defaults to true)
boolean   getUpdateElement()   True to update the innerHTML of the bound element when the update completes (defaults to false)
mixed   getValue()   The data value of the underlying field (defaults to "")
PhpExt_Editor   setAlignment()   The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").
PhpExt_Editor   setAutoSize()   True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "height" to adopt the height only (defaults to false)
PhpExt_Editor   setCancelOnEsc()   True to cancel the edit when the escape key is pressed (defaults to false)
PhpExt_Editor   setCompleteOnEnter()   True to complete the edit when the enter key is pressed (defaults to false)
PhpExt_Editor   setContrain()   True to constrain the editor to the viewport
PhpExt_Editor   setHideElement()   False to keep the bound element visible while the editor is displayed (defaults to true)
PhpExt_Editor   setIgnoreNoChange()   True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed (defaults to false). Applies only to string values - edits for other data types will never be ignored.
PhpExt_Editor   setRevertInvalid()   True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true)
PhpExt_Editor   setShadow()   PhpExt_Shadow::MODE_SIDES for sides/bottom only, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_FRAME)
PhpExt_Editor   setSwallowKeys()   Handle the keydown/keypress events so they don't propagate (defaults to true)
PhpExt_Editor   setUpdateElement()   True to update the innerHTML of the bound element when the update completes (defaults to false)
PhpExt_Editor   setValue()   The data value of the underlying field (defaults to "")

[ Top ]
Properties
PhpExt_Form_Field   $_field = null [line 245]
API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 257]

  PhpExt_Editor __construct( PhpExt_Form_Field $field  )

Parameters:
PhpExt_Form_Field   $field:  A PhpExt_Form_Field object (or descendant) to use as editor

API Tags:
Access:  public


Redefinition of:
PhpExt_Component::__construct()
** Overrides ***

Redefined in descendants as:

[ Top ]
getAlignment  [line 39]

  string getAlignment( )

The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").


API Tags:
Access:  public


[ Top ]
getAutoSize  [line 57]

  string|boolean getAutoSize( )

True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "height" to adopt the height only (defaults to false)


API Tags:
Access:  public


[ Top ]
getCancelOnEsc  [line 75]

  boolean getCancelOnEsc( )

True to cancel the edit when the escape key is pressed (defaults to false)


API Tags:
Access:  public


[ Top ]
getCompleteOnEnter  [line 93]

  boolean getCompleteOnEnter( )

True to complete the edit when the enter key is pressed (defaults to false)


API Tags:
Access:  public


[ Top ]
getContrain  [line 111]

  boolean getContrain( )

True to constrain the editor to the viewport


API Tags:
Access:  public


[ Top ]
getField  [line 250]

  PhpExt_Form_Field getField( )

A PhpExt_Form_Field object (or descendant) to use as editor


API Tags:
Access:  public


[ Top ]
getHideElement  [line 129]

  boolean getHideElement( )

False to keep the bound element visible while the editor is displayed (defaults to true)


API Tags:
Access:  public


[ Top ]
getIgnoreNoChange  [line 147]

  boolean getIgnoreNoChange( )

True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed (defaults to false). Applies only to string values - edits for other data types will never be ignored.


API Tags:
Access:  public


[ Top ]
getJavascript  [line 280]

  void getJavascript( [ $lazy = false], [ $varName = null]  )

Parameters:
   $lazy: 
   $varName: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Object::getJavascript()

Redefined in descendants as:

[ Top ]
getRevertInvalid  [line 165]

  boolean getRevertInvalid( )

True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true)


API Tags:
Access:  public


[ Top ]
getShadow  [line 183]

  string getShadow( )

PhpExt_Shadow::MODE_SIDES for sides/bottom only, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_FRAME)


API Tags:
Access:  public


[ Top ]
getSwallowKeys  [line 201]

  boolean getSwallowKeys( )

Handle the keydown/keypress events so they don't propagate (defaults to true)


API Tags:
Access:  public


[ Top ]
getUpdateElement  [line 219]

  boolean getUpdateElement( )

True to update the innerHTML of the bound element when the update completes (defaults to false)


API Tags:
Access:  public


[ Top ]
getValue  [line 237]

  mixed getValue( )

The data value of the underlying field (defaults to "")


API Tags:
Access:  public


[ Top ]
setAlignment  [line 31]

  PhpExt_Editor setAlignment( string $value  )

The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setAutoSize  [line 49]

  PhpExt_Editor setAutoSize( string|boolean $value  )

True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "height" to adopt the height only (defaults to false)

Parameters:
string|boolean   $value: 

API Tags:
Access:  public


[ Top ]
setCancelOnEsc  [line 67]

  PhpExt_Editor setCancelOnEsc( boolean $value  )

True to cancel the edit when the escape key is pressed (defaults to false)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setCompleteOnEnter  [line 85]

  PhpExt_Editor setCompleteOnEnter( boolean $value  )

True to complete the edit when the enter key is pressed (defaults to false)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setContrain  [line 103]

  PhpExt_Editor setContrain( boolean $value  )

True to constrain the editor to the viewport

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setHideElement  [line 121]

  PhpExt_Editor setHideElement( boolean $value  )

False to keep the bound element visible while the editor is displayed (defaults to true)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setIgnoreNoChange  [line 139]

  PhpExt_Editor setIgnoreNoChange( boolean $value  )

True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed (defaults to false). Applies only to string values - edits for other data types will never be ignored.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setRevertInvalid  [line 157]

  PhpExt_Editor setRevertInvalid( boolean $value  )

True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setShadow  [line 175]

  PhpExt_Editor setShadow( string $value  )

PhpExt_Shadow::MODE_SIDES for sides/bottom only, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_FRAME)

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setSwallowKeys  [line 193]

  PhpExt_Editor setSwallowKeys( boolean $value  )

Handle the keydown/keypress events so they don't propagate (defaults to true)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setUpdateElement  [line 211]

  PhpExt_Editor setUpdateElement( boolean $value  )

True to update the innerHTML of the bound element when the update completes (defaults to false)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setValue  [line 229]

  PhpExt_Editor setValue( mixed $value  )

The data value of the underlying field (defaults to "")

Parameters:
mixed   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:53:01 -0500 by phpDocumentor 1.4.0