Class InternalEvent

InternalEvent

Cross-browser DOM event support. For internal event handling, mxEventSource and the graph event dispatch loop in graph are used.

Memory Leaks:

Use this class for adding and removing listeners to/from DOM nodes. The removeAllListeners function is provided to remove all listeners that have been added using addListener. The function should be invoked when the last reference is removed in the JavaScript code, typically when the referenced DOM node is removed from the DOM.

Constructors

constructor

Properties

ACTIVATE ADD ADD_CELLS ADD_OVERLAY ADD_VERTEX AFTER_ADD_VERTEX ALIGN_CELLS BEFORE_ADD_VERTEX BEFORE_UNDO BEGIN_UPDATE CELL_CONNECTED CELLS_ADDED CELLS_FOLDED CELLS_MOVED CELLS_ORDERED CELLS_REMOVED CELLS_RESIZED CELLS_TOGGLED CHANGE CLEAR CLICK CLOSE CONNECT CONNECT_CELL CUSTOM_HANDLE DESTROY DISCONNECT DONE DOUBLE_CLICK DOWN EDITING_STARTED EDITING_STOPPED END_EDIT END_UPDATE ESCAPE EXECUTE EXECUTED FIRE_MOUSE_EVENT FIRED FLIP_EDGE FOLD_CELLS GESTURE GET GROUP_CELLS HIDE LABEL_CHANGED LABEL_HANDLE LAYOUT_CELLS MARK MAXIMIZE MINIMIZE MOUSE_DOWN MOUSE_MOVE MOUSE_UP MOVE MOVE_CELLS MOVE_END MOVE_START NORMALIZE NOTIFY OPEN ORDER_CELLS PAN PAN_END PAN_START PINCH_THRESHOLD POST RECEIVE REDO REFRESH REMOVE REMOVE_CELLS REMOVE_CELLS_FROM_PARENT REMOVE_OVERLAY RESET RESIZE RESIZE_CELLS RESIZE_END RESIZE_START RESUME ROOT ROTATION_HANDLE SAVE SCALE SCALE_AND_TRANSLATE SELECT SHOW SIZE SPLIT_EDGE START START_EDIT START_EDITING SUSPEND TAP_AND_HOLD TOGGLE_CELLS TRANSLATE UNDO UNGROUP_CELLS UP UPDATE_CELL_SIZE VIRTUAL_HANDLE

Methods

addGestureListeners addListener addMouseWheelListener consume disableContextMenu redirectMouseEvents release removeAllListeners removeGestureListeners removeListener

Constructors

constructor

Properties

StaticACTIVATE

ACTIVATE: string = 'activate'

Specifies the event name for activate.

StaticADD

ADD: string = 'add'

Specifies the event name for add.

StaticADD_CELLS

ADD_CELLS: string = 'addCells'

Specifies the event name for addCells.

StaticADD_OVERLAY

ADD_OVERLAY: string = 'addOverlay'

Specifies the event name for addOverlay.

StaticADD_VERTEX

ADD_VERTEX: string = 'addVertex'

Specifies the event name for addVertex.

StaticAFTER_ADD_VERTEX

AFTER_ADD_VERTEX: string = 'afterAddVertex'

Specifies the event name for afterAddVertex.

StaticALIGN_CELLS

ALIGN_CELLS: string = 'alignCells'

Specifies the event name for alignCells.

StaticBEFORE_ADD_VERTEX

BEFORE_ADD_VERTEX: string = 'beforeAddVertex'

Specifies the event name for beforeAddVertex.

StaticBEFORE_UNDO

BEFORE_UNDO: string = 'beforeUndo'

Specifies the event name for beforeUndo.

StaticBEGIN_UPDATE

BEGIN_UPDATE: string = 'beginUpdate'

Specifies the event name for beginUpdate.

StaticCELL_CONNECTED

CELL_CONNECTED: string = 'cellConnected'

Specifies the event name for cellConnected.

StaticCELLS_ADDED

CELLS_ADDED: string = 'cellsAdded'

Specifies the event name for cellsAdded.

StaticCELLS_FOLDED

CELLS_FOLDED: string = 'cellsFolded'

Specifies the event name for cellsFolded.

StaticCELLS_MOVED

CELLS_MOVED: string = 'cellsMoved'

Specifies the event name for cellsMoved.

StaticCELLS_ORDERED

CELLS_ORDERED: string = 'cellsOrdered'

Specifies the event name for cellsOrdered.

StaticCELLS_REMOVED

CELLS_REMOVED: string = 'cellsRemoved'

Specifies the event name for cellsRemoved.

StaticCELLS_RESIZED

CELLS_RESIZED: string = 'cellsResized'

