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

Class: XoopsFormElement

Source Location: /class/xoopsform/formelement.php

Class Overview


Abstract base class for form elements


Author(s):

Copyright:

  • copyright (c) 2000-2003 XOOPS.org

Methods


Child classes:

XoopsFormTextArea
A textarea
XoopsGroupFormCheckBox
Renders checkbox options for a group permission form
XoopsFormSelect
A select field
XoopsFormHidden
A hidden field
XoopsFormLabel
A text label
XoopsFormRadio
A Group of radiobuttons
XoopsFormFile
A file upload field
XoopsFormPassword
A password field
XoopsFormText
A simple text field
XoopsFormButton
A button
XoopsFormElementTray
A group of form elements
XoopsFormCheckBox
One or more Checkbox(es)

Class Details

[line 51]
Abstract base class for form elements



Tags:

copyright:  copyright (c) 2000-2003 XOOPS.org
author:  Kazumi Ono <onokazu@xoops.org>


[ Top ]


Class Methods


constructor XoopsFormElement [line 110]

XoopsFormElement XoopsFormElement( )

constructor



[ Top ]

method getAccessKey [line 159]

string getAccessKey( )

get the "accesskey" attribute for the element



Tags:

return:  "accesskey" attribute value


[ Top ]

method getAccessString [line 168]

string getAccessString( string $str)

If the accesskey is found in the specified string, underlines it



Tags:

return:  Enhanced string with the 1st occurence of accesskey underlined


Parameters:

string   $str   String where to search the accesskey occurence

[ Top ]

method getCaption [line 212]

string getCaption( )

get the caption for the element



[ Top ]

method getClass [line 194]

string getClass( )

get the "class" attribute for the element



Tags:

return:  "class" attribute value


[ Top ]

method getDescription [line 230]

string getDescription( )

get the element's description



[ Top ]

method getExtra [line 275]

string getExtra( )

Get the extra attributes for the element



[ Top ]

method getName [line 139]

string getName( [bool $encode = true])

get the "name" attribute for the element



Tags:

return:  "name" attribute


Parameters:

bool   $encode   encode?

[ Top ]

method isContainer [line 119]

bool isContainer( )

Is this element a container of other elements?



Tags:

return:  false


Overridden in child classes as:

XoopsFormElementTray::isContainer()
Is this element a container of other elements?

[ Top ]

method isHidden [line 247]

bool isHidden( )

Find out if an element is "hidden".



[ Top ]

method render [line 287]

void render( )

Generates output for the element.

This method is abstract and must be overwritten by the child classes.




Tags:

abstract:  


Overridden in child classes as:

XoopsFormTextArea::render()
prepare HTML for output
XoopsFormDhtmlTextArea::render()
Prepare HTML for output
XoopsGroupFormCheckBox::render()
Renders checkbox options for this group
XoopsFormSelect::render()
Prepare HTML for output
XoopsFormHidden::render()
Prepare HTML for output
XoopsFormLabel::render()
Prepare HTML for output
XoopsFormRadio::render()
Prepare HTML for output
XoopsFormFile::render()
prepare HTML for output
XoopsFormPassword::render()
Prepare HTML for output
XoopsFormText::render()
Prepare HTML for output
XoopsFormTextDateSelect::render()
XoopsFormButton::render()
prepare HTML for output
XoopsFormElementTray::render()
prepare HTML to output this group
XoopsFormCheckBox::render()
prepare HTML for output

[ Top ]

method setAccessKey [line 151]

void setAccessKey( string $key)

set the "accesskey" attribute for the element



Parameters:

string   $key   "accesskey" attribute for the element

[ Top ]

method setCaption [line 203]

void setCaption( string $caption)

set the caption for the element



Parameters:

string   $caption  

[ Top ]

method setClass [line 181]

void setClass( mixed $class, string $key)

set the "class" attribute for the element



Parameters:

string   $key   "class" attribute for the element

[ Top ]

method setDescription [line 221]

void setDescription( string $description)

set the element's description



Parameters:

string   $description  

[ Top ]

method setExtra [line 261]

string setExtra( string $extra, [string $replace = false])

Add extra attributes to the element.

This string will be inserted verbatim and unvalidated in the element's tag. Know what you are doing!




Tags:

return:  New content of the extra string


Parameters:

string   $extra  
string   $replace   If true, passed string will replace current content otherwise it will be appended to it

[ Top ]

method setHidden [line 238]

void setHidden( )

flag the element as "hidden"



[ Top ]

method setName [line 129]

void setName( string $name)

set the "name" attribute for the element



Parameters:

string   $name   "name" attribute for the element

[ Top ]


Documentation generated on Fri, 03 Mar 2006 08:55:59 +0000 by phpDocumentor 1.3.0RC3