Package com.mxgraph.view
Class mxGraphSelectionModel
java.lang.Object
com.mxgraph.util.mxEventSource
com.mxgraph.view.mxGraphSelectionModel
Implements the selection model for a graph.
This class fires the following events:
mxEvent.UNDO fires after the selection was changed in changeSelection. The
edit
property contains the mxUndoableEdit which contains the
mxSelectionChange.
mxEvent.CHANGE fires after the selection changes by executing an
mxSelectionChange. The added
and removed
properties contain Collections of cells that have been added to or removed
from the selection, respectively.
NOTE: Due to a historic bug that cannot be changed at this point the
names of the properties are "reversed".
To add a change listener to the graph selection model:
addListener(
mxEvent.CHANGE, new mxIEventListener()
{
public void invoke(Object sender, mxEventObject evt)
{
mxGraphSelectionModel model = (mxSelectionModel) sender;
Collection added = (Collection) evt.getProperty("added");
Collection removed = (Collection) evt.getProperty("removed");
selectionChanged(model, added, removed);
}
});
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.mxgraph.util.mxEventSource
mxEventSource.mxIEventListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionHolds the selection cells.protected mxGraph
Reference to the enclosing graph.protected boolean
Specifies if only one selected item at a time is allowed.Fields inherited from class com.mxgraph.util.mxEventSource
eventListeners, eventsEnabled, eventSource
-
Constructor Summary
ConstructorsConstructorDescriptionmxGraphSelectionModel
(mxGraph graph) Constructs a new selection model for the specified graph. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the given cell to the selection.void
protected void
protected void
cellRemoved
(Object cell) protected void
changeSelection
(Collection<Object> added, Collection<Object> removed) void
clear()
Clears the selection.getCell()
Returns the first selected cell.Object[]
getCells()
Returns the selection cells.protected Object
getFirstSelectableCell
(Object[] cells) Returns the first selectable cell in the given array of cells.boolean
isEmpty()
Returns true if no cells are selected.boolean
isSelected
(Object cell) Returns true if the given cell is selected.boolean
void
removeCell
(Object cell) Removes the given cell from the selection.void
removeCells
(Object[] cells) void
Clears the selection and adds the given cell to the selection.void
Clears the selection and adds the given cells.void
setSingleSelection
(boolean singleSelection) int
size()
Returns the number of selected cells.Methods inherited from class com.mxgraph.util.mxEventSource
addListener, fireEvent, fireEvent, getEventSource, isEventsEnabled, removeListener, removeListener, setEventsEnabled, setEventSource
-
Field Details
-
graph
Reference to the enclosing graph. -
singleSelection
protected boolean singleSelectionSpecifies if only one selected item at a time is allowed. Default is false. -
cells
Holds the selection cells.
-
-
Constructor Details
-
mxGraphSelectionModel
Constructs a new selection model for the specified graph.- Parameters:
graph
-
-
-
Method Details
-
isSingleSelection
public boolean isSingleSelection()- Returns:
- the singleSelection
-
setSingleSelection
public void setSingleSelection(boolean singleSelection) - Parameters:
singleSelection
- the singleSelection to set
-
isSelected
Returns true if the given cell is selected.- Parameters:
cell
-- Returns:
- Returns true if the given cell is selected.
-
isEmpty
public boolean isEmpty()Returns true if no cells are selected. -
size
public int size()Returns the number of selected cells. -
clear
public void clear()Clears the selection. -
getCell
Returns the first selected cell. -
getCells
Returns the selection cells. -
setCell
Clears the selection and adds the given cell to the selection. -
setCells
Clears the selection and adds the given cells. -
getFirstSelectableCell
Returns the first selectable cell in the given array of cells.- Parameters:
cells
- Array of cells to return the first selectable cell for.- Returns:
- Returns the first cell that may be selected.
-
addCell
Adds the given cell to the selection. -
addCells
-
removeCell
Removes the given cell from the selection. -
removeCells
-
changeSelection
-
cellAdded
-
cellRemoved
-