.. role:: ts-api-decorator

##########
InputEvent
##########

.. js:module:: Event
   :noindex:

.. container:: ts-api-section

   .. js:class:: InputEvent



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Event.InputEvent.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~Event.InputEvent.viewKey`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Event.InputEvent.getDate`
   * :js:meth:`~Event.InputEvent.getHandled`
   * :js:meth:`~Event.InputEvent.setHandled`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: InputEvent.constructor( viewKey)

      :param viewKey: key for the View the event is occurring in
      :type viewKey: ViewKey


      :rtype: InputEvent



Accessors
=========

.. container:: ts-api-section

   .. js:function:: viewKey()
      :noindex:



      Get the ViewKey this event is associated with.


      :rtype: ViewKey



Methods
=======

.. rst-class:: ts-api-section

getDate
-------

.. js:method:: InputEvent.getDate()



   Gets the Date this event occurred

   :returns: the event Date


   :rtype: Date

.. rst-class:: ts-api-section

getHandled
----------

.. js:method:: InputEvent.getHandled()



   Gets the handled state of the event

   :returns: whether the event has been handled


   :rtype: boolean

.. rst-class:: ts-api-section

setHandled
----------

.. js:method:: InputEvent.setHandled( handled)

   :param handled: Indicates whether this event has been handled.
   :type handled: boolean


   Sets the handled state of the event. When an event has been handled it will not propagate any further


   :rtype: void

