Package org.eclipse.gef.mvc.fx.models
Class HoverModel
- java.lang.Object
-
- org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl<IViewer>
-
- org.eclipse.gef.mvc.fx.models.HoverModel
-
- All Implemented Interfaces:
IAdaptable.Bound<IViewer>
,IDisposable
public class HoverModel extends IAdaptable.Bound.Impl<IViewer> implements IDisposable
TheHoverModel
is used to store the current viewer's mouse hover target, i.e. theIVisualPart
that is currently under the mouse cursor.
-
-
Nested Class Summary
-
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
HOVER_INTENT_PROPERTY
This property stores the intended hoveredstatic java.lang.String
HOVER_PROPERTY
This is the name of the property that stores the currently hoveredIVisualPart
.
-
Constructor Summary
Constructors Constructor Description HoverModel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearHover()
Sets the hovered part tonull
.void
clearHoverIntent()
Sets the intentionally hovered part tonull
.void
dispose()
IVisualPart<? extends javafx.scene.Node>
getHover()
Returns the currently hoveredIVisualPart
ornull
if no visual part is hovered.IContentPart<? extends javafx.scene.Node>
getHoverIntent()
Returns the current hover intentIContentPart
ornull
if no content part is intentionally hovered.javafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>>
hoverIntentProperty()
Returns an object property representing the hover intent part.javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>>
hoverProperty()
Returns an object property representing the current hover part.void
setAdaptable(IViewer adaptable)
void
setHover(IVisualPart<? extends javafx.scene.Node> cp)
Sets the hoveredIVisualPart
to the given value.void
setHoverIntent(IContentPart<? extends javafx.scene.Node> cp)
Sets the hover intentIContentPart
to the given value.-
Methods inherited from class org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl
adaptableProperty, getAdaptable
-
-
-
-
Field Detail
-
HOVER_PROPERTY
public static final java.lang.String HOVER_PROPERTY
This is the name of the property that stores the currently hoveredIVisualPart
.- See Also:
- Constant Field Values
-
HOVER_INTENT_PROPERTY
public static final java.lang.String HOVER_INTENT_PROPERTY
This property stores the intended hovered- See Also:
- Constant Field Values
-
-
Method Detail
-
clearHover
public void clearHover()
Sets the hovered part tonull
.
-
clearHoverIntent
public void clearHoverIntent()
Sets the intentionally hovered part tonull
.
-
dispose
public void dispose()
- Specified by:
dispose
in interfaceIDisposable
- Since:
- 1.1
-
getHover
public IVisualPart<? extends javafx.scene.Node> getHover()
Returns the currently hoveredIVisualPart
ornull
if no visual part is hovered.- Returns:
- the currently hovered
IVisualPart
ornull
-
getHoverIntent
public IContentPart<? extends javafx.scene.Node> getHoverIntent()
Returns the current hover intentIContentPart
ornull
if no content part is intentionally hovered.- Returns:
- The current hover intent
IContentPart
ornull
-
hoverIntentProperty
public javafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>> hoverIntentProperty()
Returns an object property representing the hover intent part.- Returns:
- A property named
HOVER_INTENT_PROPERTY
.
-
hoverProperty
public javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>> hoverProperty()
Returns an object property representing the current hover part.- Returns:
- A property named
HOVER_PROPERTY
.
-
setAdaptable
public void setAdaptable(IViewer adaptable)
- Specified by:
setAdaptable
in interfaceIAdaptable.Bound<IViewer>
- Overrides:
setAdaptable
in classIAdaptable.Bound.Impl<IViewer>
-
setHover
public void setHover(IVisualPart<? extends javafx.scene.Node> cp)
Sets the hoveredIVisualPart
to the given value. The given part may benull
in order to unhover.- Parameters:
cp
- hoveredIVisualPart
ornull
-
setHoverIntent
public void setHoverIntent(IContentPart<? extends javafx.scene.Node> cp)
Sets the hover intentIContentPart
to the given value. The given part may benull
to indicate unhovering.- Parameters:
cp
- The hover intentIContentPart
ornull
.
-
-