Docs For Class atkWizardPanel

array	$m_actionHandlers	Array of ActionHandlers which are binded to the atkNode
string	$m_defaultAction	The default atkNode action for this wizardpanel
array	$m_listeners	Array of Actionlisteners which listen to the atkNode
object reference	$m_node	Reference to the atkNode
string	$m_nodeName	Name representation of the atkNode
string	$m_panelName	Panel name
boolean	$m_showFinishButton	Explicity set the finish button on this panel
object reference	$m_wizard	Reference to the parent wizard

[ Top ]

Method Summary

atkWizardPanel	atkWizardPanel()	atkWizardPanel constructor
void	addActionHandler()	Add an atkActionHandler to the atkWizardPanel.
void	addListener()	Add an atkActionListener to the atkWizardPanel.
unknown	dispatchForm()	Do some session manipulations
unknown	getPanelName()	Return the panel name
object of	getPanelNode()	Return the atkNode object for this panel. If it didn't exist yet, this method will create it and add actionlistener or actionhandlers. The session will also be manipulated so that the controller knows which atknodetype to render.
bool	isFinishPanel()	Check to see if this wizardpanel is the last panel before the finish screen.
void	loadRenderBoxVars()	Add smarty vars to actionhandler
bool	save()	We are saving a newly added record. On success or failure ATK will redirect.
int	showFinishButton()	Return the setting which specifies if the button should be shown, not shown or should depend on the default behaviour. Default behaviour is that the last panel in the wizard will have a finish button.
string	_getText()	Return a translation from the language file with a fallback option.

[ Top ]

Properties

array $m_actionHandlers = array() [line 89]

Array of ActionHandlers which are binded to the atkNode

[ Top ]

string $m_defaultAction [line 96]

The default atkNode action for this wizardpanel

[ Top ]

array $m_listeners [line 81]

Array of Actionlisteners which listen to the atkNode

[ Top ]

object reference $m_node [line 73]

Reference to the atkNode

[ Top ]

string $m_nodeName [line 66]

Name representation of the atkNode

[ Top ]

string $m_panelName [line 59]

Panel name

[ Top ]

boolean $m_showFinishButton = false [line 103]

Explicity set the finish button on this panel

[ Top ]

object reference $m_wizard [line 52]

Reference to the parent wizard

[ Top ]

Methods

Constructor atkWizardPanel [line 119]

atkWizardPanel atkWizardPanel(

&$wizard, string
$panelName, string
$nodeName, [string
$defaultAction = ""], [integer
$finishButton = FINISH_BUTTON_DEFAULT], atkWizard
$wizard 
)

atkWizardPanel constructor

We don't construct the node here for performance reasons (if any?). We probably don't need the node in most pageloads because we only use one wizardpanel at a time.

Parameters:

atkWizard	$wizard:	The wizard
string	$panelName:	The panelname
string	$nodeName:	The nodename
string	$defaultAction:	The default action
integer	$finishButton:	The finish button to use
	&$wizard:

[ Top ]

addActionHandler [line 214]

void addActionHandler(
string
$handlerName, string
$handlerAction 
)

Add an atkActionHandler to the atkWizardPanel.

Handlers are created and added to the atkNode when the node is created.

Parameters:

string	$handlerName:	Name of the handler to add
string	$handlerAction:	The action

API Tags:

Access:

public

[ Top ]

addListener [line 199]

void addListener(

&$listener, atkActionListener
$listener 
)

Add an atkActionListener to the atkWizardPanel.

Listeners are added to the atkNode when the node is created.

Parameters:

atkActionListener	$listener:
	&$listener:

[ Top ]

dispatchForm [line 224]

unknown dispatchForm(
)

Do some session manipulations

[ Top ]

getPanelName [line 186]

unknown getPanelName(
)

Return the panel name

API Tags:

Access:

public

[ Top ]

getPanelNode [line 135]

object of getPanelNode(
)

Return the atkNode object for this panel. If it didn't exist yet, this method will create it and add actionlistener or actionhandlers. The session will also be manipulated so that the controller knows which atknodetype to render.

API Tags:

Return:	type atknode
Access:	public

[ Top ]

isFinishPanel [line 296]

bool isFinishPanel(
)

Check to see if this wizardpanel is the last panel before the finish screen.

[ Top ]

loadRenderBoxVars [line 334]

void loadRenderBoxVars(
string
$action 
)

Add smarty vars to actionhandler

Parameters:

string

$action:

[ Top ]

save [line 262]

bool save(
)

We are saving a newly added record. On success or failure ATK will redirect.

On failure the session stack of the previous level is loaded to show the same wizardpanel again (now with error message). On succes we need to set some redirect vars to make sure we go to the next wizardpanel.

API Tags:

Return:

on successfully executing this function

[ Top ]

showFinishButton [line 286]

int showFinishButton(
)

Return the setting which specifies if the button should be shown, not shown or should depend on the default behaviour. Default behaviour is that the last panel in the wizard will have a finish button.

API Tags:

Return:

FINISH_BUTTON_DEFAULT FINISH_BUTTON_SHOW FINISH_BUTTON_DONT_SHOW

[ Top ]

_getText [line 308]

string _getText(
string
$key, string
$fallbackKey 
)

Return a translation from the language file with a fallback option.

Parameters:

string	$key:
string	$fallbackKey:

[ Top ]