Specifies the event name for cellsResized.

StaticCELLS_TOGGLED

CELLS_TOGGLED: string = 'cellsToggled'

Specifies the event name for cellsToggled.

StaticCHANGE

CHANGE: string = 'change'

Specifies the event name for change.

StaticCLEAR

CLEAR: string = 'clear'

Specifies the event name for clear.

StaticCLICK

CLICK: string = 'click'

Specifies the event name for click.

StaticCLOSE

CLOSE: string = 'close'

Specifies the event name for close.

StaticCONNECT

CONNECT: string = 'connect'

Specifies the event name for connect.

StaticCONNECT_CELL

CONNECT_CELL: string = 'connectCell'

Specifies the event name for connectCell.

StaticCUSTOM_HANDLE

CUSTOM_HANDLE: number = -100

Start index for the custom handles in an mxMouseEvent. This should be a negative value and is the start index which is decremented for each custom handle.

Default

-100

StaticDESTROY

DESTROY: string = 'destroy'

Specifies the event name for destroy.

StaticDISCONNECT

DISCONNECT: string = 'disconnect'

Specifies the event name for disconnect.

StaticDONE

DONE: string = 'done'

Specifies the event name for done.

StaticDOUBLE_CLICK

DOUBLE_CLICK: string = 'doubleClick'

Specifies the event name for doubleClick.

StaticDOWN

DOWN: string = 'down'

Specifies the event name for down.

StaticEDITING_STARTED

EDITING_STARTED: string = 'editingStarted'

Specifies the event name for editingStarted.

StaticEDITING_STOPPED

EDITING_STOPPED: string = 'editingStopped'

Specifies the event name for editingStopped.

StaticEND_EDIT

END_EDIT: string = 'endEdit'

Specifies the event name for endEdit.

StaticEND_UPDATE

END_UPDATE: string = 'endUpdate'

Specifies the event name for endUpdate.

StaticESCAPE

ESCAPE: string = 'escape'

Specifies the event name for escape.

StaticEXECUTE

EXECUTE: string = 'execute'

Specifies the event name for execute.

StaticEXECUTED

EXECUTED: string = 'executed'

Specifies the event name for executed.

StaticFIRE_MOUSE_EVENT

FIRE_MOUSE_EVENT: string = 'fireMouseEvent'

Specifies the event name for fireMouseEvent.

StaticFIRED

FIRED: string = 'fired'

Specifies the event name for fired.

StaticFLIP_EDGE

FLIP_EDGE: string = 'flipEdge'

Specifies the event name for flipEdge.

StaticFOLD_CELLS

FOLD_CELLS: string = 'foldCells'

Specifies the event name for foldCells.

StaticGESTURE

GESTURE: string = 'gesture'

Specifies the event name for gesture.

StaticGET

GET: string = 'get'

Specifies the event name for get.

StaticGROUP_CELLS

GROUP_CELLS: string = 'groupCells'

Specifies the event name for groupCells.

StaticHIDE

HIDE: string = 'hide'

Specifies the event name for hide.

StaticLABEL_CHANGED

LABEL_CHANGED: string = 'labelChanged'

Specifies the event name for labelChanged.

StaticLABEL_HANDLE

LABEL_HANDLE: number = -1

Index for the label handle in an mxMouseEvent. This should be a negative value that does not interfere with any possible handle indices.

Default

-1

StaticLAYOUT_CELLS

LAYOUT_CELLS: string = 'layoutCells'

Specifies the event name for layoutCells.

StaticMARK

MARK: string = 'mark'

Specifies the event name for mark.

StaticMAXIMIZE

MAXIMIZE: string = 'maximize'

Specifies the event name for maximize.

StaticMINIMIZE

MINIMIZE: string = 'minimize'

Specifies the event name for minimize.

StaticMOUSE_DOWN

MOUSE_DOWN: string = 'mouseDown'

Specifies the event name for mouseDown.

StaticMOUSE_MOVE

MOUSE_MOVE: string = 'mouseMove'

Specifies the event name for mouseMove.

StaticMOUSE_UP

MOUSE_UP: string = 'mouseUp'

Specifies the event name for mouseUp.

StaticMOVE

MOVE: string = 'move'

Specifies the event name for move.

StaticMOVE_CELLS

MOVE_CELLS: string = 'moveCells'

Specifies the event name for moveCells.

StaticMOVE_END

MOVE_END: string = 'moveEnd'

Specifies the event name for moveEnd.

StaticMOVE_START

MOVE_START: string = 'moveStart'

Specifies the event name for moveStart.

StaticNORMALIZE

NORMALIZE: string = 'normalize'

Specifies the event name for normalize.

StaticNOTIFY

