IlvInteractor

IlvObject
  |
  +--IlvInteractor

Category:

Common component

JavaScript File:

IlvInteractor.js

Description:

IlvInteractor is the abstract base class for all interactors on a DHTML view component. In order to create a new interactor, you must create a subclass that should define 1 or more of the following methods:

  mouseMove(event) - To handle mouse move events.
  mouseDown(event) - To handle mouse down events.
  mouseDrag(event) - To handle mouse drag events.
  mouseUp(event)   - To handle mouse up events.
  mouseOver(event) - To handle mouse over events.
  mouseOut(event)  - To handle mouse out events.
  mouseWheel(event)  - To handle mouse wheel events.  
  keyPress(event)  - To handle key press events.
  keyDown(event)   - To handle key down events.
  keyUp(event)     - To handle key up events.
 

The mouse event parameter passed to the first 6 methods is an object with 8 read-only properties:

  event.type:     A string representing the event type.
  event.mouseX:   The mouse X coordinate relative to the view.
  event.mouseY:   The mouse Y coordinate relative to the view.
  event.screenX:  The absolute mouse X coordinate in the screen.
  event.screenY:  The absolute mouse Y coordinate in the screen.
  event.altKey:   A Boolean, true when the ALT key is pressed.
  event.ctrlKey:  A Boolean, true when the CONTROL key is pressed.
  event.shiftKey: A Boolean, true when the SHIFT key is pressed.
 

The key event passed to the keyPress method is an object with the following read-only properties:

  event.type:     A string representing the event type.
  event.keyCode:  The key code.
 

The mouse wheel event passed to the mouseWheel method is an object with the following read-only property:

  event.wheelDelta:  The amount of scrolling: This value is positive if the mouse wheel was scrolled up and negative otherwise.
                                  This amount depends on the mouse configuration and on the browser.   
 

IlvInteractor

IlvInteractor()

Creates an instance of IlvInteractor.

getCursor()

Returns the mouse cursor to be displayed when using this interactor.

getMenuModelId()

Returns the menu model ID. This property is used when this interactor is set on a view and this view is using a dynamic contextual menu. The generation of the contextual menu may depend on this ID.

getMessage()

Returns the message to be displayed when using this interactor.

getView()

Returns the IlvGanttComponentView where this interactor is attached or null when the interactor is not attached.

setCursor(cursor)

Sets the mouse cursor to be displayed when using this interactor.

setMenuModelId(modelId)

Sets the menu model ID. This property is used when this interactor is set on a view and this view is using a dynamic contextual menu. The generation of the contextual menu may depend on this ID.

Parameters:

modelId - The menu model ID.

setMessage(message)

Sets the message to be displayed when using this interactor.

setView(view)

Invoked when the interactor is attached or detached from a view. You should not call this method directly, but you may overwrite this method to do a specific task when creating a new interactor.