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
The
HoverModel is used to store the current viewer's mouse hover
target, i.e. the IVisualPart that is currently under the mouse
cursor.-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>>Returns an object property representing the hover intent part.javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>>Returns an object property representing the current hover part.Properties inherited from class org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl
adaptable -
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound
IAdaptable.Bound.Impl<T extends IAdaptable> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThis property stores the intended hoveredstatic final StringThis is the name of the property that stores the currently hoveredIVisualPart. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidSets the hovered part tonull.voidSets 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>Returns the current hover intentIContentPartornullif no content part is intentionally hovered.javafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>>Returns an object property representing the hover intent part.javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>>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
-
Property Details
-
hoverIntent
public javafx.beans.property.ObjectProperty<IContentPart<? extends javafx.scene.Node>> hoverIntentPropertyReturns an object property representing the hover intent part.- See Also:
-
hover
Returns an object property representing the current hover part.- See Also:
-
-
Field Details
-
HOVER_PROPERTY
This is the name of the property that stores the currently hoveredIVisualPart.- See Also:
-
HOVER_INTENT_PROPERTY
This property stores the intended hovered- See Also:
-
-
Constructor Details
-
HoverModel
public HoverModel()
-
-
Method Details
-
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
Returns the currently hoveredIVisualPartornullif no visual part is hovered.- Returns:
- the currently hovered
IVisualPartornull
-
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.- See Also:
-
hoverProperty
public javafx.beans.property.ObjectProperty<IVisualPart<? extends javafx.scene.Node>> hoverProperty()Returns an object property representing the current hover part.- See Also:
-
setAdaptable
- Specified by:
setAdaptablein interfaceIAdaptable.Bound<IViewer>- Overrides:
setAdaptablein classIAdaptable.Bound.Impl<IViewer>
-
setHover
Sets the hoveredIVisualPartto the given value. The given part may benullin order to unhover.- Parameters:
cp- hoveredIVisualPartornull
-
setHoverIntent
Sets the hover intentIContentPartto the given value. The given part may benullto indicate unhovering.- Parameters:
cp- The hover intentIContentPartornull.
-