Skip navigation links

ilog.webui.dhtml.components
Class IlxWJSAction

java.lang.Object
  ilog.webui.dhtml.components.IlxWJSAction

All Implemented Interfaces:

IlxWAction, ilog.webui.dhtml.IlxWDependencyProvider, ilog.webui.dhtml.IlxWJSObject, Serializable

public class IlxWJSAction
extends Object
implements IlxWAction

Class of JavaScript actions.
JavaScript actions provide you with a way to call user-defined JavaScript functions on the client side. To create a JavaScript action, pass the name of your JavaScript function to the IlxWJSAction constructor.

When the action is triggered on the web browser, for example when the user selects the menu item of a menu bar, the JavaScript function is called. The arguments for the function depend on the component with which the action is associated (see the documentation of the component for details).

See Also:

Serialized Form

Constructor Summary

IlxWJSAction(String jsFunction)
Constructs a new JavaScript action, given a JavaScript function.

Method Summary

String	getJSFunction() Returns the JavaScript function to call just after the action has been triggered.
String	getJSRef(IlxWPort port) Get a JavaScript reference on the action.
int	getType() Gets the type of this action.
boolean	isJavaAction() Tells whether this action is a Java action or not.
void	notifyDependencies(IlxWPort port)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlxWJSAction

public IlxWJSAction(String jsFunction)

Constructs a new JavaScript action, given a JavaScript function.

Parameters:

jsFunction - The JavaScript function to call just after the action has been triggered.

Method Detail

getJSFunction

public String getJSFunction()

Returns the JavaScript function to call just after the action has been triggered.

Returns:

The JavaScript function to call just after the action has been triggered.

getType

public int getType()

Description copied from interface: IlxWAction

Gets the type of this action.

Specified by:

getType in interface IlxWAction

Returns:

The type of this action.

isJavaAction

public boolean isJavaAction()

Description copied from interface: IlxWAction

Tells whether this action is a Java action or not.

Specified by:

isJavaAction in interface IlxWAction

Returns:

true if this action is a Java action.

getJSRef

public String getJSRef(IlxWPort port)

Description copied from interface: IlxWAction

Get a JavaScript reference on the action. This method is internally used by the web components framework.

Specified by:

getJSRef in interface IlxWAction

Specified by:

getJSRef in interface ilog.webui.dhtml.IlxWJSObject

notifyDependencies

public void notifyDependencies(IlxWPort port)

Specified by:

notifyDependencies in interface ilog.webui.dhtml.IlxWDependencyProvider