Class Trees Index phpDocumentor Project Page

Class XoopsFormElement

(line 50)
Classes extended from XoopsFormElement:
XoopsFormButton
A button
XoopsFormCheckBox
One or more Checkbox(es)
XoopsFormElementTray
A group of form elements
XoopsFormFile
A file upload field
XoopsFormHidden
A hidden field
XoopsFormLabel
A text label
XoopsFormPassword
A password field
XoopsFormRadio
A Group of radiobuttons
XoopsFormSelect
A select field
XoopsFormText
A simple text field
XoopsFormTextArea
A textarea

Located in File: Program_Root/class/xoopsform/formelement.php

Abstract base class for form elements

Class Variable Summary

Inherited Class Variable Summary

Method Summary

void

constructor XoopsFormElement ( )
constructor
string

getCaption ( )
get the caption for the element
string

getDescription ( )
get the element's description
string

getExtra ( )
Get the extra attributes for the element
string

getName ( [$encode = true] )
get the "name" attribute for the element
bool

isHidden ( )
Find out if an element is "hidden".
void

render ( )
Generate output for the form element.
void

setCaption ( $caption )
set the caption for the element
void

setDescription ( $description )
set the element's description
void

setExtra ( $extra )
Add extra attributes to the element.
void

setHidden ( )
flag the element as "hidden"
void

setName ( $name )
set the "name" attribute for the element

Inherited Method Summary

Method Detail

Constructor XoopsFormElement (line 97)

void

XoopsFormElement( )

constructor
Function Info:

[ Top ]

getCaption (line 137)

string

getCaption( )

get the caption for the element
Function Info:

[ Top ]

getDescription (line 155)

string

getDescription( )

get the element's description
Function Info:

[ Top ]

getExtra (line 193)

string

getExtra( )

Get the extra attributes for the element
Function Info:

[ Top ]

getName (line 116)

string

getName( [bool $encode = true])

get the "name" attribute for the element
Function Parameters:
- bool $encode: encode?
Function Info:
return - "name" attribute

[ Top ]

isHidden (line 172)

bool

isHidden( )

Find out if an element is "hidden".
Function Info:

[ Top ]

render (line 205)

void

render( )

Overridden in child classes as:

XoopsFormButton::render()
prepare HTML for output
XoopsFormCheckBox::render()
prepare HTML for output
XoopsFormElementTray::render()
prepare HTML to output this group
XoopsFormFile::render()
prepare HTML for output
XoopsFormHidden::render()
Prepare HTML for output
XoopsFormLabel::render()
Prepare HTML for output
XoopsFormPassword::render()
Prepare HTML for output
XoopsFormRadio::render()
Prepare HTML for output
XoopsFormSelect::render()
Prepare HTML for output
XoopsFormText::render()
Prepare HTML for output
XoopsFormTextArea::render()
prepare HTML for output

Generate output for the form element.

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

Function Info:
abstract -

[ Top ]

setCaption (line 128)

void

setCaption( string $caption)

set the caption for the element
Function Parameters:
- string $caption:
Function Info:

[ Top ]

setDescription (line 146)

void

setDescription( string $description)

set the element's description
Function Parameters:
- string $description:
Function Info:

[ Top ]

setExtra (line 184)

void

setExtra( string $extra)

Add extra attributes to the element.

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

Function Parameters:
- string $extra:
Function Info:

[ Top ]

setHidden (line 163)

void

setHidden( )

flag the element as "hidden"
Function Info:

[ Top ]

setName (line 106)

void

setName( string $name)

set the "name" attribute for the element
Function Parameters:
- string $name: "name" attribute for the element
Function Info:

[ Top ]

Variable Detail

Documention generated on Fri, 21 Feb 2003 02:07:24 +0100 by phpDocumentor 1.2.0rc1
proudly hosted at
SourceForge.net Logo