GraphPartitionManager (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.algorithms.GraphPartitionManager

```
public class GraphPartitionManager
extends Object
```
Provides functionality to hide and unhide partitions of nodes and their adjacent edges of a graph temporarily for algorithmic operations.
This class can be used to temporarily hide away certain elements of a graph and to unhide that parts at a later time again. Instances of this class keep track of graph elements that were hidden from a graph in order to make them visible again at a later time.

Note that this class should not be used to hide elements from a Graph2D for pure hiding purposes. Since this class will by default prevent the graph instance from firing events, other code might cease to work correctly. Use this class for short term removal of nodes and edges, only.

Constructor Summary

Constructors
Constructor and Description

GraphPartitionManager(Graph graph, IDataProvider partitionId)
Instantiates a new GraphPartitionManager for the given graph.

Constructors
Constructor and Description
`GraphPartitionManager(Graph graph, IDataProvider partitionId)` Instantiates a new GraphPartitionManager for the given graph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`displayPartition(Object partitionId)` Assures that only nodes are visible in the graph that are associated with the given partitionId.
`Graph`	`getGraph()` Gets the `Graph` for which this partition manager was created.
`void`	`hide(Edge e)` Hides the given edge from the graph.
`void`	`hide(EdgeList el)` Hides the given list of edges from the graph.
`void`	`hide(ICursor cursor)` Hides the given elements from the graph.
`void`	`hide(IEdgeCursor ec)` Hides the given edges from the graph.
`void`	`hide(INodeCursor nc)` Hides the given nodes from the graph.
`void`	`hide(Node v)` Hides the given node and all it's adjacent edges from the graph.
`void`	`hide(NodeList nl)` Hides the given list of nodes from the graph.
`void`	`hideAll()` Hides all nodes and edges from this graph.
`void`	`hideEdges()` Hides all edges from this graph.
`void`	`hideMultipleEdges()` Hides multiple edges from the graph.
`void`	`hidePartition(Object partitionId)` Hides nodes and adjacent edges that have the given partitionId associated.
`void`	`hideSelfLoops()` Hides all self-loop edges from this graph.
`void`	`initPartitions(IDataProvider partitionId)` Initializes internal data structures using the new DataProvider.
`boolean`	`isFiringGraphEventsEnabled()` Gets whether or not this partition manager should fire graph events.
`void`	`setFiringGraphEventsEnabled(boolean value)` Sets whether or not this partition manager should fire graph events.
`void`	`simplifyGraph()` Hides all self-loops and multiple edges from the graph.
`protected void`	`unhide(Edge e)` This method will be called whenever the partition manager is requested to unhide the given edge from the graph.
`protected void`	`unhide(Node v)` This method will be called whenever the partition manager is requested to unhide the given node from the graph.
`void`	`unhideAll()` Unhides all formerly hidden elements in the graph.
`void`	`unhideEdges()` Unhides all formerly hidden edges in the graph.
`void`	`unhideNodes()` Unhides all formerly hidden nodes in the graph.
`void`	`unhidePartition(Object partitionId)` Unhides nodes that have the given partitionId associated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphPartitionManager
```
public GraphPartitionManager(Graph graph,
                             IDataProvider partitionId)
```
    Instantiates a new GraphPartitionManager for the given graph.
    All non-static hiding and unhiding methods will refer to the given graph.
- Method Detail
  - displayPartition
```
public void displayPartition(Object partitionId)
```
    Assures that only nodes are visible in the graph that are associated with the given partitionId.
    
    Parameters:
    
    partitionId - the partitionId for the nodes that will be made visible
  - getGraph
```
public Graph getGraph()
```
    Gets the Graph for which this partition manager was created.
    
    Returns:
    
    the Graph for which this partition manager was created.
  - hide
```
public void hide(Edge e)
```
    Hides the given edge from the graph.
    The hidden edge will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(EdgeList el)
```
    Hides the given list of edges from the graph.
    The hidden edges will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(ICursor cursor)
```
    Hides the given elements from the graph.
    The hidden nodes and adjacent edges will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(IEdgeCursor ec)
```
    Hides the given edges from the graph.
    The hidden edges will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(INodeCursor nc)
```
    Hides the given nodes from the graph.
    The hidden nodes and adjacent edges will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(Node v)
```
    Hides the given node and all it's adjacent edges from the graph.
    The hidden elements will be stored so that they can be unhidden again at a later time.
  - hide
```
public void hide(NodeList nl)
```
    Hides the given list of nodes from the graph.
    The hidden nodes and adjacent edges will be stored so that they can be unhidden again at a later time.
  - hideAll
```
public void hideAll()
```
    Hides all nodes and edges from this graph.
    The hidden elements will be stored so that they can be unhidden again at a later time.
  - hideEdges
```
public void hideEdges()
```
    Hides all edges from this graph.
    The hidden edges will be stored so that they can be unhidden again at a later time.
  - hideMultipleEdges
```
public void hideMultipleEdges()
```
    Hides multiple edges from the graph.
    If there are multiple edges connecting two nodes then all but one (representative) of these edges will be hidden. The hidden edges will be stored so that they can be unhidden again at a later time.
  - hidePartition
```
public void hidePartition(Object partitionId)
```
    Hides nodes and adjacent edges that have the given partitionId associated.
    
    Parameters:
    
    partitionId - the id
  - hideSelfLoops
```
public void hideSelfLoops()
```
    Hides all self-loop edges from this graph.
    The hidden edges will be stored so that they can be unhidden again at a later time.
  - initPartitions
```
public void initPartitions(IDataProvider partitionId)
```
    Initializes internal data structures using the new DataProvider.
    This method must also be called whenever the content of the given DataProvider changes.
    
    Parameters:
    
    partitionId - the data provider that holds the partitionIds for all elements.
  - isFiringGraphEventsEnabled
```
public boolean isFiringGraphEventsEnabled()
```
    Gets whether or not this partition manager should fire graph events.
    By default the partition manager does not fire graph events.
    
    Returns:
    
    The FiringGraphEventsEnabled.
    
    See Also:
    
    setFiringGraphEventsEnabled(boolean)
  - setFiringGraphEventsEnabled
```
public void setFiringGraphEventsEnabled(boolean value)
```
    Sets whether or not this partition manager should fire graph events.
    By default the partition manager does not fire graph events.
    
    Parameters:
    
    value - The FiringGraphEventsEnabled to set.
    
    See Also:
    
    isFiringGraphEventsEnabled()
  - simplifyGraph
```
public void simplifyGraph()
```
    Hides all self-loops and multiple edges from the graph.
    The overall effect of this method is that the minimum number of edges are hidden from the graph such that it contains no self-loops and no multiple edges anymore. The hidden edges will be stored so that they can be unhidden again at a later time.
  - unhide
```
protected void unhide(Edge e)
```
    This method will be called whenever the partition manager is requested to unhide the given edge from the graph.
  - unhide
```
protected void unhide(Node v)
```
    This method will be called whenever the partition manager is requested to unhide the given node from the graph.
  - unhideAll
```
public void unhideAll()
```
    Unhides all formerly hidden elements in the graph.
  - unhideEdges
```
public void unhideEdges()
```
    Unhides all formerly hidden edges in the graph.
    
    Precondition:
    Both source or target node of all such edges must be contained in the graph.
  - unhideNodes
```
public void unhideNodes()
```
    Unhides all formerly hidden nodes in the graph.
    Note that this method does not unhide hidden edges.
  - unhidePartition
```
public void unhidePartition(Object partitionId)
```
    Unhides nodes that have the given partitionId associated.
    
    Parameters:
    
    partitionId - the id

Class GraphPartitionManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphPartitionManager

Method Detail

displayPartition

getGraph

hide

hide

hide

hide

hide

hide

hide

hideAll

hideEdges

hideMultipleEdges

hidePartition

hideSelfLoops

initPartitions

isFiringGraphEventsEnabled

setFiringGraphEventsEnabled

simplifyGraph

unhide

unhide

unhideAll

unhideEdges

unhideNodes

unhidePartition