View source

class ScrollEvent

package feathers.events

extends Event

@:directlyUsed

Events dispatched by scrolling containers.

Available since

1.0.0

.

See also:

Static variables

@:value("scroll")staticinlineread onlySCROLL:EventType<ScrollEvent> = "scroll"

The ScrollEvent.SCROLL event type is dispatched when the scroll position of a container changes. This is basically alias for openfl.events.Event.SCROLL.

@:value("scrollComplete")staticinlineread onlySCROLL_COMPLETE:EventType<ScrollEvent> = "scrollComplete"

The ScrollEvent.SCROLL_COMPLETE event type is dispatched when a scrolling container completes scrolling.

Available since

1.0.0

.

@:value("scrollStart")staticinlineread onlySCROLL_START:EventType<ScrollEvent> = "scrollStart"

The ScrollEvent.SCROLL_START event type is dispatched when a scrolling container starts scrolling.

Available since

1.0.0

.

Static methods

@:value({ y : 0.0, x : 0.0, cancelable : false, bubbles : false })staticdispatch(dispatcher:IEventDispatcher, type:String, bubbles:Bool = false, cancelable:Bool = false, x:Float = 0.0, y:Float = 0.0):Bool

Dispatches a pooled event with the specified properties.

ScrollEvent.dispatch(component, ScrollEvent.SCROLL);
Available since

1.0.0

.

Constructor

@:value({ y : 0.0, x : 0.0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, x:Float = 0.0, y:Float = 0.0)

Creates a new ScrollEvent object with the given arguments.

Available since

1.0.0

.

See also:

Variables

x:Float

The current x position when the event was dispatched.

Available since

1.2.0

.

y:Float

The current y position when the event was dispatched.

Available since

1.2.0

.

Methods