Package org.eclipse.gef.mvc.fx.viewer
Interface IViewer
-
- All Superinterfaces:
IActivatable
,IAdaptable
,IAdaptable.Bound<IDomain>
,IDisposable
- All Known Implementing Classes:
InfiniteCanvasViewer
public interface IViewer extends IAdaptable, IActivatable, IDisposable, IAdaptable.Bound<IDomain>
TheIViewer
interface specifies all services that a viewer needs to provide. One application (within oneIDomain
) can be consisting of multiple viewers. Each viewer maintains its owngetContentPartMap()
andgetVisualPartMap()
that can be used to navigate from/to content, controller, and visual objects.- Noimplement:
- This interface is not intended to be implemented by clients.
Instead,
InfiniteCanvasViewer
should be subclassed.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.gef.common.adapt.IAdaptable
IAdaptable.Bound<A extends IAdaptable>
-
Nested classes/interfaces inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound
IAdaptable.Bound.Impl<T extends IAdaptable>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTENT_PART_MAP_PROPERTY
Name of thecontentPartMapProperty()
.static java.lang.String
CONTENTS_PROPERTY
Name of thecontentsProperty()
.static java.lang.String
VISUAL_PART_MAP_PROPERTY
Name of thevisualPartMapProperty()
.-
Fields inherited from interface org.eclipse.gef.common.activate.IActivatable
ACTIVE_PROPERTY
-
Fields inherited from interface org.eclipse.gef.common.adapt.IAdaptable
ADAPTERS_PROPERTY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javafx.beans.property.ReadOnlyMapProperty<java.lang.Object,IContentPart<? extends javafx.scene.Node>>
contentPartMapProperty()
Returns an unmodifiable read-only map property that contains the registeredIContentPart
s mapped to their respective content.javafx.beans.property.ReadOnlyListProperty<java.lang.Object>
contentsProperty()
A read-only property containing the current content objects.javafx.scene.Parent
getCanvas()
java.util.Map<java.lang.Object,IContentPart<? extends javafx.scene.Node>>
getContentPartMap()
Returns theMap
for registeringIContentPart
s by their content.javafx.collections.ObservableList<java.lang.Object>
getContents()
Returns anObservableList
containing the content objects.IDomain
getDomain()
IRootPart<? extends javafx.scene.Node>
getRootPart()
Returns theIRootPart
of this viewer.java.util.Map<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>>
getVisualPartMap()
Returns theMap
for registeringIVisualPart
s by their visual.boolean
isViewerFocused()
Returns the value of the propertyviewerFocusedProperty()
.void
reveal(IVisualPart<? extends javafx.scene.Node> visualPart)
Ensure that the visual of the givenIVisualPart
is visible in this viewer.javafx.beans.property.ReadOnlyBooleanProperty
viewerFocusedProperty()
Returns aReadOnlyBooleanProperty
that represents the "focused" state of thisIViewer
.javafx.beans.property.ReadOnlyMapProperty<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>>
visualPartMapProperty()
Returns an unmodifiable read-only map property that contains the registeredIVisualPart
s mapped to their respective visual.-
Methods inherited from interface org.eclipse.gef.common.activate.IActivatable
activate, activeProperty, deactivate, isActive
-
Methods inherited from interface org.eclipse.gef.common.adapt.IAdaptable
adaptersProperty, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, setAdapter, unsetAdapter
-
Methods inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound
adaptableProperty, getAdaptable, setAdaptable
-
Methods inherited from interface org.eclipse.gef.common.dispose.IDisposable
dispose
-
-
-
-
Field Detail
-
CONTENTS_PROPERTY
static final java.lang.String CONTENTS_PROPERTY
Name of thecontentsProperty()
.- See Also:
- Constant Field Values
-
CONTENT_PART_MAP_PROPERTY
static final java.lang.String CONTENT_PART_MAP_PROPERTY
Name of thecontentPartMapProperty()
.- See Also:
- Constant Field Values
-
VISUAL_PART_MAP_PROPERTY
static final java.lang.String VISUAL_PART_MAP_PROPERTY
Name of thevisualPartMapProperty()
.- See Also:
- Constant Field Values
-
-
Method Detail
-
contentPartMapProperty
javafx.beans.property.ReadOnlyMapProperty<java.lang.Object,IContentPart<? extends javafx.scene.Node>> contentPartMapProperty()
Returns an unmodifiable read-only map property that contains the registeredIContentPart
s mapped to their respective content.- Returns:
- An unmodifiable read-only map property.
-
contentsProperty
javafx.beans.property.ReadOnlyListProperty<java.lang.Object> contentsProperty()
A read-only property containing the current content objects.- Returns:
- A read-only list property named
CONTENTS_PROPERTY
.
-
getCanvas
javafx.scene.Parent getCanvas()
-
getContentPartMap
java.util.Map<java.lang.Object,IContentPart<? extends javafx.scene.Node>> getContentPartMap()
Returns theMap
for registeringIContentPart
s by their content.- Returns:
- The content part map
-
getContents
javafx.collections.ObservableList<java.lang.Object> getContents()
Returns anObservableList
containing the content objects.- Returns:
- An
ObservableList
.
-
getDomain
IDomain getDomain()
-
getRootPart
IRootPart<? extends javafx.scene.Node> getRootPart()
Returns theIRootPart
of this viewer. TheIRootPart
is a specialIVisualPart
that serves as the parent to all containedIContentPart
s,IHandlePart
s, andIFeedbackPart
s.- Returns:
- The
IRootPart
of this viewer.
-
getVisualPartMap
java.util.Map<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> getVisualPartMap()
Returns theMap
for registeringIVisualPart
s 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 anIVisualPart
.Note, that when looking up an
IVisualPart
for a given visual in the map, it is required to walk up the visual hierarchy until a registered visual is found, because anIVisualPart
only has to register its "main" visual (i.e. the one returned byIVisualPart.getVisual()
) at the visual-part-map, but potential children visuals do not have to be registered.- Returns:
- The visual-to-visual-part map.
-
isViewerFocused
boolean isViewerFocused()
Returns the value of the propertyviewerFocusedProperty()
.- Returns:
- The value of the property
viewerFocusedProperty()
.
-
reveal
void reveal(IVisualPart<? extends javafx.scene.Node> visualPart)
Ensure that the visual of the givenIVisualPart
is visible in this viewer.- Parameters:
visualPart
- TheIVisualPart
that is to be revealed.
-
viewerFocusedProperty
javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty()
Returns aReadOnlyBooleanProperty
that represents the "focused" state of thisIViewer
. AnIViewer
is focused when its visualization has keyboard focus and its window is active, i.e. it is focused if it will receive keyboard events.- Returns:
- A
ReadOnlyBooleanProperty
that represents the "focused" state of thisIViewer
.
-
visualPartMapProperty
javafx.beans.property.ReadOnlyMapProperty<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> visualPartMapProperty()
Returns an unmodifiable read-only map property that contains the registeredIVisualPart
s mapped to their respective visual.- Returns:
- An unmodifiable read-only map property.
-
-