com.yworks.yfiles.view

Class GraphSelection

java.lang.Object

com.yworks.yfiles.view.GraphSelection

All Implemented Interfaces:

IEnumerable<IModelItem>, IGraphSelection, ISelectionModel<IModelItem>, Iterable<IModelItem>

public class GraphSelection
extends Object
implements IGraphSelection, IEnumerable<IModelItem>

Simple implementation of the IGraphSelection interface.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEnumerable

EMPTY

Constructor Summary

Constructors

Constructor and Description
GraphSelection() Creates a new instance with no initial Graph assigned.
GraphSelection(IGraph graph) Instantiates an instance using the the graph as the model.

Method Summary

Modifier and Type	Method and Description
void	addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IModelItem>> itemSelectionChangedEvent) Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	clear() Clears the selection.
protected DefaultSelectionModel<IBend>	createBendSelectionModel() Factory method that creates the DefaultSelectionModel to use for the bends.
protected DefaultSelectionModel<IEdge>	createEdgeSelectionModel() Factory method that creates the DefaultSelectionModel to use for the edges.
protected DefaultSelectionModel<ILabel>	createLabelSelectionModel() Factory method that creates the DefaultSelectionModel to use for the labels.
protected DefaultSelectionModel<INode>	createNodeSelectionModel() Factory method that creates the DefaultSelectionModel to use for the nodes.
protected DefaultSelectionModel<IPort>	createPortSelectionModel() Factory method that creates the DefaultSelectionModel to use for the ports.
IEnumerator<IModelItem>	enumerator() Returns an enumerator that iterates through the collection of all selected elements.
IGraph	getGraph() Gets the IGraph this instance is using as the domain for the selection.
ISelectionModel<IBend>	getSelectedBends() An ISelectionModel of the selected bends.
ISelectionModel<IEdge>	getSelectedEdges() An ISelectionModel of the selected edges.
ISelectionModel<ILabel>	getSelectedLabels() An ISelectionModel of the selected labels.
ISelectionModel<INode>	getSelectedNodes() An ISelectionModel of the selected nodes.
ISelectionModel<IPort>	getSelectedPorts() An ISelectionModel of the selected ports.
boolean	isSelected(IModelItem item) Determines whether an item is currently selected.
protected void	onItemSelectionChanged(ItemSelectionChangedEventArgs<IModelItem> args) Raises the ItemSelectionChanged event.
void	removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IModelItem>> itemSelectionChangedEvent) Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	setGraph(IGraph value) Sets the IGraph this instance is using as the domain for the selection.
void	setSelected(IModelItem item, boolean selected) Sets the selection state of an item.
int	size() Returns the number of selected items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

concat, concat, create, create, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GraphSelection

public GraphSelection()

Creates a new instance with no initial Graph assigned.

In order to be always in sync with the structural changes in a graph, an instance should be associated with an IGraph using the Graph property.

GraphSelection

public GraphSelection(IGraph graph)

Instantiates an instance using the the graph as the model.

Method Detail

addItemSelectionChangedListener

public final void addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IModelItem>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

addItemSelectionChangedListener in interface ISelectionModel<IModelItem>

Parameters:

itemSelectionChangedEvent - The listener to add.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.removeItemSelectionChangedListener(IEventHandler)

clear

public final void clear()

Description copied from interface: ISelectionModel

Clears the selection.

This is a convenience method that will set the selection state of all elements to unselected.

Specified by:

clear in interface ISelectionModel<IModelItem>

See Also:

ISelectionModel.addItemSelectionChangedListener(IEventHandler)

createBendSelectionModel

protected DefaultSelectionModel<IBend> createBendSelectionModel()

Factory method that creates the DefaultSelectionModel to use for the bends.

createEdgeSelectionModel

protected DefaultSelectionModel<IEdge> createEdgeSelectionModel()

Factory method that creates the DefaultSelectionModel to use for the edges.

createLabelSelectionModel

