Top Description Inners Fields Constructors Methods
org.fxmisc.richtext.event

public abstract Class MouseOverTextEvent

extends Event
Class Inheritance
Known Direct Subclasses
org.fxmisc.richtext.event.MouseOverTextEvent.Begin, org.fxmisc.richtext.event.MouseOverTextEvent.End
Imports
javafx.event.Event, .EventTarget, .EventType, javafx.geometry.Point2D, javafx.scene.Node, .Scene

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).

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
public static final EventType<MouseOverTextEvent>
private static final MouseOverTextEvent.End
public static final EventType<MouseOverTextEvent>
public static final EventType<MouseOverTextEvent>
private static final long
Inherited from javafx.event.Event:
consumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static final MouseOverTextEvent
beginAt(Point2D screenPos, int charIdx)

public static final MouseOverTextEvent
end()

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.

public abstract 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.

public abstract Point2D
public abstract Point2D
Inherited from javafx.event.Event:
cloneconsumecopyForfireEventgetEventTypegetTargetisConsumed

Field Detail

ANYback to summary
public static final EventType<MouseOverTextEvent> ANY

Hides javafx.event.Event.ANY.

DEFAULT_ENDback to summary
private static final MouseOverTextEvent.End DEFAULT_END
MOUSE_OVER_TEXT_BEGINback to summary
public static final EventType<MouseOverTextEvent> MOUSE_OVER_TEXT_BEGIN
MOUSE_OVER_TEXT_ENDback to summary
public static final EventType<MouseOverTextEvent> MOUSE_OVER_TEXT_END
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javafx.event.Event.serialVersionUID.

Constructor Detail

MouseOverTextEventback to summary
private MouseOverTextEvent(Object source, EventTarget target, EventType<? extends MouseOverTextEvent> type)

Method Detail

beginAtback to summary
public static final MouseOverTextEvent beginAt(Point2D screenPos, int charIdx)
endback to summary
public static final MouseOverTextEvent end()
getCharacterIndexback to summary
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.

getPositionback to summary
public abstract 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

getScenePositionback to summary
public abstract Point2D getScenePosition()
getScreenPositionback to summary
public abstract Point2D getScreenPosition()
org.fxmisc.richtext.event back to summary

private Class MouseOverTextEvent.Begin

extends MouseOverTextEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final int
private final Point2D
private static final long
Inherited from org.fxmisc.richtext.event.MouseOverTextEvent:
ANYMOUSE_OVER_TEXT_BEGINMOUSE_OVER_TEXT_END

Constructor Summary

AccessConstructor and Description
public
Begin(Object source, EventTarget target, Point2D screenPos, int charIdx)

Method Summary

Modifier and TypeMethod and Description
public MouseOverTextEvent.Begin
copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target.

public int
getCharacterIndex()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.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.

public Point2D
getPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.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.

public Point2D
public Point2D
Inherited from org.fxmisc.richtext.event.MouseOverTextEvent:
beginAtend

Field Detail

charIdxback to summary
private final int charIdx
screenPosback to summary
private final Point2D screenPos
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.fxmisc.richtext.event.MouseOverTextEvent.serialVersionUID.

Constructor Detail

Beginback to summary
public Begin(Object source, EventTarget target, Point2D screenPos, int charIdx)

Method Detail

copyForback to summary
public MouseOverTextEvent.Begin copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.event.Event.copyFor.

Doc from javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Annotations
@Override
getCharacterIndexback to summary
public int getCharacterIndex()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getCharacterIndex.

Doc from org.fxmisc.richtext.event.MouseOverTextEvent.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.

Annotations
@Override
getPositionback to summary
public Point2D getPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getPosition.

Doc from org.fxmisc.richtext.event.MouseOverTextEvent.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

Annotations
@Override
getScenePositionback to summary
public Point2D getScenePosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getScenePosition.

Annotations
@Override
getScreenPositionback to summary
public Point2D getScreenPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getScreenPosition.

Annotations
@Override
org.fxmisc.richtext.event back to summary

private Class MouseOverTextEvent.End

extends MouseOverTextEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
Inherited from org.fxmisc.richtext.event.MouseOverTextEvent:
ANYMOUSE_OVER_TEXT_BEGINMOUSE_OVER_TEXT_END

Constructor Summary

AccessConstructor and Description
public
End(Object source, EventTarget target)

Method Summary

Modifier and TypeMethod and Description
public MouseOverTextEvent.End
copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target.

public int
getCharacterIndex()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.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.

public Point2D
getPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.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.

public Point2D
public Point2D
Inherited from org.fxmisc.richtext.event.MouseOverTextEvent:
beginAtend

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.fxmisc.richtext.event.MouseOverTextEvent.serialVersionUID.

Constructor Detail

Endback to summary
public End(Object source, EventTarget target)

Method Detail

copyForback to summary
public MouseOverTextEvent.End copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.event.Event.copyFor.

Doc from javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Annotations
@Override
getCharacterIndexback to summary
public int getCharacterIndex()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getCharacterIndex.

Doc from org.fxmisc.richtext.event.MouseOverTextEvent.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.

Annotations
@Override
getPositionback to summary
public Point2D getPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getPosition.

Doc from org.fxmisc.richtext.event.MouseOverTextEvent.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

Annotations
@Override
getScenePositionback to summary
public Point2D getScenePosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getScenePosition.

Annotations
@Override
getScreenPositionback to summary
public Point2D getScreenPosition()

Implements abstract org.fxmisc.richtext.event.MouseOverTextEvent.getScreenPosition.

Annotations
@Override