org.eclipse.gef4.mvc.viewer

Interface IViewer<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Superinterfaces:

IActivatable, IAdaptable, IDisposable, IPropertyChangeNotifier

All Known Implementing Classes:

AbstractViewer, FXViewer

public interface IViewer<VR>
extends IAdaptable, IActivatable, IDisposable

Noimplement:

This interface is not intended to be implemented by clients. Instead, AbstractViewer should be subclassed.

Nested Class Summary

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

IAdaptable.Bound<A extends IAdaptable>

Field Summary

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

ADAPTERS_PROPERTY

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

ACTIVE_PROPERTY

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>>	getContentPartMap() Returns the Map for registering IContentParts by their content.
IDomain<VR>	getDomain() Returns the IDomain this IViewer is bound to.
IRootPart<VR,? extends VR>	getRootPart() Returns the IRootPart of this viewer.
java.util.Map<VR,IVisualPart<VR,? extends VR>>	getVisualPartMap() Returns the Map for registering IVisualParts by their visual.
void	reveal(IVisualPart<VR,? extends VR> visualPart) Ensure that the visual of the given IVisualPart is visible in this viewer.

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

getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, unsetAdapter

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

activate, deactivate, isActive

Methods inherited from interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.gef4.common.dispose.IDisposable

dispose

Method Detail

getContentPartMap

java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>> getContentPartMap()

Returns the Map for registering IContentParts by their content.

Returns:

The content part map

getDomain

IDomain<VR> getDomain()

Returns the IDomain this IViewer is bound to.

Returns:

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

getRootPart

IRootPart<VR,? extends VR> getRootPart()

Returns the IRootPart of this viewer. The IRootPart is a special IVisualPart that serves as the parent to all contained IContentParts, IHandleParts, and IFeedbackParts.

Returns:

The IRootPart of this viewer.

getVisualPartMap

java.util.Map<VR,IVisualPart<VR,? extends VR>> getVisualPartMap()

Returns the Map for registering IVisualParts by their visual. This map is used for hit-testing. Hit testing is performed by first determining which visual is hit, and then mapping that to an IVisualPart.

Returns:

The visual part map

reveal

void reveal(IVisualPart<VR,? extends VR> visualPart)

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

Parameters:

visualPart - The IVisualPart that is to be revealed.