org.eclipse.gef4.zest.fx.models

Class NavigationModel

java.lang.Object

org.eclipse.gef4.zest.fx.models.NavigationModel

public class NavigationModel
extends java.lang.Object

The NavigationModel manages a Set of Graphs for which the next layout pass should be skipped (due to transformation or navigation changes). Moreover, it manages a Map saving a ViewportModel.ViewportState per Graph, so that the scroll position and zoom factor can be restored when navigating nested graphs.

Constructor Summary

Constructors

Constructor and Description
NavigationModel() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addSkipNextLayout(Graph graph) Adds the given Graph to the Set of Graphs for which the next layout pass is skipped.
ViewportModel.ViewportState	getViewportState(Graph graph) Retrieves the ViewportModel.ViewportState that is currently saved for the given Graph.
boolean	removeSkipNextLayout(Graph graph) Removes the the given Graph from the Set of Graph s for which the next layout pass is skipped.
void	setViewportState(Graph graph, ViewportModel.ViewportState state) Saves the given ViewportModel.ViewportState for the given Graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationModel

public NavigationModel()

Default constructor.

Method Detail

addSkipNextLayout

public void addSkipNextLayout(Graph graph)

Adds the given Graph to the Set of Graphs for which the next layout pass is skipped.

Parameters:

graph - The Graph that is added to the Set of Graphs for which the next layout pass is skipped.

getViewportState

public ViewportModel.ViewportState getViewportState(Graph graph)

Retrieves the ViewportModel.ViewportState that is currently saved for the given Graph.

Parameters:

graph - The Graph of which the saved ViewportModel.ViewportState is returned.

Returns:

The ViewportModel.ViewportState that was saved for the given Graph.

removeSkipNextLayout

public boolean removeSkipNextLayout(Graph graph)

Removes the the given Graph from the Set of Graph s for which the next layout pass is skipped.

Parameters:

graph - The Graph that is removed from the Set of Graphs for which the next layout pass is skipped.

Returns:

true if the the given Graph was contained in the Set, otherwise false.

setViewportState

public void setViewportState(Graph graph,
                             ViewportModel.ViewportState state)

Saves the given ViewportModel.ViewportState for the given Graph.

Parameters:

graph - The Graph for which to save a ViewportModel.ViewportState.

state - The ViewportModel.ViewportState that is saved for the given Graph.