org.eclipse.gef4.mvc.fx.viewer

Class FXViewer

java.lang.Object

org.eclipse.gef4.mvc.viewer.AbstractViewer<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.viewer.FXViewer

All Implemented Interfaces:

IActivatable, IAdaptable, IAdaptable.Bound<IDomain<javafx.scene.Node>>, IDisposable, IPropertyChangeNotifier, IViewer<javafx.scene.Node>

public class FXViewer
extends AbstractViewer<javafx.scene.Node>

The FXViewer is an AbstractViewer that is parameterized by Node. It manages a ScrollPaneEx and an FXGridLayer. The scroll pane displays the viewer's contents and adds scrollbars when necessary. The grid layer displays a grid in the background when enabled.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
protected FXGridLayer	gridLayer The FXGridLayer that displays the grid in the background.
protected ScrollPaneEx	scrollPane The ScrollPaneEx that displays the viewer's contents.

Fields inherited from class org.eclipse.gef4.mvc.viewer.AbstractViewer

pcs

Fields inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

ADAPTERS_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FXViewer()

Method Summary

Modifier and Type	Method and Description
FXDomain	getDomain() Returns the IDomain this IViewer is bound to.
FXGridLayer	getGridLayer() Returns the FXGridLayer that is managed by this FXViewer.
javafx.scene.Scene	getScene() Returns the Scene in which the ScrollPaneEx of this FXViewer is displayed.
ScrollPaneEx	getScrollPane() Returns the ScrollPaneEx that is managed by this FXViewer .
void	reveal(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> visualPart) Ensure that the visual of the given IVisualPart is visible in this viewer.

Methods inherited from class org.eclipse.gef4.mvc.viewer.AbstractViewer

activate, addPropertyChangeListener, deactivate, dispose, getAdaptable, getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, getContentPartMap, getRootPart, getVisualPartMap, isActive, removePropertyChangeListener, setAdaptable, setAdapter, setAdapter, setAdapter, setAdapters, unsetAdapter

Methods inherited from class java.lang.Object

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

Field Detail

scrollPane

protected ScrollPaneEx scrollPane

The ScrollPaneEx that displays the viewer's contents.

gridLayer

protected FXGridLayer gridLayer

The FXGridLayer that displays the grid in the background.

Constructor Detail

FXViewer

public FXViewer()

Method Detail

getDomain

public FXDomain getDomain()

Description copied from interface: IViewer

Returns the IDomain this IViewer is bound to.

Specified by:

getDomain in interface IViewer<javafx.scene.Node>

Overrides:

getDomain in class AbstractViewer<javafx.scene.Node>

Returns:

The IDomain this IViewer is bound to, or null if this IViewer is not (yet) bound to an IDomain.

See Also:

IViewer.getDomain()

getGridLayer

public FXGridLayer getGridLayer()

Returns the FXGridLayer that is managed by this FXViewer.

Returns:

The FXGridLayer that is managed by this FXViewer.

getScene

public javafx.scene.Scene getScene()

Returns the Scene in which the ScrollPaneEx of this FXViewer is displayed.

Returns:

The Scene in which the ScrollPaneEx of this FXViewer is displayed.

getScrollPane

public ScrollPaneEx getScrollPane()

Returns the ScrollPaneEx that is managed by this FXViewer .

Returns:

The ScrollPaneEx that is managed by this FXViewer .

reveal

public void reveal(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> visualPart)

Description copied from interface: IViewer

Ensure that the visual of the given IVisualPart is visible in this viewer.

Parameters:

visualPart - The IVisualPart that is to be revealed.