class Scroller

package openflexUI.controls

extends UIComponent

The Scroller control displays a single scrollable component, called a viewport, and horizontal and vertical scroll bars.

Variables

horizontalScrollBar:SpriteUI

horizontalScrollPolicy:String

Indicates under what conditions the horizontal scroll bar is displayed. The acceptable values are "auto" or "off".

The default value is auto

horizontalScrollPosition:Float

The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.

read onlymaxHorizontalScrollPosition:Float

Get a number that represents the maximum horizontal scroll position.

read onlymaxVerticalScrollPosition:Float

Get a number that represents the maximum vertical scroll position.

pivotX:Float

The x coordinate of the object's origin in its own coordinate space (default: 0).

pivotY:Float

The y coordinate of the object's origin in its own coordinate space (default: 0).

swipe:Bool

Swipe to scroll the viewport.

The default value is true

verticalScrollBar:SpriteUI

verticalScrollPolicy:String

Indicates under what conditions the vertical scroll bar is displayed. The acceptable values are "auto" or "off".

The default value is auto

verticalScrollPosition:Float

The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.

read onlyviewPort:Rectangle

The rectangle displayed and scrolled within the Scroller.

Methods

Inherited Variables

Defined by UIComponent

read onlycontentHeight:Float

The height of the viewport's content.

read onlycontentWidth:Float

The width of the viewport's content.

enabled:Bool

Gets or sets a value that indicates whether the component can accept user input.

The default value is true

includeInLayout:Bool

Determines if the layout should use this object or ignore it.

The default value is true

isCreated:Bool

Determines if the component has been initialized and validated for the first time.

layout:Dynamic

Controls the way that the group's children are positioned and sized.

maxHeight:Float

The maximum recommended height of the component to be considered by the parent during layout.

maxWidth:Float

The maximum recommended width of the component to be considered by the parent during layout.

minHeight:Float

The minimum recommended height of the component to be considered by the parent during layout.

minWidth:Float

The minimum recommended width of the component to be considered by the parent during layout.

Inherited Methods

Defined by UIComponent

invalidateDisplayList ():Void

Marks a component so that its updateDisplayList() method gets called during a later screen update.

invalidateProperties ():Void

Marks a component so that its commitProperties() method gets called during a later screen update.

invalidateSize ():Void

Marks a component so that its measure() method gets called during a later screen update.

validate ():Void

Validate and update the properties and layout of this object and redraw it, if necessary.