VR
- The visual root node of the UI toolkit used, e.g.
javafx.scene.Node in case of JavaFX.public interface IViewer<VR> extends IAdaptable, IActivatable, IDisposable, IAdaptable.Bound<IDomain<VR>>
AbstractViewer
should be subclassed.Type | Property and Description |
---|---|
javafx.beans.property.ReadOnlyBooleanProperty |
viewerFocused
Returns a
ReadOnlyBooleanProperty that represents the "focused"
state of this IViewer . |
adapters
active
adaptable
IAdaptable.Bound<A extends IAdaptable>
IAdaptable.Bound.Impl<T extends IAdaptable>
ADAPTERS_PROPERTY
ACTIVE_PROPERTY
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>> |
getContentPartMap()
Returns the
Map for registering IContentPart s by their
content. |
IDomain<VR> |
getDomain()
|
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 IVisualPart s by their
visual. |
boolean |
isViewerFocused()
Returns the value of the property
viewerFocusedProperty() . |
boolean |
isViewerVisual(VR node)
Returns
true if the given visual is contained within this
IViewer . |
void |
reveal(IVisualPart<VR,? extends VR> visualPart)
Ensure that the visual of the given
IVisualPart is visible in
this viewer. |
javafx.beans.property.ReadOnlyBooleanProperty |
viewerFocusedProperty()
Returns a
ReadOnlyBooleanProperty that represents the "focused"
state of this IViewer . |
adaptersProperty, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, setAdapter, unsetAdapter
activate, activeProperty, deactivate, isActive
dispose
adaptableProperty, getAdaptable, setAdaptable
javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty
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.isViewerFocused()
java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>> getContentPartMap()
Map
for registering IContentPart
s by their
content.IRootPart<VR,? extends VR> getRootPart()
IRootPart
of this viewer. The IRootPart
is a
special IVisualPart
that serves as the parent to all contained
IContentPart
s, IHandlePart
s, and IFeedbackPart
s.IRootPart
of this viewer.java.util.Map<VR,IVisualPart<VR,? extends VR>> getVisualPartMap()
Map
for registering IVisualPart
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 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.
boolean isViewerFocused()
viewerFocusedProperty()
.viewerFocusedProperty()
.boolean isViewerVisual(VR node)
void reveal(IVisualPart<VR,? extends VR> visualPart)
IVisualPart
is visible in
this viewer.visualPart
- The IVisualPart
that is to be revealed.javafx.beans.property.ReadOnlyBooleanProperty viewerFocusedProperty()
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.isViewerFocused()
Copyright (c) 2014 itemis AG and others. All rights reserved.