APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.control

public Class ScrollToEvent<T>

extends Event
Class Inheritance
Type Parameters
<T>
the scroll-to event type
Imports
javafx.beans.NamedArg, javafx.event.Event, .EventTarget, .EventType
Event related to ScrollPane and virtualised controls such as ListView, TableView, TreeView and TreeTableView.
Since
JavaFX 8.0

Field Summary

Modifier and TypeField and Description
public static final EventType<ScrollToEvent<T>>
ANY

Hides javafx.event.Event.ANY.

Common supertype for all scroll-to event types.
private static final EventType<?>
SCROLL_TO_COLUMN

private static final EventType<ScrollToEvent<Integer>>
SCROLL_TO_TOP_INDEX

private final T
scrollTarget

private static final long
serialVersionUID

Hides javafx.event.Event.serialVersionUID.

Inherited from javafx.event.Event:
consumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
public
ScrollToEvent(Object
the event source which sent the event
source, EventTarget
the event source which sent the event
target, EventType<ScrollToEvent<T>>
the event type
type, T
the target of the scroll to operation
scrollTarget)

Construct a new Event with the specified event source, target and type.

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

the target of the scroll-to operation
getScrollTarget()

Gets the target of the scroll-to operation.

public static <
the type
T extends TableColumnBase<?, ?>> EventType<ScrollToEvent<T>>

Returns:

the scroll to event type
scrollToColumn()

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

public static EventType<ScrollToEvent<Integer>>

Returns:

the scroll to event type
scrollToTopIndex()

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

Inherited from javafx.event.Event:
cloneconsumecopyForfireEventgetEventTypegetTargetisConsumed

Field Detail

ANYback to summary
public static final EventType<ScrollToEvent<T>> ANY

Hides javafx.event.Event.ANY.

Common supertype for all scroll-to event types.

SCROLL_TO_COLUMNback to summary
private static final EventType<?> SCROLL_TO_COLUMN
SCROLL_TO_TOP_INDEXback to summary
private static final EventType<ScrollToEvent<Integer>> SCROLL_TO_TOP_INDEX
scrollTargetback to summary
private final T scrollTarget
Annotations
@SuppressWarnings:doclint:missing
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javafx.event.Event.serialVersionUID.

Constructor Detail

ScrollToEventback to summary
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:Object

the event source which sent the event

target:EventTarget

the event source which sent the event

type:EventType<ScrollToEvent<T>>

the event type

scrollTarget:T

the target of the scroll to operation

Method Detail

getScrollTargetback to summary
public T getScrollTarget()

Gets the target of the scroll-to operation.

Returns:T

the target of the scroll-to operation

scrollToColumnback to summary
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.

Parameters
<T>
the type
Returns:EventType<ScrollToEvent<T>>

the scroll to event type

Annotations
@SuppressWarnings:unchecked
scrollToTopIndexback to summary
public static EventType<ScrollToEvent<Integer>> scrollToTopIndex()

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

Returns:EventType<ScrollToEvent<Integer>>

the scroll to event type