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

Class: HTML_QuickForm_html_editor

Source Location: /main/inc/lib/formvalidator/Element/html_editor.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_textarea
         |
         --HTML_QuickForm_html_editor

A html editor field to use with QuickForm


Author(s):

Version:

  • 1.0

Variables

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm_textarea

HTML_QuickForm_textarea::HTML_QuickForm_textarea()
Class constructor
HTML_QuickForm_textarea::getFrozenHtml()
Returns the value of field without HTML tags (in this case, value is changed to a mask)
HTML_QuickForm_textarea::getName()
Returns the element name
HTML_QuickForm_textarea::getValue()
Returns the value of the form element
HTML_QuickForm_textarea::setCols()
Sets width in cols for textarea element
HTML_QuickForm_textarea::setName()
Sets the input field name
HTML_QuickForm_textarea::setRows()
Sets height in rows for textarea element
HTML_QuickForm_textarea::setValue()
Sets value for textarea element
HTML_QuickForm_textarea::setWrap()
Sets wrap type for textarea element
HTML_QuickForm_textarea::toHtml()
Returns the textarea element in HTML

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element()
Class constructor
HTML_QuickForm_element::accept()
Accepts a renderer
HTML_QuickForm_element::apiVersion()
Returns the current API version
HTML_QuickForm_element::exportValue()
Returns a 'safe' element's value
HTML_QuickForm_element::freeze()
Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml()
Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel()
Returns display text for the element
HTML_QuickForm_element::getName()
Returns the element name
HTML_QuickForm_element::getType()
Returns element type
HTML_QuickForm_element::getValue()
Returns the value of the form element
HTML_QuickForm_element::isFrozen()
Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent()
Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel()
Sets display text for the element
HTML_QuickForm_element::setName()
Sets the input field name
HTML_QuickForm_element::setPersistantFreeze()
Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue()
Sets the value of the form element
HTML_QuickForm_element::unfreeze()
Unfreezes the element so that it becomes editable
HTML_QuickForm_element::_findValue()
Tries to find the element value from the values array
HTML_QuickForm_element::_generateId()
Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData()
Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue()
Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common()
Class constructor
HTML_Common::apiVersion()
Returns the current API version
HTML_Common::display()
Displays the HTML to the screen
HTML_Common::getAttribute()
Returns the value of the given attribute
HTML_Common::getAttributes()
Returns the assoc array (default) or string of attributes
HTML_Common::getComment()
Returns the HTML comment
HTML_Common::getTabOffset()
Returns the tabOffset
HTML_Common::removeAttribute()
Removes an attribute
HTML_Common::setAttributes()
Sets the HTML attributes
HTML_Common::setComment()
Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd()
Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab()
Sets the string used to indent HTML
HTML_Common::setTabOffset()
Sets the tab offset
HTML_Common::toHtml()
Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes()
Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey()
Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString()
Returns an HTML formatted attribute string
HTML_Common::_getLineEnd()
Returns the lineEnd
HTML_Common::_getTab()
Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs()
Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes()
Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr()
Removes the given attribute from the given array
HTML_Common::_updateAttrArray()
Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 29]
A html editor field to use with QuickForm



Tags:

author:  Bertrand Mansion <bmansion@mamasam.com>
author:  Adam Daniel <adaniel1@eesus.jnj.com>
version:  1.0


[ Top ]


Class Variables

$fck_editor =

[line 35]


Type:   mixed


[ Top ]

$fullPage =

[line 34]

Full page


Type:   mixed


[ Top ]



Class Methods


constructor HTML_QuickForm_html_editor [line 42]

HTML_QuickForm_html_editor HTML_QuickForm_html_editor( [string $elementName = null], [string $elementLabel = null], [string $attributes = null])

Class constructor



Parameters:

string   $elementName   HTML editor name/id
string   $elementLabel   HTML editor label
string   $attributes   Attributes for the textarea

[ Top ]

method browserSupported [line 138]

boolean browserSupported( )

Check if the browser supports FCKeditor



Tags:

access:  public


[ Top ]

method build_FCKeditor [line 177]

void build_FCKeditor( )

Build this element using FCKeditor



[ Top ]

method getFrozenHtml [line 170]

string getFrozenHtml( )

Returns the htmlarea content in HTML



Overrides HTML_QuickForm_textarea::getFrozenHtml() (Returns the value of field without HTML tags (in this case, value is changed to a mask))

[ Top ]

method toHtml [line 146]

string toHtml( )

Return the HTML editor in HTML



Overrides HTML_QuickForm_textarea::toHtml() (Returns the textarea element in HTML)

[ Top ]


Documentation generated on Thu, 12 Jun 2008 13:39:59 -0500 by phpDocumentor 1.4.1