Class form_memofield

Description

Memo Field class A field which renders a textarea form element. These are used to allow people to input large tracts of text by typing or copy/paste.

Located in /form-defs.php (line 1552)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --form_field
            |
            --form_textfield
               |
               --form_memofield
Direct descendents
Class Description
 class form_wysiwygfield Wysiwyg Field class A field which renders a textarea form element as a Wysiwyg editor.
Variable Summary
 mixed $rows
 mixed $wrapmode
Method Summary
 form_memofield form_memofield ([string $name = ""], [string $label = ""], [string $value = ""], [boolean $editable = EDITABLE], [string $css = ""], [integer $width = STD_WIDTH], [integer $rows = 5], [string $wrapmode = "virtual"])
 string html ([mixed $name = ""])
 void set_rows (integer $rows)
 void set_wrapmode ([string $mode = "virtual"])
Variables
Methods
Constructor form_memofield (line 1571)

Constructor Create a field object. Sets basic field attributes.

form_memofield form_memofield ([string $name = ""], [string $label = ""], [string $value = ""], [boolean $editable = EDITABLE], [string $css = ""], [integer $width = STD_WIDTH], [integer $rows = 5], [string $wrapmode = "virtual"])
  • string $name: The name of the field
  • string $label: The label which can be displayed alongside the field
  • string $value: The value of the field
  • boolean $editable: Editability: EDITABLE or DISPLAY_ONLY (true or false)
  • string $css: CSS class or style to apply to the button
  • integer $width: Width of the memo field in characters
  • integer $rows: Height of the memo field in lines
  • string $wrapmode: Wrapping mode: 'virtual', 'physical', or 'off'
html (line 1591)

This renders the field as HTML.

string html ([mixed $name = ""])

Redefinition of:
form_textfield::html()
This renders the field as HTML.

Redefined in descendants as:
set_rows (line 1622)

Set the number of rows for this memo field.

void set_rows (integer $rows)
  • integer $rows: The number of rows for this memo field.
set_wrapmode (line 1582)

Set the wrap mode for the textarea.

void set_wrapmode ([string $mode = "virtual"])
  • string $mode: Wrapping mode: 'virtual', 'physical', or 'off'

Inherited Methods

Inherited From form_textfield

 form_textfield::form_textfield()
 form_textfield::html()
 form_textfield::set_format()
 form_textfield::set_width()
 form_textfield::wml()

Inherited From form_field

 form_field::form_field()
 form_field::as_displayonly()
 form_field::as_hiddenfield()
 form_field::disable_autocomplete()
 form_field::setlabel()
 form_field::setvalue()
 form_field::set_displayonly()

Inherited From HTMLObject

 HTMLObject::HTMLObject()
 HTMLObject::inherit_attributes()
 HTMLObject::setaccesskey()
 HTMLObject::setalign()
 HTMLObject::setalt()
 HTMLObject::setbackground()
 HTMLObject::setbgcolor()
 HTMLObject::setborder()
 HTMLObject::setcolor()
 HTMLObject::setheight()
 HTMLObject::sethspace()
 HTMLObject::setlang()
 HTMLObject::setlangdir()
 HTMLObject::setname()
 HTMLObject::setsize()
 HTMLObject::setsrc()
 HTMLObject::settabindex()
 HTMLObject::settarget()
 HTMLObject::settitle()
 HTMLObject::setvalign()
 HTMLObject::setvspace()
 HTMLObject::setwidth()
 HTMLObject::set_attribute()
 HTMLObject::set_linkover_text()
 HTMLObject::set_onblur()
 HTMLObject::set_onchange()
 HTMLObject::set_onclick()
 HTMLObject::set_ondblclick()
 HTMLObject::set_onfocus()
 HTMLObject::set_onkeydown()
 HTMLObject::set_onkeypress()
 HTMLObject::set_onkeyup()
 HTMLObject::set_onload()
 HTMLObject::set_onmousedown()
 HTMLObject::set_onmousemove()
 HTMLObject::set_onmouseout()
 HTMLObject::set_onmouseover()
 HTMLObject::set_onmouseup()
 HTMLObject::set_onselect()
 HTMLObject::set_tabindex()
 HTMLObject::taghtml()

Inherited From StylableObject

 StylableObject::StylableObject()
 StylableObject::clearstyle()
 StylableObject::setclass()
 StylableObject::setcss()
 StylableObject::setid()
 StylableObject::setstyle()

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3