org.eclipse.fx.ui.controls.styledtext.events

Class TextHoverEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.MouseEvent

org.eclipse.fx.ui.controls.styledtext.events.TextHoverEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TextHoverEvent
extends javafx.scene.input.MouseEvent

A text hover event sent when hovering text

This is an experimental component provided as a preview we'll improve and fix problems in up coming releases

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.event.EventType<TextHoverEvent>	HOVER Hover event type

Fields inherited from class javafx.scene.input.MouseEvent

ANY, DRAG_DETECTED, MOUSE_CLICKED, MOUSE_DRAGGED, MOUSE_ENTERED, MOUSE_ENTERED_TARGET, MOUSE_EXITED, MOUSE_EXITED_TARGET, MOUSE_MOVED, MOUSE_PRESSED, MOUSE_RELEASED

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TextHoverEvent(javafx.scene.input.MouseEvent event, int offsetTokenStart, int offsetTokenEnd, int offset, java.lang.String tokenText) Create a new hover event from the original mouse event
TextHoverEvent(javafx.scene.input.MouseEvent source, java.util.List<HoverTarget> hoverTargets)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<HoverTarget>	getHoverTargets()
int	getOffset()
int	getOffsetTokenEnd()
int	getOffsetTokenStart()
java.lang.String	getTokenText()
int	hashCode()

Methods inherited from class javafx.scene.input.MouseEvent

copyFor, copyFor, copyForMouseDragEvent, getButton, getClickCount, getEventType, getPickResult, getSceneX, getSceneY, getScreenX, getScreenY, getX, getY, getZ, isAltDown, isControlDown, isDragDetect, isMetaDown, isMiddleButtonDown, isPopupTrigger, isPrimaryButtonDown, isSecondaryButtonDown, isShiftDown, isShortcutDown, isStillSincePress, isSynthesized, setDragDetect, toString

Methods inherited from class javafx.event.Event

clone, consume, fireEvent, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HOVER

public static final javafx.event.EventType<TextHoverEvent> HOVER

Hover event type

Constructor Detail

TextHoverEvent

public TextHoverEvent(javafx.scene.input.MouseEvent source,
                      java.util.List<HoverTarget> hoverTargets)

TextHoverEvent

public TextHoverEvent(javafx.scene.input.MouseEvent event,
                      int offsetTokenStart,
                      int offsetTokenEnd,
                      int offset,
                      java.lang.String tokenText)

Create a new hover event from the original mouse event

Parameters:

event - the event

offsetTokenStart - the start offset from the token hovering (might be -1 to indicate no valid region was found)

offsetTokenEnd - the end offset from the token hovering (might be -1 to indicate no valid region was found)

offset - the offset in the text (might be -1 to indicate no valid region was found)

tokenText - the token text

Method Detail

getHoverTargets

public java.util.List<HoverTarget> getHoverTargets()

getOffsetTokenStart

public int getOffsetTokenStart()

Returns:

the start offset from the token hovering (might be -1 to indicate no valid region was found)

getOffsetTokenEnd

public int getOffsetTokenEnd()

Returns:

the end offset from the token hovering (might be -1 to indicate no valid region was found)

getTokenText

public java.lang.String getTokenText()

Returns:

the token text

getOffset

public int getOffset()

Returns:

the offset in the text (might be -1 to indicate no valid region was found)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object