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>
TheIViewerinterface 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,
InfiniteCanvasViewershould 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.StringCONTENT_PART_MAP_PROPERTYName of thecontentPartMapProperty().static java.lang.StringCONTENTS_PROPERTYName of thecontentsProperty().static java.lang.StringVISUAL_PART_MAP_PROPERTYName 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 registeredIContentParts mapped to their respective content.javafx.beans.property.ReadOnlyListProperty<java.lang.Object>contentsProperty()A read-only property containing the current content objects.javafx.scene.ParentgetCanvas()java.util.Map<java.lang.Object,IContentPart<? extends javafx.scene.Node>>getContentPartMap()Returns theMapfor registeringIContentParts by their content.javafx.collections.ObservableList<java.lang.Object>getContents()Returns anObservableListcontaining the content objects.IDomaingetDomain()IRootPart<? extends javafx.scene.Node>getRootPart()Returns theIRootPartof this viewer.java.util.Map<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>>getVisualPartMap()Returns theMapfor registeringIVisualParts by their visual.booleanisViewerFocused()Returns the value of the propertyviewerFocusedProperty().voidreveal(IVisualPart<? extends javafx.scene.Node> visualPart)Ensure that the visual of the givenIVisualPartis visible in this viewer.javafx.beans.property.ReadOnlyBooleanPropertyviewerFocusedProperty()Returns aReadOnlyBooleanPropertythat 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 registeredIVisualParts 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 registeredIContentParts 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 theMapfor registeringIContentParts by their content.- Returns:
- The content part map
-
getContents
javafx.collections.ObservableList<java.lang.Object> getContents()
Returns anObservableListcontaining the content objects.- Returns:
- An
ObservableList.
-
getDomain
IDomain getDomain()
-
getRootPart
IRootPart<? extends javafx.scene.Node> getRootPart()
Returns theIRootPartof this viewer. TheIRootPartis a specialIVisualPartthat serves as the parent to all containedIContentParts,IHandleParts, andIFeedbackParts.- Returns:
- The
IRootPartof this viewer.
-
getVisualPartMap
java.util.Map<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> getVisualPartMap()
Returns theMapfor registeringIVisualParts 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
IVisualPartfor a given visual in the map, it is required to walk up the visual hierarchy until a registered visual is found, because anIVisualPartonly 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 givenIVisualPartis visible in this viewer.- Parameters:
visualPart- TheIVisualPartthat is to be revealed.
-
viewerFocusedProperty
javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty()
Returns aReadOnlyBooleanPropertythat represents the "focused" state of thisIViewer. AnIVieweris 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
ReadOnlyBooleanPropertythat 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 registeredIVisualParts mapped to their respective visual.- Returns:
- An unmodifiable read-only map property.
-
-