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>
The IViewer interface specifies all services that a viewer needs to provide. One application (within one IDomain) can be consisting of multiple viewers. Each viewer maintains its own getContentPartMap() and getVisualPartMap() 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.

  • Property Details

    • contentPartMap

      javafx.beans.property.ReadOnlyMapProperty<Object,IContentPart<? extends javafx.scene.Node>> contentPartMapProperty
      Returns an unmodifiable read-only map property that contains the registered IContentParts mapped to their respective content.
      See Also:

    • contents

      javafx.beans.property.ReadOnlyListProperty<Object> contentsProperty
      A read-only property containing the current content objects.
      See Also:

    • viewerFocused

      javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty
      Returns a ReadOnlyBooleanProperty that represents the "focused" state of this IViewer. An IViewer is focused when its visualization has keyboard focus and its window is active, i.e. it is focused if it will receive keyboard events.
      See Also:

    • visualPartMap

      javafx.beans.property.ReadOnlyMapProperty<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> visualPartMapProperty
      Returns an unmodifiable read-only map property that contains the registered IVisualParts mapped to their respective visual.
      See Also:

  • Field Details

  • Method Details

    • contentPartMapProperty

      javafx.beans.property.ReadOnlyMapProperty<Object,IContentPart<? extends javafx.scene.Node>> contentPartMapProperty()
      Returns an unmodifiable read-only map property that contains the registered IContentParts mapped to their respective content.
      See Also:

    • contentsProperty

      javafx.beans.property.ReadOnlyListProperty<Object> contentsProperty()
      A read-only property containing the current content objects.
      See Also:

    • getCanvas

      javafx.scene.Parent getCanvas()
      Returns the Parent that displays the visuals of this viewer's parts
      Returns:
      The Parent that displays the visuals of the viewer's parts.

    • getContentPartMap

      Map<Object,IContentPart<? extends javafx.scene.Node>> getContentPartMap()
      Returns the Map for registering IContentParts by their content.
      Returns:
      The content part map

    • getContents

      javafx.collections.ObservableList<Object> getContents()
      Returns an ObservableList containing the content objects.
      Returns:
      An ObservableList.

    • getDomain

      IDomain 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<? extends javafx.scene.Node> 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

      Map<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> 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.

      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 an IVisualPart only has to register its "main" visual (i.e. the one returned by IVisualPart.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 property viewerFocusedProperty().
      Returns:
      The value of the property viewerFocusedProperty().

    • reveal

      void reveal(IVisualPart<? extends javafx.scene.Node> visualPart)
      Ensure that the visual of the given IVisualPart is visible in this viewer.
      Parameters:
      visualPart - The IVisualPart that is to be revealed.

    • viewerFocusedProperty

      javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty()
      Returns a ReadOnlyBooleanProperty that represents the "focused" state of this IViewer. An IViewer is focused when its visualization has keyboard focus and its window is active, i.e. it is focused if it will receive keyboard events.
      See Also:

    • visualPartMapProperty

      javafx.beans.property.ReadOnlyMapProperty<javafx.scene.Node,IVisualPart<? extends javafx.scene.Node>> visualPartMapProperty()
      Returns an unmodifiable read-only map property that contains the registered IVisualParts mapped to their respective visual.
      See Also: