Package | com.ghostwire.ui.controls |
Class | public class uiStepper |
Inheritance | uiStepper ![]() ![]() |
Subclasses | uiScrollBar, uiVStepper |
uiStepper
component consists of a pair of buttons arranged side-by-side horizontally
allowing the user to increment or decrement a value, within a predefined range, by pressing on either
button.
You cannot change the orientation of a uiStepper
instance - it is always horizontal. If
you need a vertical stepper, use the uiVStepper
class.
"padding" Property
Always 0
- attempting to set this property will throw an error.
"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.
"skin" Property
The default value is "Stepper"
and the asset(s) used are:
StepperDown.png StepperUp.png
~ This class is available in Aspire UI Components Lite Edition ~
See also
Property | Defined by | ||
---|---|---|---|
actionOnMouseOver : Boolean
Indicates whether value changes should occur once the mouse is over the stepper button instead
of only when the mouse is pressed down on the stepper button.
| uiStepper | ||
![]() | alignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
| uiComponent | |
![]() | alignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
| uiComponent | |
![]() | background : Object
Indicates the style of the background for this component.
| uiComponent | |
![]() | container : uiComponent
Indicates the
uiComponent instance that contains this instance. | uiComponent | |
![]() | depth : int
Indicates how deep the component is in the containment hierarchy.
| uiComponent | |
![]() | desiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
| uiComponent | |
![]() | desiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
| uiComponent | |
disableOnMinMax : Boolean
Indicates whether the stepper buttons should be individually disabled when the value is at
maximum/minimum.
| uiStepper | ||
![]() | enabled : Boolean
Indicates whether the component is enabled for user interaction.
| uiComponent | |
![]() | fillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
horizontal space.
| uiComponent | |
![]() | fillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
vertical space.
| uiComponent | |
![]() | focusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus
rectangle.
| uiComponent | |
![]() | focusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it
is in focus.
| uiComponent | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
inverted : Boolean
Indicates whether the left-hand-side button increments (
inverted set to
true ) or decrements (inverted set to false ) the value. | uiStepper | ||
![]() | margin : Object
Indicates the thickness of the space surrounding the component.
| uiComponent | |
![]() | maxHeight : int
Indicates the upper limit for
height . | uiComponent | |
![]() | maxWidth : int
Indicates the upper limit for
width . | uiComponent | |
![]() | minHeight : int
Indicates the lower limit for
height . | uiComponent | |
![]() | minWidth : int
Indicates the lower limit for
width . | uiComponent | |
![]() | padding : 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]
Indicates the
uiRange object used to determine the bounds of this stepper. | uiStepper | ||
repeatDelay : uint
Indicates the number of milliseconds to wait after a button is pressed down before the value is
changed.
| uiStepper | ||
repeatInterval : uint
Indicates how often the value will change while a button is being pressed down.
| uiStepper | ||
repeatSteps : int
Indicates the number of
step value changes before the increment/decrement starts using
page value instead. | uiStepper | ||
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
![]() | stretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this
component.
| uiComponent | |
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers
over this control.
| uiComponent | |
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent |
Method | Defined by | ||
---|---|---|---|
Constructor - creates a new
uiStepper instance. | uiStepper | ||
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
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 | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the range.value has changed. | uiStepper | |||
![]() |
Dispatched when the component's visible property is changed from true to
false via calling the setVisible() method. | uiComponent | ||
![]() |
Dispatched when the component's position within its parent container has changed via calling the
move() method. | uiComponent | ||
![]() |
Dispatched when the component's size has changed via calling the setSize() method. | uiComponent | ||
![]() |
Dispatched when the component's visible property is changed from false to
true via calling the setVisible() method. | uiComponent |
actionOnMouseOver | property |
public var actionOnMouseOver:Boolean
Indicates whether value changes should occur once the mouse is over the stepper button instead of only when the mouse is pressed down on the stepper button.
The default value is false
.
disableOnMinMax | property |
public var disableOnMinMax:Boolean
Indicates whether the stepper buttons should be individually disabled when the value is at maximum/minimum. This is purely for cosmetic purposes.
The default value is false
.
inverted | property |
public var inverted:Boolean
Indicates whether the left-hand-side button increments (inverted
set to
true
) or decrements (inverted
set to false
) the value.
In the case of a uiVStepper
, the bottom button increments (inverted
set to true
) or decrements (inverted
set to false
)
the value.
The default value is false
.
range | property |
range:uiRange
[read-only]
Indicates the uiRange
object used to determine the bounds of this stepper.
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
.
public function get range():uiRange
See also
repeatDelay | property |
repeatDelay:uint
[read-write]Indicates the number of milliseconds to wait after a button is pressed down before the value is changed. If the user releases the mouse or move the mouse outside the component before this timeout, the change is aborted.
The default value is 500
.
public function get repeatDelay():uint
public function set repeatDelay(value:uint):void
repeatInterval | property |
repeatInterval:uint
[read-write]Indicates how often the value will change while a button is being pressed down. This property is in milliseconds and represents the interval in between value change. Therefore, the lower the value, the faster the change.
The default value is 50
.
public function get repeatInterval():uint
public function set repeatInterval(value:uint):void
repeatSteps | property |
public var repeatSteps:int
Indicates the number of step
value changes before the increment/decrement starts using
page
value instead.
The default value is 0
.
uiStepper | () | constructor |
public function uiStepper(range:uiRange = null)
Constructor - creates a new uiStepper
instance.
range:uiRange (default = null ) — [Optional] A uiRange object specifying the initial value and limits of
the stepper. If undefined, a new uiRange object with default bounds will be used. You
can access this uiRange object via the range property.
|
change | event |