Docs For Class theme

Description

The MainWindowAction is an abstract class that provides a standard way of setting up and executing an action in the main window of the application. It provides a structure for accessing various parts of this main window, as well as delegating the implementation of some methods to decendent classes.

copyright: Copyright © 2005, Middlebury College
version: $Id: MainWindowAction.class.php,v 1.13 2007/09/19 14:04:41 adamfranco Exp $

Located in /polyphony/main/modules/gui/theme_editor.act.php (line 30)

Action
   |
   --WizardAction
      |
      --MainWindowAction
         |
         --theme_editorAction

Method Summary

void addAnEditingStep (mixed $wizard, mixed $name, mixed $arr, mixed $info, mixed $font, mixed $bg, mixed $text)

void addIFrame (mixed $theStep)

boolean buildContent ()

object Wizard createWizard ()

string getHeadingText ()

string getReturnUrl ()

void getTheme ()

string getUnauthorizedMessage ()

void globalStepCallBack (mixed $step)

void handleStepChange (mixed $source, mixed $context)

void handleUpdate (mixed $source, mixed $context)

boolean isAuthorizedToExecute ()

boolean isAuthorizedToTemplate ()

void resetToBeginning (mixed $wizard)

boolean saveWizard (string $cacheName)

Variables

Inherited Variables

Inherited from MainWindowAction

MainWindowAction::$_actionRows

Methods

addAnEditingStep (line 698)

void addAnEditingStep (mixed $wizard, mixed $name, mixed $arr, mixed $info, mixed $font, mixed $bg, mixed $text)

addIFrame (line 584)

This adds an iframe to the page that previews the frame, plus a button to refresh the view

since: 8/8/06
access: public

void addIFrame (mixed $theStep)

buildContent (line 155)

Build the content for this action

since: 4/26/05
access: public

boolean buildContent ()

Redefinition of:

MainWindowAction::buildContent(): Build the content for this action.

createWizard (line 174)

Create a new Wizard for this action. Caching of this Wizard is handled by getWizard() and does not need to be implemented here.

since: 4/28/05
access: public

object Wizard createWizard ()

Redefinition of:

WizardAction::createWizard(): Create a new Wizard for this action. Caching of this Wizard is handled by getWizard() and does not need to be implemented here.

getHeadingText (line 144)

Return the heading text for this action, or an empty string.

since: 4/26/05
access: public

string getHeadingText ()

Redefinition of:

Action::getHeadingText(): Return the heading text for this action, or an empty string.

getReturnUrl (line 741)

Return the URL that this action should return to when completed.

since: 4/28/05
access: public

string getReturnUrl ()

Redefinition of:

WizardAction::getReturnUrl(): Return the URL that this action should return to when completed.

getTheme (line 748)

void getTheme ()

getUnauthorizedMessage (line 133)

Return the "unauthorized" string to pring <em>Note: I think that's supposed to mean print--Tim</em>

since: 4/26/05
access: public

string getUnauthorizedMessage ()

Redefinition of:

Action::getUnauthorizedMessage(): Answer the message to print when the user is not authorized to execute this action

globalStepCallBack (line 627)

void globalStepCallBack (mixed $step)

handleStepChange (line 678)

This gives the wizard control after each change in step and tells which the previous and current steps are.

since: 6/1/06
access: public

void handleStepChange (mixed $source, mixed $context)

handleUpdate (line 620)

since: 6/1/06
access: public

void handleUpdate (mixed $source, mixed $context)

isAuthorizedToExecute (line 95)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

isAuthorizedToTemplate (line 114)

Check Authorizations For Templating

since: 4/26/05
access: public

boolean isAuthorizedToTemplate ()

resetToBeginning (line 729)

This is the all important function that gives the Wizard control after all of its components have been updated since the last pagelaod

since: 6/1/06
access: public

void resetToBeginning (mixed $wizard)

saveWizard (line 556)

Save our results. Tearing down and unsetting the Wizard is handled by in runWizard() and does not need to be implemented here.

return: TRUE if save was successful and tear-down/cleanup of the Wizard should ensue.
since: 4/28/05
access: public

boolean saveWizard (string $cacheName)

string $cacheName

Redefinition of:

WizardAction::saveWizard(): Save our results. Tearing down and unsetting the Wizard is handled by in runWizard() and does not need to be implemented here.

Inherited Methods

Inherited From MainWindowAction

MainWindowAction::buildContent()
MainWindowAction::execute()
MainWindowAction::getActionRows()

Inherited From WizardAction

WizardAction::cancelWizard()
WizardAction::cleanCacheName()
WizardAction::closeWizard()
WizardAction::createWizard()
WizardAction::getReturnUrl()
WizardAction::getWizard()
WizardAction::runWizard()
WizardAction::saveWizard()

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()

Class theme_editorAction

Inherited Variables

Inherited Methods