Class InteractionEvent

Object
   |
   +--InteractionEvent

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

Field Detail

action

Object action

name

Object name

source

Object source

target

Object target

type

Object type

InteractionEvent

InteractionEvent( <Document> interactionName )

Construct a new InteractionEvent object.

Parameters:
interactionName - . The interaction event definition.

Returns:
A new InteractionEvent instance

construct

void construct( <Document> interactionName )

Internal Function. Initialize the interaction event.

Parameters:
interactionName - . The interaction event definition.

getAction

String getAction()

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

getName

String getName()

Return the name of the interaction.

getSource

Object getSource()

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

getTarget

Object getTarget()

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

setAction

void setAction( <String> action )

Set the action that has been called.

Parameters:
action - . The name of the action.

setSource

void setSource( <Object> source )

Set the object from which the interaction has been triggered.

Parameters:
source - . The object that represents the source of the interaction.

setTarget

void setTarget( <Object> target )

Set the object for which the interaction called the action.

Parameters:
target - . The object that represents the target of the interaction.