Class: ChatChatView

Source Location: /chat/trunk/chat/views/chat.inc.php

Class Overview

View
   |
   --ChatChatView

View is a controller for part of an application. It receives events from guava and decices what to do with them.

Inherited Methods

Class: View

View::__construct(): You must call the constructor to initialize the sidenav variable.
View::addMenuItem()
View::close(): Must be provided by derived classes. This method is called whenever the user moves away from this view. You should clean up any variables or store them in QOLT to reduce session memory loadtime.
View::Disable()
View::disableRefresh(): Disables the view's refresh.
View::enableRefresh(): Enables this view's refresh and sets it's loop timer minimum. If processing during the loop takes longer than the refreshTimer, the framework will dynamically size the window.
View::getRefreshTimer(): This function will tell you if refresh is active, and what the base timer is set at.
View::getSideNav(): Returns the top NavNode object for the sidenav requested or all NavNodes if no sidenav is requested.
View::init(): Must be provided by derived classes. This method is called whenever the user switches to this view.
View::isDisabled()
View::isSideNavEnabled(): Ask the view if the side nav is enabled to be rendered.
View::menuCommand(): Need to declare in derived classes. This method is called whenever a menu option is selected.
View::menuCommandSelect(): Call this to tell the menu to select an option. This should be called in your menuCommand method.
View::menuListen(): Adds a menu item to the menu bar.
View::menuRender(): Called by the framework to render this view's menu.
View::printFooter()
View::printHeader()
View::printTarget(): Prints the target into the output buffer
View::refresh(): Must be provided by derived classes. This method is called whenever the page is refreshed by browser refresh or by AJAX calls.
View::removeTarget(): Removes the target from this view's target collection, specified by name.
View::removeTargets(): Removes all targets from the view's target collection.
View::render(): Must be provided by derived classes. This method is called whenever the view is asked to render into the main view frame.
View::sendTargets(): Called by AJAX requests to send the targets inside this view.
View::sideNavCreate(): Use to create a top level sidenav.
View::sideNavDestroy(): Destroy the sidenav requested.
View::sideNavDestroyAll(): Call if you want to destroy all sidenavs
View::sideNavEnable(): This function sets the sidenav for this view to render or not render.
View::sideNavRender(): Called by the framework to render this view's sidenavs.
View::targetData(): If the target with the name does not exist, it adds it to the target data collection of this view. If it does exist, it will update it's value and update flag.
View::tooltip()

Class Details

[line 75]
View is a controller for part of an application. It receives events from guava and decices what to do with them.

[ Top ]

Class Methods

constructor __construct [line 86]

ChatChatView __construct(
)

Overrides View::__construct() (You must call the constructor to initialize the sidenav variable.)

[ Top ]

method addMessage [line 241]

void addMessage(
mixed
$message, [mixed
$action = false])

Tags:

access:

public

[ Top ]

method close [line 275]

void close(
)

Tags:

access:

public

Overrides View::close() (Must be provided by derived classes. This method is called whenever the user moves away from this view. You should clean up any variables or store them in QOLT to reduce session memory loadtime.)

[ Top ]

method exitChat [line 153]

void exitChat(
mixed
$guavaObject, [mixed
$parameter = null])

Tags:

access:

public

[ Top ]

method init [line 237]

void init(
)

Tags:

access:

public

Overrides View::init() (Must be provided by derived classes. This method is called whenever the user switches to this view.)

[ Top ]

method inputHandle [line 252]

void inputHandle(
mixed
$guavaObject, [mixed
$parameter = null])

Tags:

access:

public

[ Top ]

method menuCommand [line 300]

void menuCommand(
mixed
$command)

Tags:

access:

public

Overrides View::menuCommand() (Need to declare in derived classes. This method is called whenever a menu option is selected.)

[ Top ]

method refresh [line 304]

void refresh(
)

Tags:

access:

public

Overrides View::refresh() (Must be provided by derived classes. This method is called whenever the page is refreshed by browser refresh or by AJAX calls.)

[ Top ]

method render [line 345]

void render(
)

Tags:

access:

public

Overrides View::render() (Must be provided by derived classes. This method is called whenever the view is asked to render into the main view frame.)

[ Top ]

method setNickname [line 157]

void setNickname(
mixed
$guavaObject, [mixed
$parameter = null])

Tags:

access:

public

[ Top ]

method unsetNickname [line 91]

void unsetNickname(
)

Tags:

access:

public

[ Top ]

Documentation generated on Wed, 21 Dec 2005 14:35:56 -0800 by phpDocumentor 1.3.0RC3