scaffold.libs_as.feathers.controls.IRange.as Maven / Gradle / Ivy
/*
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
{
import feathers.core.IFeathersControl;
/**
* Dispatched when the value changes.
*
* The properties of the event object have the following values:
*
* Property Value bubblesfalse currentTargetThe 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. datanull targetThe 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 IRange extends IFeathersControl
{
/**
* The minimum numeric value of the range.
*
* In the following example, the minimum is changed to 0:
*
*
* component.minimum = 0;
* component.maximum = 100;
* component.step = 1;
* component.page = 10
* component.value = 12;
*/
function get minimum():Number;
/**
* @private
*/
function set minimum(value:Number):void;
/**
* The maximum numeric value of the range.
*
* In the following example, the maximum is changed to 100:
*
*
* component.minimum = 0;
* component.maximum = 100;
* component.step = 1;
* component.page = 10
* component.value = 12;
*/
function get maximum():Number;
/**
* @private
*/
function set maximum(value:Number):void;
/**
* The current numeric value.
*
* In the following example, the value is changed to 12:
*
*
* component.minimum = 0;
* component.maximum = 100;
* component.step = 1;
* component.page = 10
* component.value = 12;
*/
function get value():Number;
/**
* @private
*/
function set value(value:Number):void;
/**
* The amount the value must change to increment or decrement.
*
* In the following example, the step is changed to 1:
*
*
* component.minimum = 0;
* component.maximum = 100;
* component.step = 1;
* component.page = 10
* component.value = 12;
*/
function get step():Number;
/**
* @private
*/
function set step(value:Number):void;
}
}