Class: PhpExt_Form_HtmlEditor

Source Location: /PhpExt/Form/HtmlEditor.php

Class PhpExt_Form_HtmlEditor

Class Overview

Provides a lightweight HTML Editor component.

Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT supported by this editor.

An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.

Located in /PhpExt/Form/HtmlEditor.php [line 26]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent
            |
            --PhpExt_Form_Field
               |
               --PhpExt_Form_HtmlEditor

Methods

[ 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_Form_Field

PhpExt_Form_Field::__construct()

PhpExt_Form_Field::getAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})

PhpExt_Form_Field::getClearCssClass()

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

PhpExt_Form_Field::getCssClass()

A CSS class to apply to the field's underlying element.

PhpExt_Form_Field::getDisabled()

True to disable the field (defaults to false).

PhpExt_Form_Field::getFieldCssClass()

The default CSS class for the field (defaults to "x-form-field")

PhpExt_Form_Field::getFieldLabel()

The label text to display next to this field (defaults to '')

PhpExt_Form_Field::getFocusCssClass()

The CSS class to use when the field receives focus (defaults to "x-form-focus")

PhpExt_Form_Field::getHideLabel()

True to completely hide the label element (defaults to false)

PhpExt_Form_Field::getInputType()

The type attribute for input fields -- e.g. radio, text, password (defaults to "text").

PhpExt_Form_Field::getInvalidCssClass()

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

PhpExt_Form_Field::getInvalidText()

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

PhpExt_Form_Field::getItemCssClass()

An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')

PhpExt_Form_Field::getLabelCssStyle()

A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.

PhpExt_Form_Field::getLabelSeparator()

The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.

PhpExt_Form_Field::getMsgFx()

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

PhpExt_Form_Field::getMsgTarget()

The location where error text should display. Should be one of the following values (defaults to 'qtip'):

PhpExt_Form_Field::getName()

The field's HTML name attribute.

PhpExt_Form_Field::getReadOnly()

True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.

PhpExt_Form_Field::getTabIndex()

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

PhpExt_Form_Field::getValidateOnBlur()

Whether the field should validate when it loses focus (defaults to true).

PhpExt_Form_Field::getValidationDelay()

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

PhpExt_Form_Field::getValidationEvent()

The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").

PhpExt_Form_Field::getValue()

A value to initialize this field with.

PhpExt_Form_Field::setAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})

PhpExt_Form_Field::setClearCssClass()

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

PhpExt_Form_Field::setCssClass()

A CSS class to apply to the field's underlying element.

PhpExt_Form_Field::setDisabled()

True to disable the field (defaults to false).

PhpExt_Form_Field::setFieldCssClass()

The default CSS class for the field (defaults to "x-form-field")

PhpExt_Form_Field::setFieldLabel()

The label text to display next to this field (defaults to '')

PhpExt_Form_Field::setFocusCssClass()

The CSS class to use when the field receives focus (defaults to "x-form-focus")

PhpExt_Form_Field::setHideLabel()

True to completely hide the label element (defaults to false)

PhpExt_Form_Field::setInputType()

The type attribute for input fields -- e.g. radio, text, password (defaults to "text").

PhpExt_Form_Field::setInvalidCssClass()

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

PhpExt_Form_Field::setInvalidText()

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

PhpExt_Form_Field::setItemCssClass()

An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')

PhpExt_Form_Field::setLabelCssStyle()

A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.

PhpExt_Form_Field::setLabelSeparator()

The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.

PhpExt_Form_Field::setMsgFx()

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

PhpExt_Form_Field::setMsgTarget()

The location where error text should display. Should be one of the following values (defaults to 'qtip'):

PhpExt_Form_Field::setName()

The field's HTML name attribute.

PhpExt_Form_Field::setReadOnly()

True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.

PhpExt_Form_Field::setTabIndex()

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

PhpExt_Form_Field::setValidateOnBlur()

Whether the field should validate when it loses focus (defaults to true).

PhpExt_Form_Field::setValidationDelay()

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

PhpExt_Form_Field::setValidationEvent()

The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").

PhpExt_Form_Field::setValue()

A value to initialize this field with.

Inherited From PhpExt_BoxComponent

PhpExt_BoxComponent::__construct()

PhpExt_BoxComponent::getAutoHeight()

True to use height:'auto', false to use fixed height (defaults to false).

PhpExt_BoxComponent::getAutoWidth()

True to use width:'auto', false to use fixed width (defaults to false).

PhpExt_BoxComponent::getHeight()

The height of this component in pixels (defaults to auto).

PhpExt_BoxComponent::getWidth()

The width of this component in pixels (defaults to auto).

PhpExt_BoxComponent::setAutoHeight()

True to use height:'auto', false to use fixed height (defaults to false).

PhpExt_BoxComponent::setAutoWidth()

True to use width:'auto', false to use fixed width (defaults to false).

PhpExt_BoxComponent::setHeight()

The height of this component in pixels (defaults to auto).

PhpExt_BoxComponent::setWidth()

The width of this component in pixels (defaults to auto).

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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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