NOTIFY: string = 'notify'

Specifies the event name for notify.

StaticOPEN

OPEN: string = 'open'

Specifies the event name for open.

StaticORDER_CELLS

ORDER_CELLS: string = 'orderCells'

Specifies the event name for orderCells.

StaticPAN

PAN: string = 'pan'

Specifies the event name for pan.

StaticPAN_END

PAN_END: string = 'panEnd'

Specifies the event name for panEnd.

StaticPAN_START

PAN_START: string = 'panStart'

Specifies the event name for panStart.

StaticPINCH_THRESHOLD

PINCH_THRESHOLD: number = 10

Threshold for pinch gestures to fire a mouse wheel event. Default value is 10.

StaticPOST

POST: string = 'post'

Specifies the event name for post.

StaticRECEIVE

RECEIVE: string = 'receive'

Specifies the event name for receive.

StaticREDO

REDO: string = 'redo'

Specifies the event name for redo.

StaticREFRESH

REFRESH: string = 'refresh'

Specifies the event name for refresh.

StaticREMOVE

REMOVE: string = 'remove'

Specifies the event name for remove.

StaticREMOVE_CELLS

REMOVE_CELLS: string = 'removeCells'

Specifies the event name for removeCells.

StaticREMOVE_CELLS_FROM_PARENT

REMOVE_CELLS_FROM_PARENT: string = 'removeCellsFromParent'

Specifies the event name for removeCellsFromParent.

StaticREMOVE_OVERLAY

REMOVE_OVERLAY: string = 'removeOverlay'

Specifies the event name for removeOverlay.

StaticRESET

RESET: string = 'reset'

Specifies the event name for reset.

StaticRESIZE

RESIZE: string = 'resize'

Specifies the event name for resize.

StaticRESIZE_CELLS

RESIZE_CELLS: string = 'resizeCells'

Specifies the event name for resizeCells.

StaticRESIZE_END

RESIZE_END: string = 'resizeEnd'

Specifies the event name for resizeEnd.

StaticRESIZE_START

RESIZE_START: string = 'resizeStart'

Specifies the event name for resizeStart.

StaticRESUME

RESUME: string = 'resume'

Specifies the event name for suspend.

StaticROOT

ROOT: string = 'root'

Specifies the event name for root.

StaticROTATION_HANDLE

ROTATION_HANDLE: number = -2

Index for the rotation handle in an mxMouseEvent. This should be a negative value that does not interfere with any possible handle indices.

Default

-2

StaticSAVE

SAVE: string = 'save'

Specifies the event name for open.

StaticSCALE

SCALE: string = 'scale'

Specifies the event name for scale.

StaticSCALE_AND_TRANSLATE

SCALE_AND_TRANSLATE: string = 'scaleAndTranslate'

Specifies the event name for scaleAndTranslate.

StaticSELECT

SELECT: string = 'select'

Specifies the event name for select.

StaticSHOW

SHOW: string = 'show'

Specifies the event name for show.

StaticSIZE

SIZE: string = 'size'

Specifies the event name for size.

StaticSPLIT_EDGE

SPLIT_EDGE: string = 'splitEdge'

Specifies the event name for splitEdge.

StaticSTART

START: string = 'start'

Specifies the event name for start.

StaticSTART_EDIT

START_EDIT: string = 'startEdit'

Specifies the event name for startEdit.

StaticSTART_EDITING

START_EDITING: string = 'startEditing'

Specifies the event name for startEditing.

StaticSUSPEND

SUSPEND: string = 'suspend'

Specifies the event name for suspend.

StaticTAP_AND_HOLD

TAP_AND_HOLD: string = 'tapAndHold'

Specifies the event name for tapAndHold.

StaticTOGGLE_CELLS

TOGGLE_CELLS: string = 'toggleCells'

Specifies the event name for toggleCells.

StaticTRANSLATE

TRANSLATE: string = 'translate'

Specifies the event name for translate.

StaticUNDO

UNDO: string = 'undo'

Specifies the event name for undo.

StaticUNGROUP_CELLS

UNGROUP_CELLS: string = 'ungroupCells'

Specifies the event name for ungroupCells.

StaticUP

UP: string = 'up'

Specifies the event name for up.

StaticUPDATE_CELL_SIZE

UPDATE_CELL_SIZE: string = 'updateCellSize'

Specifies the event name for updateCellSize.

StaticVIRTUAL_HANDLE

VIRTUAL_HANDLE: number = -100000

Start index for the virtual handles in an mxMouseEvent. This should be a negative value and is the start index which is decremented for each virtual handle. This assumes that there are no more than VIRTUAL_HANDLE - CUSTOM_HANDLE custom handles.

Default

-100000

