org.eclipse.gef4.zest.fx.policies

Class NavigationPolicy

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<javafx.scene.Node>

org.eclipse.gef4.zest.fx.policies.NavigationPolicy

All Implemented Interfaces:

IAdaptable.Bound<IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>>, ITransactional, IPolicy<javafx.scene.Node>

public class NavigationPolicy
extends AbstractPolicy<javafx.scene.Node>
implements ITransactional

The NavigationPolicy is a transactional policy that can be used to navigate between Graphs in a nested Graphs scenario. It saves the layout and viewport of the current Graph when opening another Graph and restores those values when navigating back to the Graph.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized Stores the initialized flag for this policy, i.e.

Constructor Summary

Constructors

Constructor and Description
NavigationPolicy()

Method Summary

Modifier and Type	Method and Description
IUndoableOperation	commit()
void	init()
protected void	openGraph(Graph currentGraph, Graph newGraph, boolean resetNewGraphViewport) Saves the layout and viewport for the currentGraph, loads the layout and viewport of the newGraph, and changes the viewer contents.
void	openNestedGraph(Graph newGraph) Opens the given Graph without restoring the viewport that was saved for that Graph.
void	openNestingGraph(Graph newGraph) Opens the given Graph and restores the viewport that was saved for that Graph.

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractPolicy

commit, disableRefreshVisuals, enableRefreshVisuals, getAdaptable, getHost, init, setAdaptable

Methods inherited from class java.lang.Object

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

Field Detail

initialized

protected boolean initialized

Stores the initialized flag for this policy, i.e. true after init() was called, and false after commit() was called, respectively.

Constructor Detail

NavigationPolicy

public NavigationPolicy()

Method Detail

commit

public IUndoableOperation commit()

Specified by:

commit in interface ITransactional

init

public void init()

Specified by:

init in interface ITransactional

openGraph

protected void openGraph(Graph currentGraph,
                         Graph newGraph,
                         boolean resetNewGraphViewport)

Saves the layout and viewport for the currentGraph, loads the layout and viewport of the newGraph, and changes the viewer contents. If the resetNewGraphViewport flag is set to true, then the viewport that was saved for newGraph will not be restored, but instead it will be reset.

Parameters:

currentGraph - The currently open Graph of which the layout and viewport and saved.

newGraph - The new Graph that is opened.

resetNewGraphViewport - true if the viewport that was saved for newGraph should not be restored, otherwise false.

openNestedGraph

public void openNestedGraph(Graph newGraph)

Opens the given Graph without restoring the viewport that was saved for that Graph.

Parameters:

newGraph - The Graph to open.

openNestingGraph

public void openNestingGraph(Graph newGraph)

Opens the given Graph and restores the viewport that was saved for that Graph.

Parameters:

newGraph - The Graph to open.