Building wizards using atkWizard - Revision history

Bahati at 09:57, 11 March 2011

2011-03-11T09:57:47Z

← Older revision		Revision as of 09:57, 11 March 2011
Line 1:		Line 1:
	{{howto\|Advanced\|[[Maurice Maas]] ~~<maurice at ibuildings dot nl>~~}}		{{howto\|Advanced\|[[Maurice Maas]]}}

bahtiar: Added syntax highlighting and some fixes of classnames.

2008-08-06T07:07:14Z

Added syntax highlighting and some fixes of classnames.

← Older revision		Revision as of 07:07, 6 August 2008
Line 1:		Line 1:
	{{howto\|~~Easy~~\|[[Maurice Maas]] <maurice@ibuildings.nl>}}		{{howto\|Advanced\|[[Maurice Maas]] <maurice at ibuildings dot nl>}}


	==Preface==		==Preface==
	~~AtkWizard~~ is special controller (extends ~~AtkController~~) which can help you to create a simple wizard. This wizard will contain wizardpanels which are maped to ~~a AtkNode~~. First thing to keep in mind is that the atkWizard executes the actions directly after choosing to continue to the next wizardpanel. It will not collect actions up untill you finish. It won't even reverse actions automatically if you choose to cancel the wizard.		The [[atkWizard]] class is special controller (extends [[atkController]]) which can help you to create a simple wizard. This wizard will contain wizardpanels which are maped to an [[atkNode]]. First thing to keep in mind is that the atkWizard executes the actions directly after choosing to continue to the next wizardpanel. It will not collect actions up untill you finish. It won't even reverse actions automatically if you choose to cancel the wizard.

	==Wizard example==		==Wizard example==
Line 12:		Line 12:

	Code:		Code:
			<syntaxhighlight lang="php">
	atkimport("atk.wizard.atkwizard");		atkimport("atk.wizard.atkwizard");
	atkimport("atk.wizard.atkwizardpanel");		atkimport("atk.wizard.atkwizardpanel");
Line 45:		Line 45:
	}		}
	}		}
			</syntaxhighlight>

	Make an instance of atkWizardTest and start the wizard. Mind you that the atkWizard class extends atkController.		Make an instance of atkWizardTest and start the wizard. Mind you that the atkWizard class extends atkController.
Line 51:		Line 51:
	Code:		Code:

			<syntaxhighlight lang="php">
	atkimport("atk.atkcontroller");		atkimport("atk.atkcontroller");
	$wizard = &atkcontroller::createInstance("atkWizardTest");		$wizard = atkcontroller::createInstance("atkWizardTest");
	$wizard->setMode(WIZARD_MODE_ADD);		$wizard->setMode(WIZARD_MODE_ADD);
	$wizard->handleRequest();		$wizard->handleRequest();
			</syntaxhighlight>

	==Output==		==Output==
	If you are using the ~~AtkWizard~~ in a default ~~Atk~~ application environment, the HTML will be outputted by atkOutput. The default handleRequest of atkController will do the following, where $screen is the HTML content:		If you are using the atkWizard in a default ATK application environment, the HTML will be outputted by atkOutput. The default handleRequest of atkController will do the following, where $screen is the HTML content:

			<syntaxhighlight lang="php">
	$output = &atkOutput::getInstance();		$output = &atkOutput::getInstance();
	$output->output($screen);		$output->output($screen);
			</syntaxhighlight>

	When you are using the ~~AtkWizard~~ from another environment and you don't want to use atkOutput to display the html. You could use the method setReturnOutput(boolean) to have the output returned to you be string, when calling the handleRequest method of atkWizard. You can use the method setPageFlags(flag) to influence the return output. You might not want a HEAD section of BODY tags returned, but only the wizardpanel form.		When you are using the atkWizard from another environment and you don't want to use atkOutput to display the html. You could use the method setReturnOutput(boolean) to have the output returned to you be string, when calling the handleRequest method of atkWizard. You can use the method setPageFlags(flag) to influence the return output. You might not want a HEAD section of BODY tags returned, but only the wizardpanel form.

bahtiar: Using atkwizard moved to Building wizards using atkWizard

2008-08-06T07:03:51Z

Using atkwizard moved to Building wizards using atkWizard

← Older revision	Revision as of 07:03, 6 August 2008
(No difference)

Maurice: New page: {{howto|Easy|Maurice Maas }} ==Preface== AtkWizard is special controller (extends AtkController) which can help you to create a simple wizard. This wizard will...

2008-05-19T22:39:50Z

New page: {{howto|Easy|Maurice Maas <maurice@ibuildings.nl>}} ==Preface== AtkWizard is special controller (extends AtkController) which can help you to create a simple wizard. This wizard will...

New page

{{howto|Easy|[[Maurice Maas]] <maurice@ibuildings.nl>}}

==Preface==
AtkWizard is special controller (extends AtkController) which can help you to create a simple wizard. This wizard will contain wizardpanels which are maped to a AtkNode. First thing to keep in mind is that the atkWizard executes the actions directly after choosing to continue to the next wizardpanel. It will not collect actions up untill you finish. It won't even reverse actions automatically if you choose to cancel the wizard.

==Wizard example==

This wizard example will have two wizardpanels. First wizardpanel will show an add form of the atknode company.departement. The second wizardpanel will show an add form of company.employee. Both classes are not added in the example code.

Create a wizard class:

Code:

atkimport("atk.wizard.atkwizard");
atkimport("atk.wizard.atkwizardpanel");
atkimport("atk.utils.atkactionlistener");

class atkWizardTest extends atkWizard
{
function atkWizardTest()
{
$this->atkWizard();

$sitePanel = new atkWizardPanel($this, "Departement", "company.departement");
$sitePanel->addListener(new postAddListener());
$this->addPanel($sitePanel);

$this->addPanel(new atkWizardPanel($this, "Employee", "company.employee"));
}
}

class postAddListener extends atkActionListener
{
function postAddListener()
{
$this->atkActionListener(array("save"));
}

function actionPerformed($action, $record)
{
//do some processing
//eg save department_id in session and use
//it when adding employees
}
}

Make an instance of atkWizardTest and start the wizard. Mind you that the atkWizard class extends atkController.

Code:

atkimport("atk.atkcontroller");
$wizard = &atkcontroller::createInstance("atkWizardTest");
$wizard->setMode(WIZARD_MODE_ADD);
$wizard->handleRequest();

==Output==
If you are using the AtkWizard in a default Atk application environment, the HTML will be outputted by atkOutput. The default handleRequest of atkController will do the following, where $screen is the HTML content:

$output = &atkOutput::getInstance();
$output->output($screen);

When you are using the AtkWizard from another environment and you don't want to use atkOutput to display the html. You could use the method setReturnOutput(boolean) to have the output returned to you be string, when calling the handleRequest method of atkWizard. You can use the method setPageFlags(flag) to influence the return output. You might not want a HEAD section of BODY tags returned, but only the wizardpanel form.