TKToggleAction Class Reference
[Actions]
Executes other actions in turn.
More...
Inheritance diagram for TKToggleAction:
Public Member Functions | |
| __construct ($actions) | |
| Creates a new toggle action. | |
| getInvocation () | |
Static Public Member Functions | |
| static | createFromXML ($attrs, $children) |
Detailed Description
Executes other actions in turn.A toggle action takes an array of other actions. Each time the toggle action is invoked by JavaScript, it executes another action in the array. When it reaches the end of the array, it goes back to the beginning. If you have two actions to execute, then you can create a traditional light-switch-like two-state toggle.
Definition at line 13 of file TKToggleAction.php5.
Constructor & Destructor Documentation
| TKToggleAction::__construct | ( | $ | actions | ) |
Creates a new toggle action.
- Parameters:
-
$actions [array]: array of TKAction's to toggle between
Definition at line 22 of file TKToggleAction.php5.
References TKAction::addExtraJS().
Member Function Documentation
| static TKToggleAction::createFromXML | ( | $ | attrs, | |
| $ | children | |||
| ) | [static] |
For internal use only.
Reimplemented from TKAction.
Definition at line 60 of file TKToggleAction.php5.
| TKToggleAction::getInvocation | ( | ) |
For internal use only.
Reimplemented from TKAction.
Definition at line 55 of file TKToggleAction.php5.
The documentation for this class was generated from the following file:
- tk2/actions/TKToggleAction.php5
