TKCustomAction Class Reference
[Actions]

Action with custom JavaScript. More...

Inheritance diagram for TKCustomAction:

[legend]

List of all members.

Public Member Functions
	__construct ($extrajs, $inlinejs)
	Create a new custom action.
	getExtraJS ()
	Retrieve extra JavaScript.
	getInlineJS ()
	Retrieve inline JavaScript.
	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.

---

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

---

Member Function Documentation

TKCustomAction::getExtraJS

(

)

Retrieve extra JavaScript.

Returns:

[string]: extra JavaScript

TKCustomAction::getInlineJS

(

)

Retrieve inline JavaScript.

Returns:

[string]: inline JavaScript

TKCustomAction::setExtraJS

(

$

js

)

Change the extra JavaScript field.

Parameters:

$js

[string]: new JavaScript for extrajs

TKCustomAction::setInlineJS

(

$

js

)

Change the inline JavaScript field.

Parameters:

$js

[string]: new JavaScript for inelinejs

---

The documentation for this class was generated from the following file:

• tk2/actions/TKCustomAction.php5