Packagefeathers.controls
Classpublic class NumericStepper
InheritanceNumericStepper Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IRange, IAdvancedNativeFocusOwner, ITextBaselineControl

Product Version : Feathers 1.1.0

Select a value between a minimum and a maximum by using increment and decrement buttons or typing in a value in a text input.

The following example sets the stepper's range and listens for when the value changes:

var stepper:NumericStepper = new NumericStepper();
stepper.minimum = 0;
stepper.maximum = 100;
stepper.step = 1;
stepper.value = 12;
stepper.addEventListener( Event.CHANGE, stepper_changeHandler );
this.addChild( stepper );

See also

How to use the Feathers NumericStepper component


Public Properties
 PropertyDefined By
  baseline : Number
[read-only] Returns the text baseline measurement, in pixels.
NumericStepper
  decrementButtonFactory : Function
A function used to generate the numeric stepper's decrement button sub-component.
NumericStepper
  decrementButtonProperties : Object
An object that stores properties for the numeric stepper's decrement button sub-component, and the properties will be passed down to the decrement button when the numeric stepper validates.
NumericStepper
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all NumericStepper components.
NumericStepper
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
  incrementButtonFactory : Function
A function used to generate the numeric stepper's increment button sub-component.
NumericStepper
  incrementButtonProperties : Object
An object that stores properties for the numeric stepper's increment button sub-component, and the properties will be passed down to the increment button when the numeric stepper validates.
NumericStepper
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  maximum : Number
The numeric stepper's value will not go higher than the maximum.
NumericStepper
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  minimum : Number
The numeric stepper's value will not go lower than the minimum.
NumericStepper
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  nativeFocus : Object
[read-only] A text input's text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property.
NumericStepper
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
  repeatDelay : Number
The time, in seconds, before actions are repeated.
NumericStepper
  step : Number
As the numeric stepper's buttons are pressed, the value is snapped to a multiple of the step.
NumericStepper
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
  textInputFactory : Function
A function used to generate the numeric stepper's text input sub-component.
NumericStepper
  textInputProperties : Object
An object that stores properties for the numeric stepper's text input sub-component, and the properties will be passed down to the text input when the numeric stepper validates.
NumericStepper
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
  value : Number
The value of the numeric stepper, between the minimum and maximum.
NumericStepper
  valueFormatFunction : Function
A callback that formats the numeric stepper's value as a string to display to the user.
NumericStepper
  valueParseFunction : Function
A callback that accepts the displayed text of the numeric stepper and converts it to a simple numeric value.
NumericStepper
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  decrementButton : Button
The decrement button sub-component.
NumericStepper
  decrementButtonStyleName : String = "feathers-numeric-stepper-decrement-button"
The value added to the styleNameList of the decrement button.
NumericStepper
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
  incrementButton : Button
The increment button sub-component.
NumericStepper
  incrementButtonStyleName : String = "feathers-numeric-stepper-increment-button"
The value added to the styleNameList of the increment button.
NumericStepper
  textInput : TextInput
The text input sub-component.
NumericStepper
  textInputStyleName : String = "feathers-numeric-stepper-text-input"
The value added to the styleNameList of the text input.
NumericStepper
Public Methods
 MethodDefined By
  
Constructor.
NumericStepper
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
  
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
NumericStepper
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
  
Creates and adds the decrementButton sub-component and removes the old instance, if one exists.
NumericStepper
  
Creates and adds the incrementButton sub-component and removes the old instance, if one exists.
NumericStepper
  
Creates and adds the textInput sub-component and removes the old instance, if one exists.
NumericStepper
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
  Dispatched when the stepper's value changes.NumericStepper
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Styles
 StyleDefined By
  
buttonGap : Number
The gap, in pixels, between the numeric stepper's increment and decrement buttons when they are both positioned on the same side.
NumericStepper
  
How the buttons are positioned relative to the text input.
NumericStepper
  
A style name to add to the numeric stepper's decrement button sub-component.
NumericStepper
  
A style name to add to the numeric stepper's increment button sub-component.
NumericStepper
  
A style name to add to the numeric stepper's text input sub-component.
NumericStepper
  
The text displayed by the decrement button.
NumericStepper
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  
The text displayed by the increment button.
NumericStepper
  