static PhpExt_Form_HtmlEditor	createHtmlEditor()	Helper function to create an HtmlEditor. Useful for quick adding it to a ComponentCollection
PhpExt_Form_HtmlEditor	__construct()
string	getCreateLinkText()	The default text for the create link prompt
string	getDefaultLinkValue()	The default value for the create link prompt (defaults to http:/ /)
boolean	getEnableAlignments()	Enable the left, center, right alignment buttons (defaults to true)
boolean	getEnableColors()	Enable the fore/highlight color buttons (defaults to true)
boolean	getEnableFont()	Enable font selection. Not available in Safari. (defaults to true)
boolean	getEnableFontSize()	Enable the increase/decrease font size buttons (defaults to true)
boolean	getEnableFormat()	Enable the bold, italic and underline buttons (defaults to true)
boolean	getEnableLinks()	Enable the create link button. Not available in Safari. (defaults to true)
boolean	getEnableLists()	Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
boolean	getEnableSourceEdit()	Enable the switch to source edit button. Not available in Safari. (defaults to true)
array	getFontFamilies()	An array of available font families
PhpExt_Form_HtmlEditor	setCreateLinkText()	The default text for the create link prompt
PhpExt_Form_HtmlEditor	setDefaultLinkValue()	The default value for the create link prompt (defaults to http:/ /)
PhpExt_Form_HtmlEditor	setEnableAlignments()	Enable the left, center, right alignment buttons (defaults to true)
PhpExt_Form_HtmlEditor	setEnableColors()	Enable the fore/highlight color buttons (defaults to true)
PhpExt_Form_Ht	setEnableFont()	Enable font selection. Not available in Safari. (defaults to true)
PhpExt_Form_HtmlEditor	setEnableFontSize()	Enable the increase/decrease font size buttons (defaults to true)
PhpExt_Form_HtmlEditor	setEnableFormat()	Enable the bold, italic and underline buttons (defaults to true)
PhpExt_Form_HtmlEditor	setEnableLinks()	Enable the create link button. Not available in Safari. (defaults to true)
PhpExt_Form_HtmlEditor	setEnableLists()	Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
PhpExt_Form_HtmlEditor	setEnableSourceEdit()	Enable the switch to source edit button. Not available in Safari. (defaults to true)
PhpExt_Form_HtmlEditor	setFontFamilies()	An array of available font families. i.e. array("Arial","Verdana")

[ Top ]

Properties

Methods

static method createHtmlEditor [line 254]

static PhpExt_Form_HtmlEditor createHtmlEditor(
string
$name, [string
$label = null], [string
$id = null] 
)

Helper function to create an HtmlEditor. Useful for quick adding it to a ComponentCollection

Parameters:

string	$name:	The field's HTML name attribute.
string	$label:	The label text to display next to this field (defaults to '')
string	$id:	The unique id of this component (defaults to an auto-assigned id).

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 226]

PhpExt_Form_HtmlEditor __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Form_Field::__construct()

[ Top ]

getCreateLinkText [line 42]

string getCreateLinkText(
)

The default text for the create link prompt

API Tags:

Access:

public

[ Top ]

getDefaultLinkValue [line 60]

string getDefaultLinkValue(
)

The default value for the create link prompt (defaults to http:/ /)

API Tags:

Access:

public

[ Top ]

getEnableAlignments [line 78]

boolean getEnableAlignments(
)

Enable the left, center, right alignment buttons (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableColors [line 96]

boolean getEnableColors(
)

Enable the fore/highlight color buttons (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableFont [line 114]

boolean getEnableFont(
)

Enable font selection. Not available in Safari. (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableFontSize [line 132]

boolean getEnableFontSize(
)

Enable the increase/decrease font size buttons (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableFormat [line 150]

boolean getEnableFormat(
)

Enable the bold, italic and underline buttons (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableLinks [line 168]

boolean getEnableLinks(
)

Enable the create link button. Not available in Safari. (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableLists [line 186]

boolean getEnableLists(
)

Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableSourceEdit [line 204]

boolean getEnableSourceEdit(
)

Enable the switch to source edit button. Not available in Safari. (defaults to true)

API Tags:

Access:

public

[ Top ]

getFontFamilies [line 222]

array getFontFamilies(
)

An array of available font families

API Tags:

Access:

public

[ Top ]

setCreateLinkText [line 34]

PhpExt_Form_HtmlEditor setCreateLinkText(
string
$value 
)

The default text for the create link prompt

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDefaultLinkValue [line 52]

PhpExt_Form_HtmlEditor setDefaultLinkValue(
string
$value 
)

The default value for the create link prompt (defaults to http:/ /)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setEnableAlignments [line 70]

PhpExt_Form_HtmlEditor setEnableAlignments(
boolean
$value 
)

Enable the left, center, right alignment buttons (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableColors [line 88]

PhpExt_Form_HtmlEditor setEnableColors(
boolean
$value 
)

Enable the fore/highlight color buttons (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableFont [line 106]

PhpExt_Form_Ht setEnableFont(
boolean
$value 
)

Enable font selection. Not available in Safari. (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableFontSize [line 124]

PhpExt_Form_HtmlEditor setEnableFontSize(
boolean
$value 
)

Enable the increase/decrease font size buttons (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableFormat [line 142]

PhpExt_Form_HtmlEditor setEnableFormat(
boolean
$value 
)

Enable the bold, italic and underline buttons (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableLinks [line 160]

PhpExt_Form_HtmlEditor setEnableLinks(
boolean
$value 
)

Enable the create link button. Not available in Safari. (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableLists [line 178]

PhpExt_Form_HtmlEditor setEnableLists(
boolean
$value 
)

Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableSourceEdit [line 196]

PhpExt_Form_HtmlEditor setEnableSourceEdit(
boolean
$value 
)

Enable the switch to source edit button. Not available in Safari. (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setFontFamilies [line 214]

PhpExt_Form_HtmlEditor setFontFamilies(
array
$value 
)

An array of available font families. i.e. array("Arial","Verdana")

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:55:10 -0500 by phpDocumentor 1.4.0