Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

ControlBox Class Reference

Inheritance diagram for ControlBox:

Inheritance graph
List of all members.

Detailed Description

A ControlContainer that can instantiate common controls.

A ControlBox is a container for ControlElements and has convenience methods for adding new controls to itself. This saves having to instantiate a control and add it to the container explicitly using ControlContainer::add().

Definition at line 159 of file controlbox.php.

Public Member Functions

 ControlBox ()
& addRadio ($id, $value)
 Add a RadioInput.

& addCheckbox ($id, $value)
 Add a CheckboxInput.

& addHidden ($id, $value)
 Add a HiddenInput.

& addText ($id, $value)
 Add a TextInput.

& addPassword ($id, $value)
 Add a PasswordInput.

& addTextarea ($id, $value)
 add a TextArea control

& addSubmit ($id, $value)
 Add a SubmitInput.

& addReset ($id, $value)
 Add a ResetInput.

& addImage ($id, $src=null)
 Add an ImageInput.

& addFile ($id)
 Add a FileInput.

& addSingleSelect ($id, $choice=null)
 Add a SingleSelect.

& addMultipleSelect ($id, $choice=null)
 Add a MultipleSelect.

& addRadioChoice ($id, $choice=null)
 Add a RadioChoice.

& addCheckboxChoice ($id, $choice=null)
 Add a CheckboxChoice.

Constructor & Destructor Documentation

ControlBox::ControlBox (   ) 
 

Definition at line 162 of file controlbox.php.

Member Function Documentation

& ControlBox::addCheckbox (  $  id,
$  value
) 
 

Add a CheckboxInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 187 of file controlbox.php.

& ControlBox::addCheckboxChoice (  $  id,
$  choice = null
) 
 

Add a CheckboxChoice.

Parameters:
$id an unique ID for the control
$choice an array specifying options; it is passed to CheckboxChoice constructor
Returns:
a reference to the instantiated control

Definition at line 354 of file controlbox.php.

& ControlBox::addFile (  $  id  ) 
 

Add a FileInput.

Parameters:
$id an unique ID for the control
Returns:
a reference to the instantiated control

Definition at line 298 of file controlbox.php.

& ControlBox::addHidden (  $  id,
$  value
) 
 

Add a HiddenInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 201 of file controlbox.php.

& ControlBox::addImage (  $  id,
$  src = null
) 
 

Add an ImageInput.

Parameters:
$id an unique ID for the control
$src the URL for an image
Returns:
a reference to the instantiated control

Definition at line 285 of file controlbox.php.

& ControlBox::addMultipleSelect (  $  id,
$  choice = null
) 
 

Add a MultipleSelect.

Parameters:
$id an unique ID for the control
$choice an array specifying options; it is passed to MultipleSelect constructor
Returns:
a reference to the instantiated control

Definition at line 326 of file controlbox.php.

& ControlBox::addPassword (  $  id,
$  value
) 
 

Add a PasswordInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 229 of file controlbox.php.

& ControlBox::addRadio (  $  id,
$  value
) 
 

Add a RadioInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 173 of file controlbox.php.

& ControlBox::addRadioChoice (  $  id,
$  choice = null
) 
 

Add a RadioChoice.

Parameters:
$id an unique ID for the control
$choice an array specifying options; it is passed to RadioChoice constructor
Returns:
a reference to the instantiated control

Definition at line 340 of file controlbox.php.

& ControlBox::addReset (  $  id,
$  value
) 
 

Add a ResetInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 271 of file controlbox.php.

& ControlBox::addSingleSelect (  $  id,
$  choice = null
) 
 

Add a SingleSelect.

Parameters:
$id an unique ID for the control
$choice an array specifying options; it is passed to SingleSelect constructor
Returns:
a reference to the instantiated control

Definition at line 312 of file controlbox.php.

& ControlBox::addSubmit (  $  id,
$  value
) 
 

Add a SubmitInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 257 of file controlbox.php.

& ControlBox::addText (  $  id,
$  value
) 
 

Add a TextInput.

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 215 of file controlbox.php.

& ControlBox::addTextarea (  $  id,
$  value
) 
 

add a TextArea control

Parameters:
$id an unique ID for the control
$value the value for the control
Returns:
a reference to the instantiated control

Definition at line 243 of file controlbox.php.

The documentation for this class was generated from the following file:
Generated on Mon Feb 14 11:39:51 2005 for FormControls by doxygen 1.3.5