Interface IViewer

    • 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 registered IContentParts 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()
        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

        java.util.Map<java.lang.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<java.lang.Object> getContents()
        Returns an ObservableList containing the content objects.
        Returns:
        An ObservableList.
      • getVisualPartMap

        java.util.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.
      • 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.
        Returns:
        A ReadOnlyBooleanProperty that represents the "focused" state of this IViewer.
      • 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.
        Returns:
        An unmodifiable read-only map property.