Class P4A_Mask

Description
Description | Descendents | Vars (details) | Methods (details)

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

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

P4A_Object
   |
   --P4A_Mask
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class P4A_Mask_Error General errors mask.
class P4A_Mask_Preview Preview mask.
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
mixed $close_popup_button
mixed $data
DATA_BROWSER $data_browser
array $external_fields
array $fields
string $focus_object_id
mixed $is_popup
array $map_actions
string $sOpen
string $template_name
string $title
array $_css
mixed $_icon
mixed $_icon_size
array $_javascript
array $_temp_css
array $_temp_javascript
array $_temp_vars
array $_tpl_vars
Method Summary
Description | Descendants | Vars (details) | Methods (details)
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,  $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, [ $media = "screen"])
void dropJavascript (string $uri)
void dropTempCss (string $uri, [ $media = "screen"])
void dropTempJavascript (string $uri)
void dropTempVar (string $name)
void firstRow ()
void getAsString ([ $_template = false])
void getIcon ()
void getIconSize ()
void &getPrevMask ()
string getTemplateName ()
string getTitle ()
void init ()
void isPopup ([ $is_popup = NULL])
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 saveUploads ()
void setFocus ([object $object = null])
void setIcon ( $icon)
void setIconSize ( $size)
void &setSource (data_source &$data_source)
void setTitle (string $title)
void showPrevMask ()
void &singleton ( $name)
void unsetFocus ()
void useTemplate (string $template_name)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $close_popup_button = null (line 160)
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
string $focus_object_id = null (line 101)

The id of the object with active focus

  • access: private
mixed $is_popup = FALSE (line 155)
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
mixed $_icon = NULL (line 157)
mixed $_icon_size = 48 (line 158)
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::$_helpers
 P4A_Object::$_id
 P4A_Object::$_map_actions
 P4A_Object::$_name
 P4A_Object::$_objects
 P4A_Object::$_parent_id
Methods
Description | Descendents | Vars (details) Methods (details)
addCss (line 645)

Include CSS

  • access: public
void addCss (string $uri, [string $media = "screen"])
  • string $uri: The URI of CSS.
  • string $media: The CSS media.
addJavascript (line 713)

Include a javascript file

  • access: public
void addJavascript (string $uri)
  • string $uri: The URI of file.
addTempCss (line 675)

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 736)

Include a javascript file

These javascripts are removed after rendering

  • access: public
void addTempJavascript (string $uri)
  • string $uri: The URI of file.
addTempVar (line 768)

Add a temporary variable

  • access: public
void addTempVar (string $name,  $value)
  • string $name: The URI of file.
  • $value
clearTempCss (line 703)

Clear temporary CSS list

  • access: public
void clearTempCss ()
clearTempJavascript (line 758)

Clear temporary javascript list

  • access: public
void clearTempJavascript ()
clearTemplateVars (line 406)

Removes every template variable assigned.

  • access: public
void clearTemplateVars ()
clearTempVars (line 789)

Clear temporary vars list

  • access: public
void clearTempVars ()
deleteRow (line 557)

Deletes the currently pointed record.

  • access: public
void deleteRow ()
display (line 299)

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 310)

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 658)

Drop inclusion of CSS file

  • access: public
void dropCss (string $uri, [ $media = "screen"])
  • string $uri: The URI of CSS.
  • $media
dropJavascript (line 723)

Drop inclusion of javascript file

  • access: public
void dropJavascript (string $uri)
  • string $uri: The URI of CSS.
dropTempCss (line 689)

Drop inclusion of CSS file

These CSS are removed after rendering

  • access: public
void dropTempCss (string $uri, [ $media = "screen"])
  • string $uri: The URI of CSS.
  • $media
dropTempJavascript (line 747)

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 778)

Drop a temporary variable

  • access: public
void dropTempVar (string $name)
  • string $name: The URI of CSS.
firstRow (line 593)

Moves to the first row.

  • access: public
void firstRow ()
getAsString (line 351)

Return the output mask

void getAsString ([ $_template = false])
  • $_template
getIcon (line 799)
void getIcon ()
getIconSize (line 809)
void getIconSize ()
getPrevMask (line 256)

Get the caller mask.

  • access: public
void &getPrevMask ()
getTemplateName (line 283)

Returns the currently used template name.

  • access: public
string getTemplateName ()
getTitle (line 330)

Returns the title for the mask.

  • access: public
string getTitle ()
init (line 237)

Inizializes the mask.

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

  • access: private
void init ()
isPopup (line 201)
void isPopup ([ $is_popup = NULL])
  • $is_popup
lastRow (line 584)

Moves to the last row.

  • access: public
void lastRow ()
loadRow (line 436)

Loads the current record data.

  • access: public
void loadRow ([integer $num_row = NULL])
  • integer $num_row: The wanted row number.
main (line 339)

Prints out the mask.

  • access: public
void main ()
Redefined in descendants as:
maskClose (line 626)

Returns the closing code for the mask.

  • access: public
string maskClose ()
maskOpen (line 603)

Returns the opening code for the mask.

  • access: public
string maskOpen ()
newRow (line 548)

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 566)

Moves to the next row.

  • access: public
void nextRow ()
none (line 635)

Does nothing.

  • access: public
void none ()
p4a_mask (line 169)

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 575)

Moves to the previous row.

  • access: public
void prevRow ()
reloadRow (line 445)

Reloads data for the current record.

  • access: public
void reloadRow ()
saveRow (line 536)

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

  • throws: onFileSystemError
  • access: public
void saveRow ()
saveUploads (line 459)

Manages file uploads when arriving from HTTP POST

  • throws: onFileSystemError
  • access: private
void saveUploads ()
setFocus (line 214)

Sets the focus on object

  • access: public
void setFocus ([object $object = null])
  • object $object
setIcon (line 794)
void setIcon ( $icon)
  • $icon
setIconSize (line 804)
void setIconSize ( $size)
  • $size
setSource (line 418)

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 320)

Sets the title for the mask.

  • access: public
void setTitle (string $title)
  • string $title: Mask title.
showPrevMask (line 246)

Shows the caller mask.

  • access: public
void showPrevMask ()
singleton (line 190)
void &singleton ( $name)
  • $name
unsetFocus (line 227)

Removes focus property

  • access: public
void unsetFocus ()
useTemplate (line 267)

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::dropIntercept()
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()
P4A_Object::_loadHelper()
P4A_Object::__call()

Documentation generated on Mon, 07 Jan 2008 11:29:25 +0100 by phpDocumentor 1.4.0