mxCellMarker

A helper class to process mouse locations and highlight cells.

Helper class to highlight cells. To add a cell marker to an existing graph for highlighting all cells, the following code is used:

var marker = new mxCellMarker(graph);
graph.addMouseListener({
  mouseDown: function() {},
  mouseMove: function(sender, me)
  {
    marker.process(me);
  },
  mouseUp: function() {}
});

Summary

mxCellMarker	A helper class to process mouse locations and highlight cells.
Events
mxEvent.MARK	Fires after a cell has been marked or unmarked.
Functions
mxCellMarker	Constructs a new cell marker.
Variables
graph	Reference to the enclosing mxGraph.
enabled	Specifies if the marker is enabled.
hotspot	Specifies the portion of the width and height that should trigger a highlight.
hotspotEnabled	Specifies if the hotspot is enabled.
validColor	Holds the valid marker color.
invalidColor	Holds the invalid marker color.
currentColor	Holds the current marker color.
validState	Holds the marked mxCellState if it is valid.
markedState	Holds the marked mxCellState.
Functions
setEnabled	Enables or disables event handling.
isEnabled	Returns true if events are handled.
setHotspot	Sets the hotspot.
getHotspot	Returns the hotspot.
setHotspotEnabled	Specifies whether the hotspot should be used in intersects.
isHotspotEnabled	Returns true if hotspot is used in intersects.
hasValidState	Returns true if validState is not null.
getValidState	Returns the validState.
getMarkedState	Returns the markedState.
reset	Resets the state of the cell marker.
process	Processes the given event and cell and marks the state returned by getState with the color returned by getMarkerColor.
setCurrentState	Sets and marks the current valid state.
markCell	Marks the given cell using the given color, or validColor if no color is specified.
mark	Marks the markedState and fires a mark event.
unmark	Hides the marker and fires a mark event.
isValidState	Returns true if the given mxCellState is a valid state.
getMarkerColor	Returns the valid- or invalidColor depending on the value of isValid.
getState	Uses getCell, getStateToMark and intersects to return the mxCellState for the given mxMouseEvent.
getCell	Returns the mxCell for the given event and cell.
getStateToMark	Returns the mxCellState to be marked for the given mxCellState under the mouse.
intersects	Returns true if the given coordinate pair intersects the given state.
destroy	Destroys the handler and all its resources and DOM nodes.

Events

mxEvent.MARK

Fires after a cell has been marked or unmarked. The <code>state</code> property contains the marked mxCellState or null if no state is marked.

Functions

mxCellMarker

function mxCellMarker( graph,
validColor,
invalidColor,
hotspot )

Constructs a new cell marker.

Parameters

graph	Reference to the enclosing mxGraph.
validColor	Optional marker color for valid states. Default is mxConstants.DEFAULT_VALID_COLOR.
invalidColor	Optional marker color for invalid states. Default is mxConstants.DEFAULT_INVALID_COLOR.
hotspot	Portion of the width and hight where a state intersects a given coordinate pair. A value of 0 means always highlight. Default is mxConstants.DEFAULT_HOTSPOT.

Variables

graph

mxCellMarker.prototype.graph

Reference to the enclosing mxGraph.

enabled

mxCellMarker.prototype.enabled

Specifies if the marker is enabled. Default is true.

hotspot

mxCellMarker.prototype.hotspot

Specifies the portion of the width and height that should trigger a highlight. The area around the center of the cell to be marked is used as the hotspot. Possible values are between 0 and 1. Default is mxConstants.DEFAULT_HOTSPOT.

hotspotEnabled

mxCellMarker.prototype.hotspotEnabled

Specifies if the hotspot is enabled. Default is false.

validColor

mxCellMarker.prototype.validColor

Holds the valid marker color.

invalidColor

mxCellMarker.prototype.invalidColor

Holds the invalid marker color.

currentColor

mxCellMarker.prototype.currentColor

Holds the current marker color.

validState

mxCellMarker.prototype.validState

Holds the marked mxCellState if it is valid.

markedState

mxCellMarker.prototype.markedState

Holds the marked mxCellState.

Functions

setEnabled

mxCellMarker.prototype.setEnabled = function( enabled )

Enables or disables event handling. This implementation updates enabled.

Parameters

enabled

Boolean that specifies the new enabled state.

isEnabled

mxCellMarker.prototype.isEnabled = function()

Returns true if events are handled. This implementation returns enabled.

setHotspot

mxCellMarker.prototype.setHotspot = function( hotspot )

Sets the hotspot.

getHotspot

mxCellMarker.prototype.getHotspot = function()

Returns the hotspot.

setHotspotEnabled

mxCellMarker.prototype.setHotspotEnabled = function( enabled )

Specifies whether the hotspot should be used in intersects.

isHotspotEnabled

mxCellMarker.prototype.isHotspotEnabled = function()

Returns true if hotspot is used in intersects.

hasValidState

mxCellMarker.prototype.hasValidState = function()

Returns true if validState is not null.

getValidState

mxCellMarker.prototype.getValidState = function()

Returns the validState.

getMarkedState

mxCellMarker.prototype.getMarkedState = function()

Returns the markedState.

reset

mxCellMarker.prototype.reset = function()

Resets the state of the cell marker.

process

mxCellMarker.prototype.process = function( me )

Processes the given event and cell and marks the state returned by getState with the color returned by getMarkerColor. If the markerColor is not null, then the state is stored in markedState. If isValidState returns true, then the state is stored in validState regardless of the marker color. The state is returned regardless of the marker color and valid state.

setCurrentState

mxCellMarker.prototype.setCurrentState = function( state,
me,
color )

Sets and marks the current valid state.

markCell

mxCellMarker.prototype.markCell = function( cell,
color )

Marks the given cell using the given color, or validColor if no color is specified.

mark

mxCellMarker.prototype.mark = function()

Marks the markedState and fires a mark event.

unmark

mxCellMarker.prototype.unmark = function()

Hides the marker and fires a mark event.

isValidState

mxCellMarker.prototype.isValidState = function( state )

Returns true if the given mxCellState is a valid state. If this returns true, then the state is stored in validState. The return value of this method is used as the argument for getMarkerColor.

getMarkerColor

mxCellMarker.prototype.getMarkerColor = function( evt,
state,
isValid )

Returns the valid- or invalidColor depending on the value of isValid. The given mxCellState is ignored by this implementation.

getState

mxCellMarker.prototype.getState = function( me )

Uses getCell, getStateToMark and intersects to return the mxCellState for the given mxMouseEvent.

getCell

mxCellMarker.prototype.getCell = function( me )

Returns the mxCell for the given event and cell. This returns the given cell.

getStateToMark

mxCellMarker.prototype.getStateToMark = function( state )

Returns the mxCellState to be marked for the given mxCellState under the mouse. This returns the given state.

intersects

mxCellMarker.prototype.intersects = function( state,
me )

Returns true if the given coordinate pair intersects the given state. This returns true if the hotspot is 0 or the coordinates are inside the hotspot for the given cell state.

destroy

mxCellMarker.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.