Class STPHPBtnImage

STPHPObject
   |
   --STPHPComponent
      |
      --STPHPTable
         |
         --STPHPControlWithCaption
            |
            --STPHPImageWithCaption
               |
               --STPHPBtnImage

Classes extended from STPHPBtnImage:

Located in File: Program_Root/stphpbtnimage.php


A class that represents a sophisticated button
It's possible to associate an image to a button and define a flat effect

Class Variable Summary

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 STPHPImageWithCaption
Function Description
constructor STPHPImageWithCaption ( [$name = ] ) Creates the object
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
STPHPForm constructor STPHPBtnImage ( $name )
Creates the object
void setConfiguration ( &$configuration )
Load the attributes from a STPHPXMLElement object
string write ( )
Designs the object at runtime
Variable Detail

Method Detail

constructor STPHPBtnImage

STPHPForm constructor STPHPBtnImage ( $name )

Creates the object

Function Parameters:
- string $name: the name of the form used in NAME tag
Function Info:
Access - public

setConfiguration

void setConfiguration ( &$configuration )

Load the attributes from a STPHPXMLElement object

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

write

string write ( )

Designs the object at runtime
Available attributes :
- VISIBLE : defines if the component must be designed or not
- FLAT : defines if the button has the flat appearance
- IMAGE : defines the image for the button (used when FLAT option is not active)
- IMAGE_ON : defines the image when the cursor is over the button (used when FLAT option is active)
- IMAGE_OFF : defines the image when the cursor is not over the button (used when FLAT option is active)
- IMAGE_DOWN : defines the image when the button is pressed
- CAPTION : defines the caption of the button
- LINK : defines the link for the button
- LINK_TARGET : defines the target for the link
- ONCLICK : defines the onclick event hook
- CLASS : defines the CSS class
Function Parameters:
Function Info:
Return - the code that represents the object at runtime
Access - private