Class ScrollToEvent<T>

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.control.ScrollToEvent<T>

Type Parameters:

T - the scroll-to event type

All Implemented Interfaces:

Serializable, Cloneable

public class ScrollToEvent<T>
extends Event

Event related to ScrollPane and virtualised controls such as ListView, TableView, TreeView and TreeTableView.

Since:

JavaFX 8.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final EventType<ScrollToEvent>	ANY	Common supertype for all scroll-to event types.

Fields declared in class Event

consumed, eventType, NULL_SOURCE_TARGET, target

Modifier and Type	Field	Description
protected boolean	consumed	Whether this event has been consumed by any filter or handler.
protected EventType<? extends Event>	eventType	Type of the event.
static final EventTarget	NULL_SOURCE_TARGET	The constant which represents an unknown event source / target.
protected EventTarget	target	Event target that defines the path through which the event will travel when posted.

Fields declared in class EventObject

source

Constructor Summary

Constructors

Constructor	Description
ScrollToEvent(Object source, EventTarget target, EventType<ScrollToEvent<T>> type, T scrollTarget)	Construct a new Event with the specified event source, target and type.

Method Summary

Modifier and Type	Method	Description
T	getScrollTarget()	Gets the target of the scroll-to operation.
static <T extends TableColumnBase<?,?>> EventType<ScrollToEvent<T>>	scrollToColumn()	This event occurs if the user requests scrolling a TableColumnBase (i.e.
static EventType<ScrollToEvent<Integer>>	scrollToTopIndex()	This event occurs if the user requests scrolling a given index into view.

Methods declared in class Event

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

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this Event.
void	consume()	Marks this Event as consumed.
Event	copyFor(Object newSource, EventTarget newTarget)	Creates and returns a copy of this event with the specified event source and target.
static void	fireEvent(EventTarget eventTarget, Event event)	Fires the specified event.
EventType<? extends Event>	getEventType()	Gets the event type of this event.
EventTarget	getTarget()	Returns the event target of this event.
boolean	isConsumed()	Indicates whether this Event has been consumed by any filter or handler.

Methods declared in class EventObject

getSource, toString

Methods declared in class Object

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

Field Details

ANY

public static final EventType<ScrollToEvent> ANY

Common supertype for all scroll-to event types.

Constructor Details

ScrollToEvent

public ScrollToEvent(Object source,
 EventTarget target,
 EventType<ScrollToEvent<T>> type,
 T scrollTarget)

Construct a new Event with the specified event source, target and type. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Parameters:

source - the event source which sent the event

target - the event source which sent the event

type - the event type

scrollTarget - the target of the scroll to operation

Method Details

scrollToTopIndex

public static EventType<ScrollToEvent<Integer>> scrollToTopIndex()

This event occurs if the user requests scrolling a given index into view.

Returns:

the scroll to event type

scrollToColumn

public static <T extends TableColumnBase<?,?>>
EventType<ScrollToEvent<T>> scrollToColumn()

This event occurs if the user requests scrolling a TableColumnBase (i.e. TableColumn or TreeTableColumn) into view.

Type Parameters:

T - the type

Returns:

the scroll to event type

getScrollTarget

public T getScrollTarget()

Gets the target of the scroll-to operation.

Returns:

the target of the scroll-to operation