Package org.jgraph.event
Class GraphSelectionEvent
java.lang.Object
java.util.EventObject
org.jgraph.event.GraphSelectionEvent
- All Implemented Interfaces:
Serializable
An event that characterizes a change in the current selection. The change is
based on any number of cells. GraphSelectionListeners will generally query
the source of the event for the new selected status of each potentially
changed cell.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean[]
For each cell identifies whether or not that cell is newly selected.protected Object[]
Cells this event represents.Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorsConstructorDescriptionGraphSelectionEvent
(Object source, Object[] cells, boolean[] areNew) Represents a change in the selection of a GraphSelectionModel. -
Method Summary
Modifier and TypeMethodDescriptioncloneWithSource
(Object newSource) Returns a copy of the receiver, but with the source being newSource.getCell()
Returns the first cell.Object[]
getCells()
Returns the cells that have been added or removed from the selection.boolean
Returns true if the first cell has been added to the selection, a return value of false means the first cell has been removed from the selection.boolean
isAddedCell
(int index) Returns true if the cell identified byindex
was added to the selection.boolean
isAddedCell
(Object cell) Returns true if the cell identified by cell was added to the selection.Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
cells
Cells this event represents. -
areNew
protected boolean[] areNewFor each cell identifies whether or not that cell is newly selected.
-
-
Constructor Details
-
GraphSelectionEvent
Represents a change in the selection of a GraphSelectionModel.cells
identifies the cells that have been either added or removed from the selection.- Parameters:
source
- source of eventcells
- the paths that have changed in the selectionareNew
- for each cell, defines whether or not that cell is newly selected
-
-
Method Details
-
getCells
Returns the cells that have been added or removed from the selection.- Returns:
- added or removed cells
-
getCell
Returns the first cell.- Returns:
- the first selected cell
-
isAddedCell
public boolean isAddedCell()Returns true if the first cell has been added to the selection, a return value of false means the first cell has been removed from the selection.- Returns:
- whether or not the first cell has been added or removed
-
isAddedCell
Returns true if the cell identified by cell was added to the selection. A return value of false means the cell was in the selection but is no longer in the selection. This will raise if cell is not one of the cells identified by this event.- Parameters:
cell
- the cell that is to be indicated as newly selected or not- Returns:
true
if the specified cell is newly selected
-
isAddedCell
public boolean isAddedCell(int index) Returns true if the cell identified byindex
was added to the selection. A return value of false means the cell was in the selection but is no longer in the selection. This will raise an exception if index invalid input: '<' 0 || >=getPaths
.length.- Parameters:
index
- the index ofareNew
of the cell that is to be indicated as newly selected or not- Returns:
- whether or not the cell is newly selected or not
-
cloneWithSource
Returns a copy of the receiver, but with the source being newSource.- Parameters:
newSource
- the new event source- Returns:
- the cloned event with the specified source
-