textInputGap : Number
The gap, in pixels, between the numeric stepper's text input and its buttons.
NumericStepper
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTON : String = "feathers-numeric-stepper-decrement-button"
[static] The default value added to the styleNameList of the decrement button.
NumericStepper
  DEFAULT_CHILD_STYLE_NAME_INCREMENT_BUTTON : String = "feathers-numeric-stepper-increment-button"
[static] The default value added to the styleNameList of the increment button.
NumericStepper
  DEFAULT_CHILD_STYLE_NAME_TEXT_INPUT : String = "feathers-numeric-stepper-text-input"
[static] The default value added to the styleNameList of the text input.
NumericStepper
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
baselineproperty
baseline:Number  [read-only]

Returns the text baseline measurement, in pixels.


Implementation
    public function get baseline():Number
decrementButtonproperty 
protected var decrementButton:Button

The decrement button sub-component.

For internal use in subclasses.

See also

decrementButtonFactoryproperty 
decrementButtonFactory:Function

A function used to generate the numeric stepper's decrement button sub-component. The decrement button must be an instance of Button. This factory can be used to change properties on the decrement button when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the decrement button.

The function should have the following signature:

function():Button

In the following example, a custom decrement button factory is passed to the stepper:

stepper.decrementButtonFactory = function():Button
{
    var button:Button = new Button();
    button.defaultSkin = new Image( upTexture );
    button.downSkin = new Image( downTexture );
    return button;
};

The default value is null.


Implementation
    public function get decrementButtonFactory():Function
    public function set decrementButtonFactory(value:Function):void

See also

decrementButtonPropertiesproperty 
decrementButtonProperties:Object

An object that stores properties for the numeric stepper's decrement button sub-component, and the properties will be passed down to the decrement button when the numeric stepper validates. For a list of available properties, refer to feathers.controls.Button.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a decrementButtonFactory function instead of using decrementButtonProperties will result in better performance.

In the following example, the stepper's decrement button properties are updated:

stepper.decrementButtonProperties.defaultSkin = new Image( upTexture );
stepper.decrementButtonProperties.downSkin = new Image( downTexture );

The default value is null.


Implementation
    public function get decrementButtonProperties():Object
    public function set decrementButtonProperties(value:Object):void

See also

decrementButtonStyleNameproperty 
protected var decrementButtonStyleName:String = "feathers-numeric-stepper-decrement-button"

The value added to the styleNameList of the decrement button. This variable is protected so that sub-classes can customize the decrement button style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTON.

To customize the decrement button name without subclassing, see customDecrementButtonStyleName.

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all NumericStepper components.

The default value is null.

See also

incrementButtonproperty 
protected var incrementButton:Button

The increment button sub-component.

For internal use in subclasses.

See also

incrementButtonFactoryproperty 
incrementButtonFactory:Function

A function used to generate the numeric stepper's increment button sub-component. The increment button must be an instance of Button. This factory can be used to change properties on the increment button when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the increment button.

The function should have the following signature:

function():Button

In the following example, a custom increment button factory is passed to the stepper:

stepper.incrementButtonFactory = function():Button
{
    var button:Button = new Button();
    button.defaultSkin = new Image( upTexture );
    button.downSkin = new Image( downTexture );
    return button;
};

The default value is null.


Implementation
    public function get incrementButtonFactory():Function
    public function set incrementButtonFactory(value:Function):void

See also

incrementButtonPropertiesproperty 
incrementButtonProperties:Object

An object that stores properties for the numeric stepper's increment button sub-component, and the properties will be passed down to the increment button when the numeric stepper validates. For a list of available properties, refer to feathers.controls.Button.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a incrementButtonFactory function instead of using incrementButtonProperties will result in better performance.

In the following example, the stepper's increment button properties are updated:

stepper.incrementButtonProperties.defaultSkin = new Image( upTexture );
stepper.incrementButtonProperties.downSkin = new Image( downTexture );

The default value is null.


Implementation
    public function get incrementButtonProperties():Object
    public function set incrementButtonProperties(value:Object):void

See also

incrementButtonStyleNameproperty 
protected var incrementButtonStyleName:String = "feathers-numeric-stepper-increment-button"

The value added to the styleNameList of the increment button. This variable is protected so that sub-classes can customize the increment button style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_INCREMENT_BUTTON.

