Class STPHPCheckGroup

STPHPObject
   |
   --STPHPComponent
      |
      --STPHPTable
         |
         --STPHPControlWithCaption
            |
            --STPHPCheckGroup

Classes extended from STPHPCheckGroup:

Located in File: Program_Root/stphpcheckgroup.php


A class that represents a group of checkbox


Class Variable Summary
$check
The array of checkbox
Default Value: -><-
$numOfOptions
The number of checkbox
Default Value: -><-

Inherited Class Variable Summary
Inherited From Class STPHPControlWithCaption
Variable Default Value Description
$caption -><- The caption
$captionCell -><- The cell that contains the caption
$control -><- The pointer to the control component
$ctlCell -><- The cell that contains the control
Inherited From Class STPHPTable
Variable Default Value Description
$cells -><- The cells of the table (an array of STPHPTableCell objects)
$numOfCols -><- The number of cols of the table
$numOfRows -><- The number of rows of the table
$rows -><- The rows of the table (an array of STPHPTableRow objects)
Inherited From Class STPHPComponent
Variable Default Value Description
$attributes -><- The list of attributes
$components -><- The list of components
$configuration -><- The pointer to configuration XML node
$formParent -><- The form owner name
Inherited From Class STPHPObject
Variable Default Value Description
$name -><- The name of the object

Inherited Method Summary
Inherited From Class STPHPControlWithCaption
Function Description
constructor STPHPControlWithCaption ( [$name = ] ) Creates the object
dtor ( ) Destructor
prepareWrite ( ) Prepare the objects and attributes before the designing of the object.
setConfiguration ( $configuration ) Load the attributes from a STPHPXMLElement object
write ( ) Designs the object at runtime
Inherited From Class STPHPTable
Function Description
constructor STPHPTable ( [$name = ] ) Creates the object
addComponent ( &$component ) Adds a STPHPTableCell at the end of the components list
addComponentToCell ( $row, $col, &$component ) Adds a component directly to a cell
addRow ( ) Adds a new row to the table
addTextToCell ( $row, $col, $text ) Adds text to the specified cell
addVSpaceToCell ( $row, $col, $units ) Adds vertical spaces to the specified cell
appendComponent ( &$component ) Appends a STPHPTableRow at the end of the components list
appendComponentToCell ( $row, $col, &$component ) Appends a component directly to a cell
dtor ( ) Destructor
insertComponent ( &$component ) Inserts a STPHPTableRow at the beginning of the components list
insertComponentToCell ( $row, $col, &$component ) Inserts a component directly to a cell
prepare ( ) Prepare the table creating rows anc cells
setNumOfCols ( $cols ) Sets the number of cols
setNumOfRows ( $rows ) Sets the number of rows
write ( ) Designs the object at runtime
Inherited From Class STPHPComponent
Function Description
constructor STPHPComponent ( [$name = ] ) Creates the object
addCodeFile ( $file ) Adds a code file (Javascript)
addComponent ( &$component ) Adds a component at the end of the components list
addCssFile ( $file ) Adds a CSS file
addVSpace ( $units ) Adds vertical spaces
appendAttributes ( $attributes ) Appends an array of attributes at the current values
appendComponent ( &$component ) Appends a component at the end of the components list
attributeIsEmpty ( $key ) Returns if attribute is empty
dtor ( ) Destructor
getAttribute ( $key ) Gets the value of an attribute
getFormParent ( ) Returns the form owner name
getTranslatedAttribute ( $key ) Translate an attribute to the current language
insertComponent ( &$component ) Inserts a component at the beginning of the components list
setAttribute ( $key, $val ) Sets an attribute
setConfiguration ( &$configuration ) Load the attributes from a STPHPXMLElement object
setFormParent ( $form ) Sets the form owner name of the component (used by JS functions)
translateAttribute ( $key ) Set an attribute to its translated value
write ( ) Designs the object at runtime
Inherited From Class STPHPObject
Function Description
constructor STPHPObject ( [$name = ] ) Creates the object
dtor ( ) Destructor
errorLog ( $message ) Print an error to the log system
getName ( ) Returns the name of the object

Method Summary
STPHPCheckGroup constructor STPHPCheckGroup ( $name )
Creates the object
void dtor ( )
Destructor
void prepareCtrls ( )
Prepare the controls
void prepareWrite ( )
Prepare the objects and attributes before the designing of the object.
void setConfiguration ( $configuration )
Load the attributes from a STPHPXMLElement object
void setNumOfOptions ( $options )
Sets the number of checkboxes
Variable Detail

$check

Data type: STPHPCheckBoxWithCaption
The array of checkbox


$numOfOptions

Data type: integer
The number of checkbox



Method Detail

constructor STPHPCheckGroup

STPHPCheckGroup constructor STPHPCheckGroup ( $name )

Creates the object

Function Parameters:
- string $name:
Function Info:
Access - public

dtor

void dtor ( )

Overrides: STPHPControlWithCaption::dtor()

Destructor
Destroys all the resources associated with the object
Function Parameters:
Function Info:
Access - public

prepareCtrls

void prepareCtrls ( )

Prepare the controls

Function Parameters:
Function Info:
Access - private

prepareWrite

void prepareWrite ( )

Overrides: STPHPControlWithCaption::prepareWrite()

Prepare the objects and attributes before the designing of the object.
Called automatically by write() method.
Function Parameters:
Function Info:
Access - private

setConfiguration

void setConfiguration ( $configuration )

Overrides: STPHPControlWithCaption::setConfiguration()

Load the attributes from a STPHPXMLElement object

Function Parameters:
- STPHPXMLElement $configuration:
Function Info:
Access - public

setNumOfOptions

void setNumOfOptions ( $options )

Sets the number of checkboxes

Function Parameters:
- integer $options:
Function Info:
Access - public