Class mxGraphSelectionModel

java.lang.Object
com.mxgraph.util.mxEventSource
com.mxgraph.view.mxGraphSelectionModel
public class mxGraphSelectionModel extends mxEventSource
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); } });

  • Field Details

    • graph

      protected mxGraph graph
      Reference to the enclosing graph.

    • singleSelection

      protected boolean singleSelection
      Specifies if only one selected item at a time is allowed. Default is false.

    • cells

      protected Set<Object> cells
      Holds the selection cells.

  • Constructor Details

    • mxGraphSelectionModel

      public mxGraphSelectionModel(mxGraph graph)
      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

      public boolean isSelected(Object cell)
      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

      public Object getCell()
      Returns the first selected cell.

    • getCells

      public Object[] getCells()
      Returns the selection cells.

    • setCell

      public void setCell(Object cell)
      Clears the selection and adds the given cell to the selection.

    • setCells

      public void setCells(Object[] cells)
      Clears the selection and adds the given cells.

    • getFirstSelectableCell

      protected Object getFirstSelectableCell(Object[] cells)
      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

      public void addCell(Object cell)
      Adds the given cell to the selection.

    • addCells

      public void addCells(Object[] cells)

    • removeCell

      public void removeCell(Object cell)
      Removes the given cell from the selection.

    • removeCells

      public void removeCells(Object[] cells)

    • changeSelection

      protected void changeSelection(Collection<Object> added, Collection<Object> removed)

    • cellAdded

      protected void cellAdded(Object cell)

    • cellRemoved

      protected void cellRemoved(Object cell)