pureweb.client. CommandFilterEventArgs

An event arguments class to allow mouse and keyboard events to be filtered or modified before they are sent to the server.

Method Summary

getEvent
Returns the keyboard event object.
isCancelled
Returns a Boolean value that indicates whether the event has been cancelled.
setCancelled
Cancels or revives the event.

Constructor

new CommandFilterEventArgs(event)

Initializes a new instance of CommandFilterEventArgs.
Parameters:
Name Type Description
event Object An object containing the particulars about the event.

Method Detail

getEvent() → {Object}

Returns the keyboard event object.

isCancelled() → {boolean}

Returns a Boolean value that indicates whether the event has been cancelled. The value is true if the event has been cancelled, and false otherwise.

setCancelled(isCancelled)

Cancels or revives the event.
Parameters:
Name Type Description
isCancelled boolean Set to true to cancel the event, and to false otherwise.