protected DefaultSelectionModel<ILabel> createLabelSelectionModel()

Factory method that creates the DefaultSelectionModel to use for the labels.

createNodeSelectionModel

protected DefaultSelectionModel<INode> createNodeSelectionModel()

Factory method that creates the DefaultSelectionModel to use for the nodes.

createPortSelectionModel

protected DefaultSelectionModel<IPort> createPortSelectionModel()

Factory method that creates the DefaultSelectionModel to use for the ports.

enumerator

public final IEnumerator<IModelItem> enumerator()

Returns an enumerator that iterates through the collection of all selected elements.

Specified by:

enumerator in interface IEnumerable<IModelItem>

Returns:

An IEnumerator object that can be used to iterate through all selected elements.

getGraph

public final IGraph getGraph()

Gets the IGraph this instance is using as the domain for the selection.

Returns:

The Graph.

See Also:

setGraph(IGraph)

getSelectedBends

public final ISelectionModel<IBend> getSelectedBends()

Description copied from interface: IGraphSelection

An ISelectionModel of the selected bends.

This is the bend part of the selection that this instance is a composite of.

Specified by:

getSelectedBends in interface IGraphSelection

Returns:

The SelectedBends.

getSelectedEdges

public final ISelectionModel<IEdge> getSelectedEdges()

Description copied from interface: IGraphSelection

An ISelectionModel of the selected edges.

This is the edge part of the selection that this instance is a composite of.

Specified by:

getSelectedEdges in interface IGraphSelection

Returns:

The SelectedEdges.

getSelectedLabels

public final ISelectionModel<ILabel> getSelectedLabels()

Description copied from interface: IGraphSelection

An ISelectionModel of the selected labels.

This is the label part of the selection that this instance is a composite of.

Specified by:

getSelectedLabels in interface IGraphSelection

Returns:

The SelectedLabels.

getSelectedNodes

public final ISelectionModel<INode> getSelectedNodes()

Description copied from interface: IGraphSelection

An ISelectionModel of the selected nodes.

This is the node part of the selection that this instance is a composite of.

Specified by:

getSelectedNodes in interface IGraphSelection

Returns:

The SelectedNodes.

getSelectedPorts

public final ISelectionModel<IPort> getSelectedPorts()

Description copied from interface: IGraphSelection

An ISelectionModel of the selected ports.

This is the ports part of the selection that this instance is a composite of.

Specified by:

getSelectedPorts in interface IGraphSelection

Returns:

The SelectedPorts.

isSelected

public boolean isSelected(IModelItem item)

Description copied from interface: ISelectionModel

Determines whether an item is currently selected.

Specified by:

isSelected in interface ISelectionModel<IModelItem>

Parameters:

item - The item to check.

Returns:

Whether it is currently selected.

onItemSelectionChanged

protected void onItemSelectionChanged(ItemSelectionChangedEventArgs<IModelItem> args)

Raises the ItemSelectionChanged event.

Parameters:

args - The parameters for the event

removeItemSelectionChangedListener

public final void removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IModelItem>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

removeItemSelectionChangedListener in interface ISelectionModel<IModelItem>

Parameters:

itemSelectionChangedEvent - The listener to remove.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.addItemSelectionChangedListener(IEventHandler)

setGraph

public final void setGraph(IGraph value)

Sets the IGraph this instance is using as the domain for the selection.

Parameters:

value - The Graph to set.

See Also:

getGraph()

setSelected

public void setSelected(IModelItem item,
                        boolean selected)

Description copied from interface: ISelectionModel

Sets the selection state of an item.

If the state changes, this will trigger the ItemSelectionChanged event.

Specified by:

setSelected in interface ISelectionModel<IModelItem>

Parameters:

item - The item to set the selection state for.

selected - Whether to select the object.

size

public final int size()

Description copied from interface: ISelectionModel

Returns the number of selected items.

Specified by:

size in interface ISelectionModel<IModelItem>

Returns:

The Count.