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

Class: XoopsFormElementTray

Source Location: /class/xoopsform/formelementtray.php

Class Overview

XoopsFormElement
   |
   --XoopsFormElementTray

A group of form elements


Author(s):

Copyright:

  • copyright (c) 2000-2003 XOOPS.org

Variables

Methods


Child classes:

XoopsFormDateTime
Date and time selection field

Inherited Methods

Class: XoopsFormElement

XoopsFormElement::XoopsFormElement()
constructor
XoopsFormElement::getAccessKey()
get the "accesskey" attribute for the element
XoopsFormElement::getAccessString()
If the accesskey is found in the specified string, underlines it
XoopsFormElement::getCaption()
get the caption for the element
XoopsFormElement::getClass()
get the "class" attribute for the element
XoopsFormElement::getDescription()
get the element's description
XoopsFormElement::getExtra()
Get the extra attributes for the element
XoopsFormElement::getName()
get the "name" attribute for the element
XoopsFormElement::isContainer()
Is this element a container of other elements?
XoopsFormElement::isHidden()
Find out if an element is "hidden".
XoopsFormElement::render()
Generates output for the element.
XoopsFormElement::setAccessKey()
set the "accesskey" attribute for the element
XoopsFormElement::setCaption()
set the caption for the element
XoopsFormElement::setClass()
set the "class" attribute for the element
XoopsFormElement::setDescription()
set the element's description
XoopsFormElement::setExtra()
Add extra attributes to the element.
XoopsFormElement::setHidden()
flag the element as "hidden"
XoopsFormElement::setName()
set the "name" attribute for the element

Class Details

[line 50]
A group of form elements



Tags:

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


[ Top ]


Class Variables

$_required = array()

[line 63]

required elements


Type:   array


[ Top ]



Class Methods


constructor XoopsFormElementTray [line 78]

XoopsFormElementTray XoopsFormElementTray( string $caption, [mixed $delimeter = " "], [mixed $name = ""], string $delimiter)

constructor



Parameters:

string   $caption   Caption for the group.
string   $delimiter   HTML to separate the elements

[ Top ]

method addElement [line 99]

void addElement( mixed &$formElement, [mixed $required = false], object &$element)

Add an element to the group



Parameters:

object   &$element   XoopsFormElement to add

[ Top ]

method getDelimeter [line 157]

string getDelimeter( )

Get the delimiter of this group



Tags:

return:  The delimiter


[ Top ]

method getElements [line 130]

array &getElements( [bool $recurse = false])

Get an array of the elements in this group



Tags:

return:  Array of XoopsFormElement objects.


Parameters:

bool   $recurse   get elements recursively?

[ Top ]

method getRequired [line 119]

array &getRequired( )

get an array of "required" form elements



Tags:

return:  array of XoopsFormElements


[ Top ]

method isContainer [line 89]

bool isContainer( )

Is this element a container of other elements?



Tags:

return:  true


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

[ Top ]

method render [line 166]

string render( )

prepare HTML to output this group



Tags:

return:  HTML output


Overrides XoopsFormElement::render() (Generates output for the element.)

[ Top ]


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