wasp.gui
[ class tree: wasp.gui ] [ index: wasp.gui ] [ all elements ]

Class: UIModule

Source Location: /gui/UIModule.php

Class Overview


UI Module is a container for pages. The UI Module is designed to contain the display logic for a group of related pages.


Author(s):

  • brian.fioca@pangomedia.com

Variables

Constants

Methods


Child classes:

Wizard
Wizard is a primary control structure that acts as a UI module containing "Cards" that are progressively encountered by the user depending on programmed state transitions and user entries.

Class Details

[line 29]
UI Module is a container for pages. The UI Module is designed to contain the display logic for a group of related pages.

Created on Feb 22, 2005




Tags:

abstract:  
author:  brian.fioca@pangomedia.com
since:  0.5


[ Top ]


Class Variables

$_arContent = array()

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_oSession =

[line 35]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 43]

UIModule __construct( )



Overridden in child classes as:

Wizard::__construct()

[ Top ]

method addContent [line 86]

void addContent( Content $oContent)

add Content to this module - ex. a Page, or another Module



Tags:

access:  public


Parameters:

oContent   $oContent   content to be added to this module's draw logic

[ Top ]

method draw [line 104]

void draw( )

draws (by calling draw()) all Content that has been added to this Module



Tags:

access:  public


[ Top ]

method getContent [line 96]

array getContent( )

gets the array of all content added to this module



Tags:

return:  of content objects
access:  public


[ Top ]

method handleEvents [line 79]

void handleEvents( )

Method where Intra module event handling should go



Tags:

access:  protected
abstract:  


[ Top ]

method init [line 74]

void init( )

Method where module initialization code should go



Tags:

access:  protected
abstract:  


[ Top ]

method setLoginRequired [line 66]

void setLoginRequired( boRequired $boRequired)

Sets whether the user needs to be logged in to access this module.



Tags:

access:  protected


Parameters:

boRequired   $boRequired   flag for requiring login access

[ Top ]


Class Constants

USER =  'user'

[line 32]


[ Top ]



Documentation generated on Sun, 27 Nov 2005 13:15:59 -0500 by phpDocumentor 1.3.0RC3