Packagecom.ghostwire.ui.controls
Classpublic class uiStepperInput
InheritanceuiStepperInput Inheritance uiTextInput Inheritance uiText Inheritance uiComponent Inheritance flash.display.Sprite

The uiStepperInput component is used to display single line editable numeric value. In addition to an input text field, the component also contains a uiVStepper instance that can be used by the user to adjust the value via the mouse.

"range" Property
You need to access the values represented by the component via the range property. For example, range.value, range.minimum, range.maximum, etc. To modify the minimum and maximum parameters, use the range.resize(minimum,maximum) method.

"skin" Property
The default value is "StepperInput" and the asset(s) used are:

 StepperInput.png
 StepperInputStepDown.png
 StepperInputStepUp.png
 

Events
The component itself will not dispatch events related to the range values. Listen for events that are dispatched by the uiRange object instead.

~ This class is available in Aspire UI Components Lite Edition ~

See also

com.ghostwire.ui.data.uiRange


Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 InheriteddefaultEmbedFonts : Boolean
[static] Deprecated.
uiText
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
  digits : int
Indicates the number of decimal places to display.
uiStepperInput
 InheriteddisplayAsPassword : Boolean
Indicates whether the text should be shown as asterisks instead of the actual characters.
uiTextInput
 Inheritededitable : Boolean
Indicates whether the text can be edited by the user.
uiTextInput
 Inheritedellipsis : String = "..."
[static] Indicates the string to use as an ellipsis if ellipsize is set to true.
uiText
 Inheritedellipsize : Boolean
Always false.
uiTextInput
 InheritedembedFonts : Boolean
Indicates whether this uiText object should use embedded fonts.
uiText
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 Inheritedhint : String
Indicates the text to display in the text field when there is no input value and the instance is not in focus.
uiTextInput
 Inheritedhtml : Boolean
Indicates whether the text is HTML enabled.
uiText
 InheritedimeMode : String
Indicates the mode of the input method editor (IME).
uiTextInput
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
  range : uiRange
[read-only] Returns the uiRange object represented by this component.
uiStepperInput
 Inheritedrestrict : String
Indicates the set of characters that a user can enter into the text field.
uiTextInput
 Inheritedselectable : Boolean
Indicates whether the text is selectable.
uiText
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 Inheritedtext : String
Indicates the current text displayed by the component.
uiText
 InheritedtextField : TextField
Indicates the native Flash Player TextField object embedded in this uiText instance.
uiText
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
  uistepper : uiVStepper
[read-only] Returns the embedded uiVStepper instance - for advanced users only.
uiStepperInput
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
 Inheritedwrap : Boolean
Indicates whether the text should wrap.
uiText
Public Methods
 MethodDefined by
  
uiStepperInput(range:uiRange = null)
Constructor - creates a new uiStepperInput instance.
uiStepperInput
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the text in the component changes.uiTextInput
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
 Inherited Dispatched when the user enters, deletes, or pastes text into the component.uiTextInput
Property detail
digitsproperty
digits:int  [read-write]

Indicates the number of decimal places to display. The value can be between 0 to 20.

Implementation
    public function get digits():int
    public function set digits(value:int):void
rangeproperty 
range:uiRange  [read-only]

Returns the uiRange object represented by this component. This is the same as accessing uistepper.range.

This property is read-only. To modify the minimum and maximum parameters of this component, use the resize(min,max) method of the uiRange object. For example, range.resize(16,60). Likewise, you must set the value via range.value.

The component itself will not dispatch events related to the range values. Listen for events that are dispatched by the uiRange object instead.

Implementation
    public function get range():uiRange

See also

uistepperproperty 
uistepper:uiVStepper  [read-only]

Returns the embedded uiVStepper instance - for advanced users only. This property is exposed in case you would like greater control over the embedded uiVStepper instance.

Implementation
    public function get uistepper():uiVStepper
Constructor detail
uiStepperInput()constructor
public function uiStepperInput(range:uiRange = null)

Constructor - creates a new uiStepperInput instance.

Parameters
range:uiRange (default = null) — [Optional] A uiRange object indicating the range of numeric values to use. Your application can access the uiRange object via the range property.

See also

com.ghostwire.ui.core.uiRange