TKCustomAction Class Reference
[Actions]
Action with custom JavaScript.
More...
Public Member Functions | |
| __construct ($extrajs, $inlinejs) | |
| Create a new custom action. | |
| getExtraJS () | |
| Retrieve extra JavaScript. | |
| getInlineJS () | |
| Retrieve inline JavaScript. | |
| getInvocation () | |
| setExtraJS ($js) | |
| Change the extra JavaScript field. | |
| setInlineJS ($js) | |
| Change the inline JavaScript field. | |
Detailed Description
Action with custom JavaScript.Use this class to create a custom action that consists solely of JavaScript (otherwise, subclass TKAction). If you use a string or an array of two strings when calling TKComponent::setAction then TKComponent will implicitly create a TKCustomAction for you.
Definition at line 12 of file TKCustomAction.php5.
Constructor & Destructor Documentation
| TKCustomAction::__construct | ( | $ | extrajs, | |
| $ | inlinejs | |||
| ) |
Create a new custom action.
- Parameters:
-
$extrajs [string]: JavaScript to be embedded in the head section of the page $inlinejs [string]: JavaScript to be embedded in the event handler
Definition at line 22 of file TKCustomAction.php5.
Member Function Documentation
| TKCustomAction::getExtraJS | ( | ) |
Retrieve extra JavaScript.
- Returns:
- [string]: extra JavaScript
Definition at line 49 of file TKCustomAction.php5.
| TKCustomAction::getInlineJS | ( | ) |
Retrieve inline JavaScript.
- Returns:
- [string]: inline JavaScript
Definition at line 57 of file TKCustomAction.php5.
| TKCustomAction::getInvocation | ( | ) |
For internal use only.
Reimplemented from TKAction.
Definition at line 62 of file TKCustomAction.php5.
References Toolkit::globalAddExtraJS().
| TKCustomAction::setExtraJS | ( | $ | js | ) |
Change the extra JavaScript field.
- Parameters:
-
$js [string]: new JavaScript for extrajs
Definition at line 33 of file TKCustomAction.php5.
| TKCustomAction::setInlineJS | ( | $ | js | ) |
Change the inline JavaScript field.
- Parameters:
-
$js [string]: new JavaScript for inelinejs
Definition at line 41 of file TKCustomAction.php5.
The documentation for this class was generated from the following file:
- tk2/actions/TKCustomAction.php5
