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
파일 보기 프로젝트 열기: pradosoft/prado 1 사용 예제들

공개 메소드들

메소드 설명
__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 )