STPHPObject | --STPHPComponent
Located in File: Program_Root/stphpcomponent.php
stphplib
Roberto Gerola <roberto.gerola@speedtech.it>
0.8
Class Variable Summary |
$attributes
The list of attributes Default Value:
|
$components
The list of components Default Value:
|
$configuration
The pointer to configuration XML node Default Value:
|
$formParent
The form owner name Default Value:
|
Inherited Class Variable Summary | ||||||
Inherited From Class STPHPObject
|
Inherited Method Summary | ||||||||||
Inherited From Class STPHPObject
|
Method Summary |
STPHPComponent constructor STPHPComponent ( $name )
Creates the object |
void addCodeFile ( $file )
Adds a code file (Javascript) |
void addComponent ( &$component )
Adds a component at the end of the components list |
void addCssFile ( $file )
Adds a CSS file |
void addVSpace ( $units )
Adds vertical spaces |
void appendAttributes ( $attributes )
Appends an array of attributes at the current values |
void appendComponent ( &$component )
Appends a component at the end of the components list |
bool attributeIsEmpty ( $key )
Returns if attribute is empty |
void dtor ( )
Destructor |
string getAttribute ( $key )
Gets the value of an attribute |
string getFormParent ( )
Returns the form owner name |
string getTranslatedAttribute ( $key )
Translate an attribute to the current language |
void insertComponent ( &$component )
Inserts a component at the beginning of the components list |
void setAttribute ( $key, $val )
Sets an attribute |
void setConfiguration ( &$configuration )
Load the attributes from a STPHPXMLElement object |
void setFormParent ( $form )
Sets the form owner name of the component (used by JS functions) |
void translateAttribute ( $key )
Set an attribute to its translated value |
string write ( )
Designs the object at runtime |
Variable Detail |
private
private
STPHPXmlElement
private
private
Method Detail |
STPHPComponent constructor STPHPComponent ( $name )
Creates the object- string $name: the name of the form used in NAME tag
public
void addCodeFile ( $file )
Overridden in child class(es) as: STPHPWindow::addCodeFile()
- string &$file: The file to add
public
void addComponent ( &$component )
Overridden in child class(es) as: STPHPTable::addComponent(), STPHPTableRow::addComponent()
- STPHPComponent &$component: The component to add
public
void addCssFile ( $file )
Overridden in child class(es) as: STPHPWindow::addCssFile()
- string &$file: The file to add
public
void addVSpace ( $units )
Adds vertical spaces- integer &$units: The number of spaces
public
void appendAttributes ( $attributes )
Appends an array of attributes at the current values- array $attributes: The attributes to append
public
void appendComponent ( &$component )
Overridden in child class(es) as: STPHPTable::appendComponent(), STPHPTableRow::appendComponent()
- STPHPComponent &$component: The component to add
public
bool attributeIsEmpty ( $key )
Returns if attribute is empty- string $key: The key of the attribute
TRUE if attribute is empty, FALSE otherwise
public
void dtor ( )
Overridden in child class(es) as: STPHPForm::dtor(), STPHPSpacer::dtor(), STPHPListbox::dtor(), STPHPTable::dtor(), STPHPWindow::dtor()
Overrides: STPHPObject::dtor()
DestructorDestroys all the resources associated with the object
public
string getAttribute ( $key )
Gets the value of an attribute- string $key: The key of the attribute
The value of the attribute
public
string getFormParent ( )
Returns the form owner nameThe name of form
public
string getTranslatedAttribute ( $key )
Translate an attribute to the current language- string $key: The key of the attribute
$key The translated value of the attribute
public
void insertComponent ( &$component )
Overridden in child class(es) as: STPHPTable::insertComponent(), STPHPTableRow::insertComponent()
- STPHPComponent &$component: the component to add
public
void setAttribute ( $key, $val )
Sets an attribute- string $key: The key of the attribute
- string $val: The value of the attribute
public
void setConfiguration ( &$configuration )
Overridden in child class(es) as: STPHPListbox::setConfiguration()
- STPHPXmlElement $configuration:
public
void setFormParent ( $form )
Sets the form owner name of the component (used by JS functions)- string $attributes: The name of form
public
void translateAttribute ( $key )
Set an attribute to its translated value- string $key: The key of the attribute
public
string write ( )
Overridden in child class(es) as: STPHPLabel::write(), STPHPCheckBox::write(), STPHPButton::write(), STPHPImage::write(), STPHPRichButton::write(), STPHPForm::write(), STPHPSpacer::write(), STPHPEdit::write(), STPHPListbox::write(), STPHPHR::write(), STPHPTable::write(), STPHPRadioButton::write(), STPHPTableCell::write(), STPHPTableRow::write(), STPHPTextArea::write(), STPHPWindow::write()
A null string
private