Package | feathers.controls |
Class | public class NumericStepper |
Inheritance | NumericStepper ![]() ![]() ![]() ![]() ![]() ![]() |
Implements | IRange, IAdvancedNativeFocusOwner, ITextBaselineControl |
Product Version : | Feathers 1.1.0 |
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
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
![]() | alpha : Number The opacity of the object. | DisplayObject | |
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | NumericStepper | ||
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
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 | ||
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : 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 | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : 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 | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
![]() | includeInLayout : 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 | ||
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : 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 | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | maxHeight : 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 | ||
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : 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 | ||
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
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 | ||
![]() | nextDownFocus : 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
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : 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
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : 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
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : 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 | |
![]() | nextUpFocus : 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
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | previousTabFocus : 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 | ||
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
step : Number
As the numeric stepper's buttons are pressed, the value is snapped to
a multiple of the step. | NumericStepper | ||
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : 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 | ||
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
useLeftAndRightKeys : Boolean
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. | NumericStepper | ||
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 | ||
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | |
![]() | actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | |
![]() | actualWidth : 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 | ||
![]() | defaultStyleProvider : 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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | NumericStepper | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | 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 | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | NumericStepper | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
createDecrementButton():void
Creates and adds the decrementButton sub-component and
removes the old instance, if one exists. | NumericStepper | ||
createIncrementButton():void
Creates and adds the incrementButton sub-component and
removes the old instance, if one exists. | NumericStepper | ||
createTextInput():void
Creates and adds the textInput sub-component and
removes the old instance, if one exists. | NumericStepper | ||
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when an object is added to a parent. | DisplayObject | ||
![]() | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
Dispatched when the stepper's value changes. | NumericStepper | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
![]() | Dispatched when a key on the keyboard is released. | DisplayObject | ||
![]() | Dispatched when an object is removed from its parent. | DisplayObject | ||
![]() | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when an object is touched. | DisplayObject |
Style | Description | Defined By | ||
---|---|---|---|---|
buttonGap | Type: 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 | NumericStepper | ||
buttonLayoutMode | Type: 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 | NumericStepper | ||
customDecrementButtonStyleName | Type: 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 | NumericStepper | ||
customIncrementButtonStyleName | Type: 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 | NumericStepper | ||
customTextInputStyleName | Type: 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 | NumericStepper | ||
decrementButtonLabel | Type: 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 . | NumericStepper | ||
![]() | Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
![]() | Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
incrementButtonLabel | Type: 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 . | NumericStepper | ||
textInputGap | Type: 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 | NumericStepper |
Constant | Defined 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 | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl |
baseline | property |
baseline:Number
[read-only] Returns the text baseline measurement, in pixels.
public function get baseline():Number
decrementButton | property |
protected var decrementButton:Button
The decrement button sub-component.
For internal use in subclasses.
See also
decrementButtonFactory | property |
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
.
public function get decrementButtonFactory():Function
public function set decrementButtonFactory(value:Function):void
See also
decrementButtonProperties | property |
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
.
public function get decrementButtonProperties():Object
public function set decrementButtonProperties(value:Object):void
See also
decrementButtonStyleName | property |
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
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all NumericStepper
components.
The default value is null
.
See also
incrementButton | property |
protected var incrementButton:Button
The increment button sub-component.
For internal use in subclasses.
See also
incrementButtonFactory | property |
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
.
public function get incrementButtonFactory():Function
public function set incrementButtonFactory(value:Function):void
See also
incrementButtonProperties | property |
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
.
public function get incrementButtonProperties():Object
public function set incrementButtonProperties(value:Object):void
See also
incrementButtonStyleName | property |
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
maximum | property |
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
.
public function get maximum():Number
public function set maximum(value:Number):void
See also
minimum | property |
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
.
public function get minimum():Number
public function set minimum(value:Number):void
See also
nativeFocus | property |
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.
public function get nativeFocus():Object
See also
repeatDelay | property |
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
.
public function get repeatDelay():Number
public function set repeatDelay(value:Number):void
step | property |
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
.
public function get step():Number
public function set step(value:Number):void
See also
textInput | property |
protected var textInput:TextInput
The text input sub-component.
For internal use in subclasses.
See also
textInputFactory | property |
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
.
public function get textInputFactory():Function
public function set textInputFactory(value:Function):void
See also
textInputProperties | property |
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
.
public function get textInputProperties():Object
public function set textInputProperties(value:Object):void
See also
textInputStyleName | property |
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
useLeftAndRightKeys | property |
useLeftAndRightKeys:Boolean
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
.
public function get useLeftAndRightKeys():Boolean
public function set useLeftAndRightKeys(value:Boolean):void
value | property |
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
.
public function get value():Number
public function set value(value:Number):void
See also
valueFormatFunction | property |
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
.
public function get valueFormatFunction():Function
public function set valueFormatFunction(value:Function):void
See also
valueParseFunction | property |
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
.
public function get valueParseFunction():Function
public function set valueParseFunction(value:Function):void
See also
NumericStepper | () | Constructor |
public function NumericStepper()
Constructor.
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.
ReturnsBoolean |
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
change | Event |
starling.events.Event
starling.events.Event.CHANGE
Dispatched when the stepper'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. |
See also
DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTON | Constant |
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_BUTTON | Constant |
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_INPUT | Constant |
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