## P4A_Mask

Description

The mask is the basic interface object wich contains all widgets and generically every displayed object.

- author: Andrea Giardina <andrea.giardina@crealabs.it>
- author: Fabrizio Balliano <fabrizio.balliano@crealabs.it>

Located in /p4a/objects/mask.php (line 45)

    P4A_Object
       |
       --P4A_Mask

Direct descendents

Class | Description
--- | ---
P4A_Mask_Error | General errors mask.
P4A_Mask_Image_Preview | Image preview mask.

Variable Summary
mixed $data
DATA_BROWSER $data_browser
array $external_fields
array $fields
object $focus_object
array $map_actions
string $sOpen
string $template_name
string $title
array $_css
array $_javascript
array $_temp_css
array $_temp_javascript
array $_temp_vars
array $_tpl_vars
Method Summary
void addCss (string $uri, [string $media = "screen"])
void addJavascript (string $uri)
void addTempCss (string $uri, [string $media = "screen"])
void addTempJavascript (string $uri)
void addTempVar (string $name, mixed $value)
void clearTempCss ()
void clearTempJavascript ()
void clearTemplateVars ()
void clearTempVars ()
void deleteRow ()
void display (string $variable, mixed &$object)
void displayText (string $variable, mixed $text)
void dropCss (string $uri)
void dropJavascript (string $uri)
void dropTempCss (string $uri)
void dropTempJavascript (string $uri)
void dropTempVar (string $name)
void firstRow ()
void &getPrevMask ()
string getTemplateName ()
string getTitle ()
void init ()
void lastRow ()
void loadRow ([integer $num_row = NULL])
void main ()
string maskClose ()
string maskOpen ()
void newRow ()
void nextRow ()
void none ()
void p4a_mask ([string $name = null])
void prevRow ()
void reloadRow ()
void saveRow ()
void setFocus (object &$object)
void setSource (data_source &$data_source)
void setTitle (string $title)
void showPrevMask ()
void &singleton (mixed $name)
void unsetFocus ()
void useTemplate (string $template_name)
Variables
mixed $data = NULL (line 52)

The mask's data source.

- access: public

DATA_BROWSER $data_browser = NULL (line 59)

The mask's data browser.

- access: public

array $external_fields = array() (line 73)

Store the external fields' object_id

- access: private

array $fields = null (line 66)

The fields collection

- access: public

object $focus_object = NULL (line 101)

The object with active focus

- access: private

array $map_actions = array() (line 80)

Keeps the association between actions events and actions.

- access: public

string $sOpen = NULL (line 94)

Stores opening code for form.

- access: private

string $template_name = NULL (line 108)

Currently used template name.

- access: private

string $title = NULL (line 87)

Mask's title.

- access: private

array $_css = array() (line 115)

CSS container.

- access: private

array $_javascript = array() (line 146)

javascript container.

- access: private

array $_temp_css = array() (line 131)

Temporary CSS container.

These CSS are rendered and removed

- access: private

array $_temp_javascript = array() (line 123)

Temporary javascript container.

These javascripts are rendered and removed

- access: private

array $_temp_vars = array() (line 139)

Temporary variables container.

These vars are usally in the templates, removed after main

- access: private

array $_tpl_vars = array() (line 153)

variables used for templates

- access: private

#### Inherited Variables

Inherited from P4A_Object

> P4A_Object::$_id
> P4A_Object::$_map_actions
> P4A_Object::$_name
> P4A_Object::$_objects
> P4A_Object::$_parent_id

Methods
addCss (line 621)

Include CSS

- access: public

void addCss (string $uri, [string $media = "screen"])

- string $uri: The URI of CSS.
- string $media: The CSS media.

addJavascript (line 689)

Include a javascript file

- access: public

void addJavascript (string $uri)

- string $uri: The URI of file.

addTempCss (line 651)

Include CSS

These CSS are removed after rendering

- access: public

void addTempCss (string $uri, [string $media = "screen"])

- string $uri: The URI of CSS.
- string $media: The CSS media.

addTempJavascript (line 712)

Include a javascript file

These javascripts are removed after rendering

- access: public

void addTempJavascript (string $uri)

- string $uri: The URI of file.

addTempVar (line 744)

Add a temporary variable

- access: public

void addTempVar (string $name, mixed $value)

- string $name: The URI of file.

clearTempCss (line 679)

Clear temporary CSS list

- access: public

void clearTempCss ()
clearTempJavascript (line 734)

Clear temporary javascript list

- access: public

void clearTempJavascript ()
clearTemplateVars (line 358)

Removes every template variable assigned.

- access: public

void clearTemplateVars ()
clearTempVars (line 765)

Clear temporary vars list

- access: public

void clearTempVars ()
deleteRow (line 501)

Deletes the currently pointed record.

- access: public

