PHP Class Prado\Web\UI\WebControls\TWizardNavigationEventParameter

TWizardNavigationEventParameter represents the parameter for {@link TWizard}'s navigation events. The index of the currently active step can be obtained from {@link getCurrentStepIndex CurrentStepIndex}, while the index of the candidate new step is in {@link getNextStepIndex NextStepIndex}. By modifying {@link setNextStepIndex NextStepIndex}, the new step can be changed to another one. If there is anything wrong with the navigation and it is not wanted, set {@link setCancelNavigation CancelNavigation} to true.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TEventParameter
Mostra file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
__construct ( $currentStep ) Constructor.
getCancelNavigation ( ) : boolean
getCurrentStepIndex ( ) : integer
getNextStepIndex ( ) : integer
setCancelNavigation ( $value )
setNextStepIndex ( $index )

Method Details

__construct() public method

Constructor.
public __construct ( $currentStep )

getCancelNavigation() public method

public getCancelNavigation ( ) : boolean
return boolean whether navigation to the next step should be canceled. Default to false.

getCurrentStepIndex() public method

public getCurrentStepIndex ( ) : integer
return integer the zero-based index of the currently active step.

getNextStepIndex() public method

public getNextStepIndex ( ) : integer
return integer the zero-based index of the next step. Default to {@link getCurrentStepIndex CurrentStepIndex}.

setCancelNavigation() public method

public setCancelNavigation ( $value )

setNextStepIndex() public method

public setNextStepIndex ( $index )