blob: 2d6d431f7842e5fbbd6d6cc540fd184e626de87e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?php
/**
* TWizard and the relevant class definitions.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\TPropertyValue;
/**
* TWizardNavigationEventParameter class.
*
* 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.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TWizardNavigationEventParameter extends \Prado\TEventParameter
{
private $_cancel=false;
private $_currentStep;
private $_nextStep;
/**
* Constructor.
* @param integer current step index
*/
public function __construct($currentStep)
{
$this->_currentStep=$currentStep;
$this->_nextStep=$currentStep;
}
/**
* @return integer the zero-based index of the currently active step.
*/
public function getCurrentStepIndex()
{
return $this->_currentStep;
}
/**
* @return integer the zero-based index of the next step. Default to {@link getCurrentStepIndex CurrentStepIndex}.
*/
public function getNextStepIndex()
{
return $this->_nextStep;
}
/**
* @param integer the zero-based index of the next step.
*/
public function setNextStepIndex($index)
{
$this->_nextStep=TPropertyValue::ensureInteger($index);
}
/**
* @return boolean whether navigation to the next step should be canceled. Default to false.
*/
public function getCancelNavigation()
{
return $this->_cancel;
}
/**
* @param boolean whether navigation to the next step should be canceled.
*/
public function setCancelNavigation($value)
{
$this->_cancel=TPropertyValue::ensureBoolean($value);
}
}
|
