scaffold.libs_as.feathers.controls.IScrollBar.as Maven / Gradle / Ivy

Go to download

/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.

This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.controls
{
	/**
	 * 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.
	 *
	 * @eventType starling.events.Event.CHANGE
	 */
	[Event(name="change",type="starling.events.Event")]

	/**
	 * Minimum requirements for a scroll bar to be usable with a Scroller
	 * component.
	 *
	 * @see Scroller
	 */
	public interface IScrollBar extends IRange
	{
		/**
		 * 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;
		 */
		function get page():Number;

		/**
		 * @private
		 */
		function set page(value:Number):void;
	}
}

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.