Class AutoScroll

An auto-scroll Event. Dispatched when a widget (or part of a widget) wants to be visible to the user, such as the current caret position when typing a character.

This event is not static. As the event propagates in the UI tree, it will be updated so that the wanted bounds are up-to-date.

Note that this event is handled via dispatchEvent in a special case; widgets will auto-capture the event if they are originallyRelativeTo, and handleEvent will only be called if propagatesEvents is true. The event must be re-captured by scrollable containers if a child of those containers captured the event, and bounds must be updated accordingly. See handleEvent for an example of this.

Has no focus type and does not need focus. Cannot be targetted.

Hierarchy

Constructors

Properties

bounds: Bounds

The portion of originallyRelativeTo that needs to be in view. For example, if a 5x10 rectangle at the top-left of the widget needs to be selected, with a horizontal and vertical offset of 2, then the bounds would be [2, 2, 7, 12].

Note that this is initially relative to originallyRelativeTo when the event is created, but the bounds must be relative to the capturer instead after the event is first captured.

Can be changed by event handlers; typically it's changed to a scrollable container after the container is scrolled so that there are no issues with nested scrollable containers.

focusType: null | FocusType

The focus type of this event. Can be null.

If null, this event cannot be focused, since events are focused by their FocusType as a group.

needsFocus: boolean

Can this event be dispatched without a target?

originallyRelativeTo: Widget

The widget that the auto-scroll bounds will be relative to.

reversed: boolean

Is this event dispatched in reverse-order?

target: null | Widget

The target of this event. Can be null

targetWarned: boolean = false

Methods

Generated using TypeDoc