Class InteractionEvent

This is the basic class that represents a interaction event. This class exposes main functions used to initialize and retrieve information when an interaction occurs and a command is executed.
Defined in: dfDataWidget.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	InteractionEvent() Construct a new InteractionEvent object.

Method Summary
Method Attributes	Method Name and Description
	construct() Internal Function.
	getAction() Return the name of the action that has been called by the interaction.
	getName() Return the name of the interaction.
	getSource() Returnsthe object that triggered the interaction.
	getTarget() Return the object for which the interaction action has been called.
	setAction() Set the action that has been called.
	setSource() Set the object from which the interaction has been triggered.
	setTarget() Set the object for which the interaction called the action.

Class Detail

InteractionEvent()

Construct a new InteractionEvent object.

Parameters:
{Document} interactionName.: The interaction event definition.

Returns:: A new InteractionEvent instance

Method Detail

construct()

Internal Function. Initialize the interaction event.

Parameters:
{Document} interactionName.: The interaction event definition.

{String} getAction()

Return the name of the action that has been called by the interaction.

{String} getName()

Return the name of the interaction.

{Object} getSource()

Returnsthe object that triggered the interaction. In many cases, this function returns a {DataWidget} instance.

{Object} getTarget()

Return the object for which the interaction action has been called. In many cases, this function returns a {DataWidget} instance.

setAction()

Set the action that has been called.

Parameters:
{String} action.: The name of the action.

setSource()

Set the object from which the interaction has been triggered.

Parameters:
{Object} source.: The object that represents the source of the interaction.

setTarget()

Set the object for which the interaction called the action.

Parameters:
{Object} target.: The object that represents the target of the interaction.

Classes

Class InteractionEvent