feathers.controls.IScrollBar

Public Properties

	Property		Defined By
		alpha : Number The opacity of the display object.	IFeathersDisplayObject
		base : DisplayObject [read-only] The top-most object of the display tree that the display object is connected to.	IFeathersDisplayObject
		blendMode : String The blend mode used when rendering the display object.	IFeathersDisplayObject
		bounds : Rectangle [read-only] The bounds of the display object in its local coordinate space.	IFeathersDisplayObject
		depth : int [read-only] The component's depth in the display list, relative to the stage.	IValidating
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	IFeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	IMeasureDisplayObject
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	IMeasureDisplayObject
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	IMeasureDisplayObject
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	IMeasureDisplayObject
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	IMeasureDisplayObject
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	IMeasureDisplayObject
		filter : FragmentFilter The filter used when rendering the display object.	IFeathersDisplayObject
		height : Number The height of the display object in the parent's coordinate space.	IFeathersDisplayObject
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	IFeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	IFeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	IFeathersControl
		mask : DisplayObject The display object's mask.	IFeathersDisplayObject
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	IMeasureDisplayObject
		maximum : Number The maximum numeric value of the range.	IRange
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	IMeasureDisplayObject
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	IMeasureDisplayObject
		minimum : Number The minimum numeric value of the range.	IRange
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	IMeasureDisplayObject
		name : String The name of the display object.	IFeathersDisplayObject
		page : Number The amount the scroll bar value must change to get from one "page" to the next.	IScrollBar
		parent : DisplayObjectContainer [read-only] The display object's parent, or null if it doesn't have a parent.	IFeathersDisplayObject
		pivotX : Number The x coordinate of the display object's origin in its own coordinate space.	IFeathersDisplayObject
		pivotY : Number The y coordinate of the display object's origin in its own coordinate space.	IFeathersDisplayObject
		root : DisplayObject [read-only]	IFeathersDisplayObject
		rotation : Number The rotation of the display object, in radians.	IFeathersDisplayObject
		scaleX : Number This horizontal scale factor.	IFeathersDisplayObject
		scaleY : Number The vertical scale factor.	IFeathersDisplayObject
		skewX : Number The horizontal skew, in radians.	IFeathersDisplayObject
		skewY : Number The vertical skew, in radians.	IFeathersDisplayObject
		stage : Stage [read-only] The stage that the display object is connected to, or null if it is not connected to a stage.	IFeathersDisplayObject
		step : Number The amount the value must change to increment or decrement.	IRange
		styleName : String The concatenated styleNameList, with values separated by spaces.	IFeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	IFeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	IFeathersControl
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	IFeathersControl
		touchable : Boolean Determines if the display object may be touched.	IFeathersDisplayObject
		transformationMatrix : Matrix [read-only] The transformation matrix of the display object, relative to its parent.	IFeathersDisplayObject
		useHandCursor : Boolean Determines if the mouse cursor should turn into a hand when the mouse is over the display object.	IFeathersDisplayObject
		value : Number The current numeric value.	IRange
		visible : Boolean Determines the visibility of the display object.	IFeathersDisplayObject
		width : Number The width of the display object in the parent's coordinate space.	IFeathersDisplayObject
		x : Number The x, or horizontal, position of the display object in the parent's coordinate space.	IFeathersDisplayObject
		y : Number The y, or vertical, position of the display object in the parent's coordinate space.	IFeathersDisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function):void Adds a listener for an event type.	IFeathersEventDispatcher
		dispatchEvent(event:Event):void Dispatches an event to all listeners added for the specified event type.	IFeathersEventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event from the pool with the specified to all listeners for the specified event type.	IFeathersEventDispatcher
		dispose():void Disposes the display object.	IFeathersDisplayObject
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Gets the display object's bounds in the target coordinate space.	IFeathersDisplayObject
		getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Calculates a transformation matrix to convert values from the display object's coordinate space to a target coordinate space.	IFeathersDisplayObject
		globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Converts a point from the stage's coordinate space to the display object's coordinate space.	IFeathersDisplayObject
		hasEventListener(type:String, listener:Function = null):Boolean Checks if a listener has been added for the specified event type.	IFeathersEventDispatcher
		hitTest(localPoint:Point):DisplayObject Determines if a point exists within the display object's bounds.	IFeathersDisplayObject
		initializeNow():void If the component has not yet initialized, initializes immediately.	IFeathersControl
		localToGlobal(localPoint:Point, resultPoint:Point = null):Point Converts a point from the display object's coordinate space to the stage's coordinate space.	IFeathersDisplayObject
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	IFeathersControl
		removeEventListener(type:String, listener:Function):void Removes a listener for an event type.	IFeathersEventDispatcher
		removeEventListeners(type:String = null):void Removes all listeners for an event type.	IFeathersEventDispatcher
		removeFromParent(dispose:Boolean = false):void Removes a display object from its parent.	IFeathersDisplayObject
		render(painter:Painter):void Renders the display object.	IFeathersDisplayObject
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	IFeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	IFeathersControl
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	IFeathersControl
		suspendEffects():void Indicates that effects should not be activated temporarily.	IFeathersControl
		validate():void Immediately validates the display object, if it is invalid.	IValidating

Events

	Event		Summary	Defined By
		change	Dispatched when the scroll bar's value changes.	IScrollBar

Property Detail

page

property

page:Number

The amount the scroll bar value must change to get from one "page" to the next.

If this value is 0, the step value will be used instead. If the step value is 0, paging is not possible.

In the following example, the page is changed to 10:

    scrollBar.minimum = 0;
    scrollBar.maximum = 100;
    scrollBar.step = 1;
    scrollBar.page = 10
    scrollBar.value = 12;

Implementation
public function get page():Number
public function set page(value:Number):void

Event Detail

change

Event

Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

Dispatched when the scroll bar's value changes.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`data`	null
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

An event type to be utilized in custom events. Not used by Starling right now.

Starling and Feathers Extensions AS3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
IScrollBar	Properties \| Events

Package	feathers.controls
Interface	public interface IScrollBar extends IRange, IFeathersControl, IValidating, IMeasureDisplayObject