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
TheHoverModelis used to store the current viewer's mouse hover target, i.e. theIVisualPartthat 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.StringHOVER_INTENT_PROPERTYThis property stores the intended hoveredstatic java.lang.StringHOVER_PROPERTYThis 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 voidclearHover()Sets the hovered part tonull.voidclearHoverIntent()Sets the intentionally hovered part tonull.voiddispose()IVisualPart<? extends javafx.scene.Node>getHover()Returns the currently hoveredIVisualPartornullif no visual part is hovered.IContentPart<? extends javafx.scene.Node>getHoverIntent()Returns the current hover intentIContentPartornullif 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.voidsetAdaptable(IViewer adaptable)voidsetHover(IVisualPart<? extends javafx.scene.Node> cp)Sets the hoveredIVisualPartto the given value.voidsetHoverIntent(IContentPart<? extends javafx.scene.Node> cp)Sets the hover intentIContentPartto 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:
disposein interfaceIDisposable- Since:
- 1.1
-
getHover
public IVisualPart<? extends javafx.scene.Node> getHover()
Returns the currently hoveredIVisualPartornullif no visual part is hovered.- Returns:
- the currently hovered
IVisualPartornull
-
getHoverIntent
public IContentPart<? extends javafx.scene.Node> getHoverIntent()
Returns the current hover intentIContentPartornullif no content part is intentionally hovered.- Returns:
- The current hover intent
IContentPartornull
-
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:
setAdaptablein interfaceIAdaptable.Bound<IViewer>- Overrides:
setAdaptablein classIAdaptable.Bound.Impl<IViewer>
-
setHover
public void setHover(IVisualPart<? extends javafx.scene.Node> cp)
Sets the hoveredIVisualPartto the given value. The given part may benullin order to unhover.- Parameters:
cp- hoveredIVisualPartornull
-
setHoverIntent
public void setHoverIntent(IContentPart<? extends javafx.scene.Node> cp)
Sets the hover intentIContentPartto the given value. The given part may benullto indicate unhovering.- Parameters:
cp- The hover intentIContentPartornull.
-
-