To customize the increment button name without subclassing, see customIncrementButtonStyleName.

See also

maximumproperty 
maximum:Number

The numeric stepper's value will not go higher than the maximum.

In the following example, the maximum is changed to 100:

stepper.minimum = 0;
stepper.maximum = 100;
stepper.step = 1;
stepper.value = 12;

The default value is 0.


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

See also

minimumproperty 
minimum:Number

The numeric stepper's value will not go lower than the minimum.

In the following example, the minimum is changed to 0:

stepper.minimum = 0;
stepper.maximum = 100;
stepper.step = 1;
stepper.value = 12;

The default value is 0.


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

See also

nativeFocusproperty 
nativeFocus:Object  [read-only]

A text input's text editor may be an INativeFocusOwner, so we need to return the value of its nativeFocus property.


Implementation
    public function get nativeFocus():Object

See also

repeatDelayproperty 
repeatDelay:Number

The time, in seconds, before actions are repeated. The first repeat happens after a delay that is five times longer than the following repeats.

In the following example, the stepper's repeat delay is set to 500 milliseconds:

stepper.repeatDelay = 0.5;

The default value is 0.05.


Implementation
    public function get repeatDelay():Number
    public function set repeatDelay(value:Number):void
stepproperty 
step:Number

As the numeric stepper's buttons are pressed, the value is snapped to a multiple of the step.

In the following example, the step is changed to 1:

stepper.minimum = 0;
stepper.maximum = 100;
stepper.step = 1;
stepper.value = 12;

The default value is 0.


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

See also

textInputproperty 
protected var textInput:TextInput

The text input sub-component.

For internal use in subclasses.

See also

textInputFactoryproperty 
textInputFactory:Function

A function used to generate the numeric stepper's text input sub-component. The text input must be an instance of TextInput. This factory can be used to change properties on the text input when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the text input.

The function should have the following signature:

function():TextInput

In the following example, a custom text input factory is passed to the stepper:

stepper.textInputFactory = function():TextInput
{
    var textInput:TextInput = new TextInput();
    textInput.backgroundSkin = new Image( texture );
    return textInput;
};

The default value is null.


Implementation
    public function get textInputFactory():Function
    public function set textInputFactory(value:Function):void

See also

textInputPropertiesproperty 
textInputProperties:Object

An object that stores properties for the numeric stepper's text input sub-component, and the properties will be passed down to the text input when the numeric stepper validates. For a list of available properties, refer to feathers.controls.TextInput.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a textInputFactory function instead of using textInputProperties will result in better performance.

In the following example, the stepper's text input properties are updated:

stepper.textInputProperties.backgroundSkin = new Image( texture );

The default value is null.


Implementation
    public function get textInputProperties():Object
    public function set textInputProperties(value:Object):void

See also

textInputStyleNameproperty 
protected var textInputStyleName:String = "feathers-numeric-stepper-text-input"

The value added to the styleNameList of the text input. This variable is protected so that sub-classes can customize the text input style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_TEXT_INPUT.

To customize the text input name without subclassing, see customTextInputStyleName.

See also

valueproperty 
value:Number

The value of the numeric stepper, between the minimum and maximum.

In the following example, the value is changed to 12:

stepper.minimum = 0;
stepper.maximum = 100;
stepper.step = 1;
stepper.value = 12;

The default value is 0.


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

See also

valueFormatFunctionproperty 
valueFormatFunction:Function

A callback that formats the numeric stepper's value as a string to display to the user.

The function is expected to have the following signature:

function(value:Number):String

In the following example, the stepper's value format function is customized:

stepper.valueFormatFunction = function(value:Number):String
{
    return currencyFormatter.format(value, true);
};

The default value is null.


Implementation
    public function get valueFormatFunction():Function
    public function set valueFormatFunction(value:Function):void

See also

valueParseFunctionproperty 
valueParseFunction:Function

A callback that accepts the displayed text of the numeric stepper and converts it to a simple numeric value.

The function is expected to have the following signature:

function(displayedText:String):Number

In the following example, the stepper's value parse function is customized:

stepper.valueParseFunction = function(displayedText:String):String
{
    return currencyFormatter.parse(displayedText).value;
};

The default value is null.


Implementation
    public function get valueParseFunction():Function
    public function set valueParseFunction(value:Function):void

See also

