org.fxmisc.richtext.event

Class MouseOverTextEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

org.fxmisc.richtext.event.MouseOverTextEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public abstract class MouseOverTextEvent
extends javafx.event.Event

Defines an event where the mouse becomes stationary over some part of an area (MOUSE_OVER_TEXT_BEGIN) and when it moves from that position (MOUSE_OVER_TEXT_END).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.event.EventType<MouseOverTextEvent>	ANY
static javafx.event.EventType<MouseOverTextEvent>	MOUSE_OVER_TEXT_BEGIN
static javafx.event.EventType<MouseOverTextEvent>	MOUSE_OVER_TEXT_END

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
static MouseOverTextEvent	beginAt(javafx.geometry.Point2D screenPos, int charIdx)
static MouseOverTextEvent	end()
abstract int	getCharacterIndex() Returns index of the character that the mouse stopped over if this event is a MOUSE_OVER_TEXT_BEGIN event and -1 if this event is a MOUSE_OVER_TEXT_END.
abstract javafx.geometry.Point2D	getPosition() For MOUSE_OVER_TEXT_BEGIN events returns the position at which the mouse is standing still, relative to the node on which the event handler was registered.
abstract javafx.geometry.Point2D	getScenePosition()
abstract javafx.geometry.Point2D	getScreenPosition()

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ANY

public static final javafx.event.EventType<MouseOverTextEvent> ANY

MOUSE_OVER_TEXT_BEGIN

public static final javafx.event.EventType<MouseOverTextEvent> MOUSE_OVER_TEXT_BEGIN

MOUSE_OVER_TEXT_END

public static final javafx.event.EventType<MouseOverTextEvent> MOUSE_OVER_TEXT_END

Method Detail

beginAt

public static final MouseOverTextEvent beginAt(javafx.geometry.Point2D screenPos,
                                               int charIdx)

end

public static final MouseOverTextEvent end()

getPosition

public abstract javafx.geometry.Point2D getPosition()

For MOUSE_OVER_TEXT_BEGIN events returns the position at which the mouse is standing still, relative to the node on which the event handler was registered.

For MOUSE_OVER_TEXT_END events returns null

getScenePosition

public abstract javafx.geometry.Point2D getScenePosition()

getScreenPosition

public abstract javafx.geometry.Point2D getScreenPosition()

getCharacterIndex

public abstract int getCharacterIndex()

Returns index of the character that the mouse stopped over if this event is a MOUSE_OVER_TEXT_BEGIN event and -1 if this event is a MOUSE_OVER_TEXT_END.