Docs For Class OCSP

Description

class OCSP_FRMVIEW

author: Peter Krebs (pk) <pitlinz@users.sourceforge.net>
project: Open CSP-Management
since: pk-07-06-30
license: GNU Public License

Located in /db/forms/OCSP_FRMVIEW.phpclass (line 32)

Direct descendents

Class	Description
OCSP_FRMVIEW_LIST	class OCSP_FRMVIEW_LIST
OCSP_FRMVIEW_FORM	class OCSP_FRMVIEW_FORM

Variable Summary

string $btnIconSize

array $btnPos

array $btnTags

array $myBlocks

OCSP_FRMCONTR $myControl

array $myFields

OCSP_FORM $myForm

Method Summary

OCSP_FRMVIEW OCSP_FRMVIEW ( &$aForm, [boolean $debug = FALSE], OCSP_FORM $aForm)

array getBlocksMode (int $aMode, [boolean $debug = FALSE])

string getButtonImgTag (string $aCmd, [boolean $debug = FALSE])

OCSP_FRMCONTR getControl ()

OCSP_DB &getDBObj ([boolean $debug = FALSE])

array getFieldsMode (int $aMode, [boolean $debug = FALSE])

int getFrmMode ()

OCSP_FORM &getMyForm ()

array getPosButtons (int $pos)

void setButtonIconSize (string $aSize)

void setButtonImageTag (string $aCmd, string $imgTag)

void setButtonPos (string $aCmd, int $pos)

void setButtonTag (string $aCmd, string $imgTag)

void setControl ( &$aControl, OCSP_FRMCONTR $aControl)

void setControll ( &$aControl, OCSP_FRMCONTR $aControll)

void setFrmMode (int $mode)

void setMyForm ( &$aForm, OCSP_FORM $aForm)

void unsetBlocks ()

Variables

string $btnIconSize = "22x22" (line 88)

the default icon size

is used to select the icon dir

access: protected

Redefined in descendants as:

OCSP_FRMVIEW_LIST::$btnIconSize : the default icon size

array $btnPos = array() (line 80)

array with button positions

<0: left
>0: rigth

since: pk-08-06-02
access: protected

array $btnTags = array() (line 67)

an array of tags to show

$btnTags[CMDNAME]=TAGTMPL

access: protected

array $myBlocks = array() (line 50)

access: protected

OCSP_FRMCONTR $myControl (line 98)

access: protected

Redefined in descendants as:

OCSP_FRMVIEW_FORM::$myControl
: the control object

array $myFields = array() (line 56)

access: protected

OCSP_FORM $myForm = NULL (line 44)

access: protected

Methods

Constructor OCSP_FRMVIEW (line 108)

OCSP_FRMVIEW OCSP_FRMVIEW ( &$aForm, [boolean $debug = FALSE], OCSP_FORM $aForm)

OCSP_FORM $aForm
boolean $debug
&$aForm

getBlocksMode (line 226)

array getBlocksMode (int $aMode, [boolean $debug = FALSE])

int $aMode
boolean $debug

getButtonImgTag (line 390)

returns the buttion image tag

string getButtonImgTag (string $aCmd, [boolean $debug = FALSE])

string $aCmd
boolean $debug

getControl (line 161)

returns the control object

access: public

OCSP_FRMCONTR getControl ()

getDBObj (line 197)

returns the db object from the form

OCSP_DB &getDBObj ([boolean $debug = FALSE])

boolean $debug

getFieldsMode (line 256)

return: of DBMS_FIELDS

array getFieldsMode (int $aMode, [boolean $debug = FALSE])

int $aMode
boolean $debug

getFrmMode (line 174)

since: pk-05-11-04

int getFrmMode ()

getMyForm (line 121)

OCSP_FORM &getMyForm ()

getPosButtons (line 348)

returns the button commands on pos

access: public

array getPosButtons (int $pos)

int $pos

setButtonIconSize (line 293)

sets the button icon size

NOTE this is used to get icon path in sysimages

void setButtonIconSize (string $aSize)

string $aSize: (example "16x16")

setButtonImageTag (line 320)

sets the button tag

buttons are enclosed by an <a>-tag which does the function.

since: pk-08-11-24
access: public

void setButtonImageTag (string $aCmd, string $imgTag)

string $aCmd
string $imgTag

setButtonPos (line 331)

version: pk-08-06-02

void setButtonPos (string $aCmd, int $pos)

string $aCmd
int $pos

setButtonTag (line 305)

alias for setButtonImageTag

deprecated: since pk-08-11-24

void setButtonTag (string $aCmd, string $imgTag)

string $aCmd
string $imgTag

setControl (line 151)

sets the control object

access: public

void setControl ( &$aControl, OCSP_FRMCONTR $aControl)

OCSP_FRMCONTR $aControl
&$aControl

setControll (line 141)

alias for setControl

deprecated: since pk-08-12-03
access: public

void setControll ( &$aControl, OCSP_FRMCONTR $aControll)

OCSP_FRMCONTR $aControll
&$aControl

setFrmMode (line 182)

since: pk-05-11-04

void setFrmMode (int $mode)

int $mode

setMyForm (line 129)

void setMyForm ( &$aForm, OCSP_FORM $aForm)

OCSP_FORM $aForm
&$aForm

unsetBlocks (line 215)

unsets $this->myBlocks

void unsetBlocks ()