Constructor Detail
NumericStepper()Constructor
public function NumericStepper()

Constructor.

Method Detail
autoSizeIfNeeded()method
protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Returns
Boolean
createDecrementButton()method 
protected function createDecrementButton():void

Creates and adds the decrementButton sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createIncrementButton()method 
protected function createIncrementButton():void

Creates and adds the incrementButton sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createTextInput()method 
protected function createTextInput():void

Creates and adds the textInput sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

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

Dispatched when the stepper's value changes.

The properties of the event object have the following values:

PropertyValue
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.

See also

Style Detail
textInputGapstyle
textInputGap:Number

The gap, in pixels, between the numeric stepper's text input and its buttons. If the buttons are split, this gap is used on both sides. If the buttons both appear on the same side, the gap is used only on that side.

In the following example, the gap between the text input and buttons is set to 20 pixels:

stepper.textInputGap = 20;

The default value is 0.

See also

incrementButtonLabelstyle 
incrementButtonLabel:String

The text displayed by the increment button. Often, there is no text displayed on this button and an icon is used instead.

In the following example, the increment button's label is customized:

stepper.incrementButtonLabel = "+";

The default value is null.

decrementButtonLabelstyle 
decrementButtonLabel:String

The text displayed by the decrement button. Often, there is no text displayed on this button and an icon is used instead.

In the following example, the decrement button's label is customized:

stepper.decrementButtonLabel = "-";

The default value is null.

customTextInputStyleNamestyle 
customTextInputStyleName:String

A style name to add to the numeric stepper's text input sub-component. Typically used by a theme to provide different styles to different text inputs.

In the following example, a custom text input style name is passed to the stepper:

stepper.customTextInputStyleName = "my-custom-text-input";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( TextInput ).setFunctionForStyleName( "my-custom-text-input", setCustomTextInputStyles );

The default value is null.

See also

customIncrementButtonStyleNamestyle 
customIncrementButtonStyleName:String

A style name to add to the numeric stepper's increment button sub-component. Typically used by a theme to provide different styles to different numeric steppers.

In the following example, a custom increment button style name is passed to the stepper:

stepper.customIncrementButtonStyleName = "my-custom-increment-button";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-increment-button", setCustomIncrementButtonStyles );

The default value is null.

See also

customDecrementButtonStyleNamestyle 
customDecrementButtonStyleName:String

A style name to add to the numeric stepper's decrement button sub-component. Typically used by a theme to provide different styles to different numeric steppers.

In the following example, a custom decrement button style name is passed to the stepper:

stepper.customDecrementButtonStyleName = "my-custom-decrement-button";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-decrement-button", setCustomDecrementButtonStyles );

The default value is null.

See also

buttonGapstyle 
buttonGap:Number

The gap, in pixels, between the numeric stepper's increment and decrement buttons when they are both positioned on the same side. If the buttons are split between two sides, this value is not used.

In the following example, the gap between buttons is set to 20 pixels:

stepper.buttonLayoutMode = StepperButtonLayoutMode.RIGHT_SIDE_VERTICAL;
stepper.buttonGap = 20;

The default value is 0.

See also

buttonLayoutModestyle 
buttonLayoutMode:String

How the buttons are positioned relative to the text input.

In the following example, the button layout is set to place the buttons on the right side, stacked vertically, for a desktop appearance:

stepper.buttonLayoutMode = NumericStepper.StepperButtonLayoutMode.RIGHT_SIDE_VERTICAL;

The default value is feathers.controls.StepperButtonLayoutMode.SPLIT_HORIZONTAL.

See also

Constant Detail
DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTONConstant
public static const DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTON:String = "feathers-numeric-stepper-decrement-button"

The default value added to the styleNameList of the decrement button.

See also

DEFAULT_CHILD_STYLE_NAME_INCREMENT_BUTTONConstant 
public static const DEFAULT_CHILD_STYLE_NAME_INCREMENT_BUTTON:String = "feathers-numeric-stepper-increment-button"

The default value added to the styleNameList of the increment button.

See also

DEFAULT_CHILD_STYLE_NAME_TEXT_INPUTConstant 
public static const DEFAULT_CHILD_STYLE_NAME_TEXT_INPUT:String = "feathers-numeric-stepper-text-input"

The default value added to the styleNameList of the text input.

See also