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 = new NumericStepper();
stepper.minimum = 0.o;
stepper.maximum = 100.o;
stepper.step = 1.0;
stepper.value = 12.0;
stepper.addEventListener(Event.CHANGE, stepper_changeHandler);
addChild(stepper);

Events:

openfl.events.Event.CHANGE

Dispatched when NumericStepper.value changes.

See also:

Static variables

@:value("numericStepper_decrementButton")staticfinalread onlyCHILD_VARIANT_DECREMENT_BUTTON:String = "numericStepper_decrementButton"

The variant used to style the decrement Button child component in a theme.

To override this default variant, set the NumericStepper.customDecrementButtonVariant property.

Available since

1.0.0

.

See also:

@:value("numericStepper_incrementButton")staticfinalread onlyCHILD_VARIANT_INCREMENT_BUTTON:String = "numericStepper_incrementButton"

The variant used to style the increment Button child component in a theme.

To override this default variant, set the NumericStepper.customIncrementButtonVariant property.

Available since

1.0.0

.

See also:

@:value("numericStepper_textInput")staticfinalread onlyCHILD_VARIANT_TEXT_INPUT:String = "numericStepper_textInput"

The variant used to style the TextInput child component in a theme.

To override this default variant, set the NumericStepper.customTextInputVariant property.

Available since

1.0.0

.

See also:

Constructor

@:value({ maximum : 1.0, minimum : 0.0, value : 0.0 })new(value:Float = 0.0, minimum:Float = 0.0, maximum:Float = 1.0, ?changeListener:Event ‑> Void)

Creates a new NumericStepper object with the given arguments.

Available since

1.0.0

.

Variables

@:style@:flash.propertybuttonDirection:Direction

How the buttons are positioned, relative to each other.

Available since

1.0.0

.

@:style@:flash.propertybuttonGap:Float

The space, in pixels, between buttons, if they are positioned next to each other.

Available since

1.1.0

.

@:style@:flash.propertycustomDecrementButtonVariant:String

A custom variant to set on the decrement button, instead of NumericStepper.CHILD_VARIANT_DECREMENT_BUTTON.

The customDecrementButtonVariant will be not be used if the result of decrementButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomIncrementButtonVariant:String

A custom variant to set on the increment button, instead of NumericStepper.CHILD_VARIANT_INCREMENT_BUTTON.

The customIncrementButtonVariant will be not be used if the result of incrementButtonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomTextInputVariant:String

A custom variant to set on the text input, instead of NumericStepper.CHILD_VARIANT_TEXT_INPUT.

The customTextInputVariant will be not be used if the result of textInputFactory already has a variant set.

Available since

1.0.0

.

See also:

decrementButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the decrement button, which must be of type feathers.controls.Button.

In the following example, a custom decrement button factory is provided:

stepper.decrementButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

editable:Bool

Indicates if the text input is editable.

The following example disables editing:

textInput.editable = false;
Available since

1.0.0

.

enableButtonsAtRangeLimits:Bool

Indicates if the decrement button is disabled when the value is equal to minimum, and if the increment button is disabled when the value is equal to the maximum.

If the buttons remain enabled, and the user attempts to decrement beyond the minimum, or increment beyond the maximum, triggering the button will have no effect, except visually.

The following example disables the buttons at range limits

textInput.enableButtonsAtRangeLimits = false;
Available since

1.2.0

.

incrementButtonFactory:AbstractDisplayObjectFactory<Dynamic, Button>

Creates the increment button, which must be of type feathers.controls.Button.

In the following example, a custom increment button factory is provided:

stepper.incrementButtonFactory = () ->
{
	return new Button();
};
Available since

1.0.0

.

See also:

maximum:Float

The stepper's value cannot be larger than the maximum.

In the following example, the maximum is set to 100.0:

stepper.minimum = 0.0;
stepper.maximum = 100.0;
stepper.step = 1.0;
stepper.value = 12.0;
Available since

1.0.0

.

See also:

minimum:Float

The stepper's value cannot be smaller than the minimum.

In the following example, the minimum is set to -100.0:

stepper.minimum = -100.0;
stepper.maximum = 100.0;
stepper.step = 1.0;
stepper.value = 50.0;
Available since

1.0.0

.

See also:

snapInterval:Float

When the stepper's value changes, it may be "snapped" to the nearest multiple of snapInterval. If snapInterval is 0.0, the value is not snapped.

In the following example, the snap inverval is changed to 1.0:

stepper.minimum = 0.0;
stepper.maximum = 100.0;
stepper.step = 1.0;
stepper.snapInterval = 1.0;
stepper.value = 10.0;
Available since

1.0.0

.

See also:

step:Float

Indicates the amount that value is changed when the stepper has focus and one of the arrow keys is pressed.

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

stepper.minimum = 0.0;
stepper.maximum = 100.0;
stepper.step = 1.0;
stepper.value = 10.0;
Available since

1.0.0

.

See also:

textInputFactory:AbstractDisplayObjectFactory<Dynamic, TextInput>

Creates the text input, which must be of type feathers.controls.TextInput.

In the following example, a custom text input factory is provided:

stepper.textInputFactory = () ->
{
	return new TextInput();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertytextInputGap:Float

The space, in pixels, between the text input sub-component and other content.

Available since

1.1.0

.

@:style@:flash.propertytextInputPosition:HorizontalAlign

The horizontal position of the text input, relative to the buttons.

Note: The HorizontalAlign.JUSTIFY constant is not supported by this component.

Available since

1.0.0

.

See also:

@:bindable("change")value:Float

The value of the stepper, which must be between the minimum and the maximum.

When the value property changes, the stepper will dispatch an event of type Event.CHANGE.

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

stepper.minimum = 0.0;
stepper.maximum = 100.0;
stepper.step = 1.0;
stepper.value = 12.0;
Available since

1.0.0

.

See also:

valueFormatFunction:Float ‑> String

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

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

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

1.0.0

.

valueParseFunction:String ‑> Float

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

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

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

@since 1.0.0

Methods

applyValueRestrictions():Void

Applies the minimum, maximum, and snapInterval restrictions to the current value.

Because it's possible to set value to a numeric value that is outside the allowed range, or to a value that has not been snapped to the interval, this method may be called to apply the restrictions manually.

Available since

1.0.0

.

Inherited Variables

Defined by FeathersControl

@:bindable("creationComplete")read onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:value(null)@:styledisabledAlpha:Null<Float> = null

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

@stylefocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:bindable("layoutDataChange")includeInLayout:Bool

@:bindable("initialize")read onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@style@:bindable("layoutDataChange")layoutData:ILayoutData

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

See also:

variant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

Defined by ValidatingSprite

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by FeathersControl

private@:dox(show)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. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithInvalidationFlagsOnly(callback:() ‑> Void):Void

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Available since

1.2.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.