Methods

StaticaddGestureListeners

  • addGestureListeners(node, startListener?, moveListener?, endListener?): void

  • Adds the given listeners for touch, mouse and/or pointer events. If <Client.IS_POINTER> is true then pointer events will be registered, else the respective mouse events will be registered. If <Client.IS_POINTER> is false and <Client.IS_TOUCH> is true then the respective touch events will be registered as well as the mouse events.

    Parameters

    Returns void

StaticaddListener

StaticaddMouseWheelListener

  • addMouseWheelListener(funct, target): void

  • Installs the given function as a handler for mouse wheel events. The function has two arguments: the mouse event and a boolean that specifies if the wheel was moved up or down.

    This has been tested with IE 6 and 7, Firefox (all versions), Opera and Safari. It does currently not work on Safari for Mac.

    Example

    Parameters

    • funct: ((event: Event, up: boolean, force?: boolean, cx?: number, cy?: number) => void)

      Handler function that takes the event argument and a boolean up argument for the mousewheel direction.

        • (event, up, force?, cx?, cy?): void

        • Parameters

          • event: Event
          • up: boolean
          • Optionalforce: boolean
          • Optionalcx: number
          • Optionalcy: number

          Returns void

    • target: Listenable

      Target for installing the listener in Google Chrome. See https://www.chromestatus.com/features/6662647093133312.

    Returns void

    Example

    mxEvent.addMouseWheelListener(function (evt, up)
    {
      GlobalConfig.logger.show();
      GlobalConfig.logger.debug('mouseWheel: up='+up);
    });

Staticconsume

  • consume(evt, preventDefault?, stopPropagation?): void

  • Consumes the given event.

    Parameters

    • evt: Event

      Native event to be consumed.

    • OptionalpreventDefault: boolean = true

      Optional boolean to prevent the default for the event. Default is true.

    • OptionalstopPropagation: boolean = true

      Option boolean to stop event propagation. Default is true.

    Returns void

StaticdisableContextMenu

StaticredirectMouseEvents

  • redirectMouseEvents(node, graph, state?, down?, move?, up?, dblClick?): void

  • Redirects the mouse events from the given DOM node to the graph dispatch loop using the event and given state as event arguments. State can either be an instance of or a function that returns an . The down, move, up and dblClick arguments are optional functions that take the trigger event as arguments and replace the default behaviour.

    Parameters

    Returns void

Staticrelease

  • release(element): void

  • Removes the known listeners from the given DOM node and its descendants.

    Parameters

    • element: Listenable

      DOM node to remove the listeners from.

    Returns void

StaticremoveAllListeners

StaticremoveGestureListeners

StaticremoveListener

Settings

Member Visibility

On This Page

Memory Leaks:
Constructors
Properties
ACTIVATEADDADD_CELLSADD_OVERLAYADD_VERTEXAFTER_ADD_VERTEXALIGN_CELLSBEFORE_ADD_VERTEXBEFORE_UNDOBEGIN_UPDATECELL_CONNECTEDCELLS_ADDEDCELLS_FOLDEDCELLS_MOVEDCELLS_ORDEREDCELLS_REMOVEDCELLS_RESIZEDCELLS_TOGGLEDCHANGECLEARCLICKCLOSECONNECTCONNECT_CELLCUSTOM_HANDLEDESTROYDISCONNECTDONEDOUBLE_CLICKDOWNEDITING_STARTEDEDITING_STOPPEDEND_EDITEND_UPDATEESCAPEEXECUTEEXECUTEDFIRE_MOUSE_EVENTFIREDFLIP_EDGEFOLD_CELLSGESTUREGETGROUP_CELLSHIDELABEL_CHANGEDLABEL_HANDLELAYOUT_CELLSMARKMAXIMIZEMINIMIZEMOUSE_DOWNMOUSE_MOVEMOUSE_UPMOVEMOVE_CELLSMOVE_ENDMOVE_STARTNORMALIZENOTIFYOPENORDER_CELLSPANPAN_ENDPAN_STARTPINCH_THRESHOLDPOSTRECEIVEREDOREFRESHREMOVEREMOVE_CELLSREMOVE_CELLS_FROM_PARENTREMOVE_OVERLAYRESETRESIZERESIZE_CELLSRESIZE_ENDRESIZE_STARTRESUMEROOTROTATION_HANDLESAVESCALESCALE_AND_TRANSLATESELECTSHOWSIZESPLIT_EDGESTARTSTART_EDITSTART_EDITINGSUSPENDTAP_AND_HOLDTOGGLE_CELLSTRANSLATEUNDOUNGROUP_CELLSUPUPDATE_CELL_SIZEVIRTUAL_HANDLE
Methods