aquarium.screen.WizardStep.WizardStep

Package aquarium :: Package screen :: Module WizardStep :: Class WizardStep

[show private | hide private]

Class WizardStep

Known Subclasses:: wizard_review

Provides convenience methods for wizard steps. You -must- setup a bean
in your subclass

Method Summary
	`__call__(self, args, *kargs)`
	`callWizard(self, action)`
	`doCancelAction(self)` Tells the wizard to cancel.
	`doNextAction(self)` Tells the wizard to take us to the next step.
	`doPrevAction(self)` Tells the wizard to take us to the previous step.
	`forward(self, where)`
	`getDefaults(self)`
	`getPreviousData(self)`
	`initWizard(self)`
	`process(self)` Override this method so that you can actually process the data.
	`review(self)`
	`run(self)` This method is called when it is time for us to run.
	`validate(self)` You should override this with a validator that actually does something.
	`validateAndProcess(self, successCallback)`

Class Variable Summary
`NoneType`	`bean` = None
`bool`	`goingBackwards` = `False`

Method Details

doCancelAction(self)

Tells the wizard to cancel.

doNextAction(self)

Tells the wizard to take us to the next step.

doPrevAction(self)

Tells the wizard to take us to the previous step.

process(self)

Override this method so that you can actually process the data.
Most likely this means to save the data.

Note that if you are reading from self._ctx.form in here (instead
of self.formValues) you are probably doing something wrong.

run(self)

This method is called when it is time for us to run.

validate(self)

You should override this with a validator that actually does
something. On success it should populate self.formValues with
the return data from FormValid. On failure it should populate
self.formValues with self._ctx.form

Class Variable Details

bean

Type:: NoneType
Value:: None

goingBackwards

Type:: bool
Value:: False

Generated by Epydoc 2.1 on Mon Jan 1 16:34:19 2007

http://epydoc.sf.net