void deleteRow ()
display (line 273)

Tells the template engine to show an object as a variable.

$object will be shown in the $variable template zone.

- access: public

void display (string $variable, mixed &$object)

- string $variable: Variable name, stands for a template zone.
- mixed &$object: Widget or string, the value of the assignment.

displayText (line 284)

Tells the template engine to show a strng as a variable.

- access: public

void displayText (string $variable, mixed $text)

- string $variable: Variable name, stands for a template variable.
- mixed $text: String, the value of the assignment.

dropCss (line 634)

Drop inclusion of CSS file

- access: public

void dropCss (string $uri)

- string $uri: The URI of CSS.

dropJavascript (line 699)

Drop inclusion of javascript file

- access: public

void dropJavascript (string $uri)

- string $uri: The URI of CSS.

dropTempCss (line 665)

Drop inclusion of CSS file

These CSS are removed after rendering

- access: public

void dropTempCss (string $uri)

- string $uri: The URI of CSS.

dropTempJavascript (line 723)

Drop inclusion of javascript file

These javascripts are removed after rendering

- access: public

void dropTempJavascript (string $uri)

- string $uri: The URI of CSS.

dropTempVar (line 754)

Drop a temporary variable

- access: public

void dropTempVar (string $name)

- string $name: The URI of CSS.

firstRow (line 561)

Moves to the first row.

- access: public

void firstRow ()
getPrevMask (line 234)

Get the caller mask.

- access: public

void &getPrevMask ()
getTemplateName (line 261)

Returns the currently used template name.

- access: public

string getTemplateName ()
getTitle (line 304)

Returns the title for the mask.

- access: public

string getTitle ()
init (line 215)

Inizializes the mask.

It means that the 'init' function of the current mask's listener is called.

- access: private

void init ()
lastRow (line 544)

Moves to the last row.

- access: public

void lastRow ()
loadRow (line 386)

Loads the current record data.

- access: public

void loadRow ([integer $num_row = NULL])

- integer $num_row: The wanted row number.

main (line 313)

Prints out the mask.

- access: public

void main ()

Redefined in descendants as:

- P4A_Mask_Error::main()
- P4A_Mask_Image_Preview::main()

maskClose (line 602)

Returns the closing code for the mask.

- access: public

string maskClose ()
maskOpen (line 580)

Returns the opening code for the mask.

- access: public

string maskOpen ()
newRow (line 492)

Goes in "new row" modality.

This means that we prepare p4a for adding a new record to the data source wich is associated to the mask.

- access: public

void newRow ()
nextRow (line 510)

Moves to the next row.

- access: public

void nextRow ()
none (line 611)

Does nothing.

- access: public

void none ()
p4a_mask (line 162)

Mask constructor.

Generates unique ID for the object, istance a new SHEET for widget positioning and store itself into p4a application.

void p4a_mask ([string $name = null])

- string $name: Object name (identifier).

prevRow (line 527)

Moves to the previous row.

- access: public

void prevRow ()
reloadRow (line 395)

Reloads data for the current record.

- access: public

void reloadRow ()
saveRow (line 409)

Overwrites internal data with the data arriving from the submitted mask.

- throws: onFileSystemError
- access: public

void saveRow ()
setFocus (line 195)

Sets the focus on object

- access: public

void setFocus (object &$object)

- object &$object

setSource (line 370)

Associates a data source with the mask.

Also set the data structure to allow correct widget rendering. Also moves to the first row of the data source.

- access: public

void setSource (data_source &$data_source)

- data_source &$data_source

setTitle (line 294)

Sets the title for the mask.

- access: public

void setTitle (string $title)

- string $title: Mask title.

showPrevMask (line 224)

Shows the caller mask.

- access: public

void showPrevMask ()
singleton (line 179)
void &singleton (mixed $name)
unsetFocus (line 204)

Removes focus property

- access: public

void unsetFocus ()
useTemplate (line 245)

Tells the mask that we're going to use a template.

- access: public

void useTemplate (string $template_name)

- string $template_name: "template name" stands for "template name.tpl" in the "CURRENT THEME\masks\" directory.

#### Inherited Methods

Inherited From P4A_Object

> P4A_Object::actionHandler()
> P4A_Object::build()
> P4A_Object::destroy()
> P4A_Object::errorHandler()
> P4A_Object::getId()
> P4A_Object::getName()
> P4A_Object::getObjectType()
> P4A_Object::getParentID()
> P4A_Object::implementMethod()
> P4A_Object::intercept()
> P4A_Object::isActionTriggered()
> P4A_Object::p4a_object()
> P4A_Object::setName()
> P4A_Object::setParentID()
> P4A_Object::void()

Documentation generated on Fri, 26 May 2006 12:43:23 +0200 by phpDocumentor 1.3.0RC5