Returns the text baseline measurement, in pixels.

The decrement button sub-component.

For internal use in subclasses.

See also

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.

See also

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.

See also

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

The default IStyleProvider for all NumericStepper components.

The default value is null.

See also

The increment button sub-component.

For internal use in subclasses.

See also

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.

See also

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.

See also

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

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.

See also

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.

See also

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

See also

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.

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.

See also

The text input sub-component.

For internal use in subclasses.

See also

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.

See also

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.

See also

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

Indicates if the Keyboard.LEFT and Keyboard.RIGHT keys should be used to change the value of the stepper, instead of the default Keyboard.DOWN and Keyboard.UP keys.

In the following example, the left and right keys are preferred:

stepper.useLeftAndRightKeys = true;

The default value is false.

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.

See also

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.

See also

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.

See also

Constructor.

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.

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

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

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

Dispatched when the stepper's value changes.

The properties of the event object have the following values:

See also

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

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.

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.

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

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

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

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

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

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

See also

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

See also

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

See also