PHP Класс 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.

С версии: 3.0

Автор: Qiang Xue ([email protected])

Наследование: extends Prado\TEventParameter

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( $currentStep )	Constructor.
getCancelNavigation ( ) : boolean
getCurrentStepIndex ( ) : integer
getNextStepIndex ( ) : integer
setCancelNavigation ( $value )
setNextStepIndex ( $index )

Описание методов

__construct() публичный Метод

Constructor.

public __construct ( $currentStep )

getCancelNavigation() публичный Метод

public getCancelNavigation ( ) : boolean
Результат	boolean	whether navigation to the next step should be canceled. Default to false.

getCurrentStepIndex() публичный Метод

public getCurrentStepIndex ( ) : integer
Результат	integer	the zero-based index of the currently active step.

getNextStepIndex() публичный Метод

public getNextStepIndex ( ) : integer
Результат	integer	the zero-based index of the next step. Default to {@link getCurrentStepIndex CurrentStepIndex}.

setCancelNavigation() публичный Метод

public setCancelNavigation ( $value )

setNextStepIndex() публичный Метод

public setNextStepIndex ( $index )