| Package | mx.controls.sliderClasses |
| Class | public class Slider |
| Inheritance | Slider  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | HSlider, VSlider |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Show MXML Syntax
Hide MXML SyntaxThe Slider class cannot be used as an MXML tag. Use the <mx:HSlider>
and <mx:VSlider> tags instead. However, the Slider class does define tag
attributes used by the <mx:HSlider> and <mx:VSlider> tags.
The Slider class inherits all of the tag attributes of its superclass, and adds the following tag attributes:
<mx:tagname
Properties
allowThumbOverlap="false|true"
allowTrackClick="true|false"
dataTipFormatFunction="undefined"
direction="horizontal|vertical"
labels="undefined"
liveDragging="false|true"
maximum="10"
minimum="0"
showDataTip="true|false"
sliderDataTipClass="sliderDataTip"
sliderThumbClass="SliderThumb"
snapInterval="0"
thumbCount="1"
tickInterval="0"
tickValues="undefined"
value="The value of the minimum property."
Styles
borderColor="0x919999"
dataTipOffset="16"
dataTipPrecision="2"
dataTipStyleName="undefined"
fillAlphas="[0.6, 0.4, 0.75, 0.65]"
fillColors="[0xFFFFFF, 0xCCCCCC, 0xFFFFFF, 0xEEEEEE;]"
labelOffset="-10"
labelStyleName="undefined"
showTrackHighlight="false"
slideDuration="300"
slideEasingFunction="undefined"
thumbDisabledSkin="SliderThumbSkin"
thumbDownSkin="SliderThumbSkin"
thumbOffset="0"
thumbOverSkin="SliderThumbSkin"
thumbUpSkin="SliderThumbSkin"
tickColor="0x6F7777"
tickLength="3"
tickOffset="-6"
tickThickness="1"
trackColors="[ 0xEEEEEE, 0xFFFFFF ]"
tracHighlightSkin="SliderHighlightSkin"
trackMargin="undefined"
trackSkin="SliderTrackSkin"
Events
change="No default"
thumbDrag="No default"
thumbPress="No default"
thumbRelease="No default"
/>
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowThumbOverlap : Boolean = false
If set to false, then each thumb can only be moved to the edge of
the adjacent thumb. | Slider | ||
| allowTrackClick : Boolean = true
Specifies whether clicking on the track will move the slider thumb. | Slider | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
|  cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| dataTipFormatFunction : Function
Callback function that formats the data tip text. | Slider | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| direction : String
The orientation of the slider control. | Slider | ||
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contians true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| labels : Array
An array of strings used for the slider labels. | Slider | ||
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | |
| liveDragging : Boolean = false
Specifies whether live dragging is enabled for the slider. | Slider | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maximum : Number
The maximum allowed value on the slider. | Slider | ||
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minimum : Number
The minimum allowed value on the slider control. | Slider | ||
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showDataTip : Boolean = true
If set to true, show a data tip during user interaction
containing the current value of the slider. | Slider | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| sliderDataTipClass : Class
A reference to the class to use for the data tip. | Slider | ||
| sliderThumbClass : Class
A reference to the class to use for each thumb. | Slider | ||
| snapInterval : Number
Specifies the increment value of the slider thumb
as the user moves the thumb. | Slider | ||
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient [read-only]
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| thumbCount : int
The number of thumbs allowed on the slider. | Slider | ||
| tickInterval : Number
The spacing of the tick marks relative to the maximum value
of the control. | Slider | ||
| tickValues : Array
The positions of the tick marks on the slider. | Slider | ||
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Number
Contains the position of the thumb, and is a number between the
minimum and maximum properties. | Slider | ||
| values : Array
An array of values for each thumb when thumbCount
is greater than 1. | Slider | ||
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| thumbStyleFilters : Object [read-only]
Set of styles to pass from the Slider to the thumbs. | Slider | ||
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Slider()
Constructor. | Slider | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
Returns the thumb object at the given index. | Slider | ||
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
This method sets the value of a slider thumb, and updates the display. | Slider | ||
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Processes the properties set on the component. | UIComponent | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
[override]
Calculates the amount of space that the component takes up. | Slider | ||
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
[override]
Positions the elements of the control. | Slider | ||
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the slider changes value due to mouse or keyboard interaction. | Slider | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched when the slider's thumb is pressed and then moved by the mouse. | Slider | |||
| Dispatched when the slider's thumb is pressed, meaning the user presses the mouse button over the thumb. | Slider | |||
| Dispatched when the slider's thumb is released, meaning the user releases the mouse button after a thumbPress event. | Slider | |||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
dataTipOffset | Type: Number Format: Length CSS Inheritance: no The offset, in pixels, of the data tip relative to the thumb. Used in combination with the dataTipPlacement
style property of the HSlider and VSlider controls.
The default value is 16. | Slider | ||
dataTipPrecision | Type: int CSS Inheritance: no Number of decimal places to use for the data tip text. A value of 0 means to round all values to an integer. The default value is 2. | Slider | ||
dataTipStyleName | Type: String CSS Inheritance: no The name of the style declaration to use for the data tip. The default value is undefined. | Slider | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
invertThumbDirection | Type: Boolean CSS Inheritance: no Invert the direction of the thumbs. If true, the thumbs will be flipped.
The default value is false. | Slider | ||
labelOffset | Type: Number Format: Length CSS Inheritance: no The y-position offset (if direction is horizontal) or x-position offset (if direction is vertical) of the labels relative to the track. The default value is -10. | Slider | ||
labelStyleName | Type: String CSS Inheritance: no The name of the style to use for the slider label. The default value is undefined. | Slider | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
showTrackHighlight | Type: Boolean CSS Inheritance: no Specifies whether to enable track highlighting between thumbs (or a single thumb and the beginning of the track). The default value is false. | Slider | ||
slideDuration | Type: Number Format: Time CSS Inheritance: no Duration in milliseconds for the sliding animation when you click on the track to move a thumb. The default value is 300. | Slider | ||
slideEasingFunction | Type: Function CSS Inheritance: no Tweening function used by the sliding animation when you click on the track to move a thumb. The default value is undefined. | Slider | ||
thumbDisabledSkin | Type: Class CSS Inheritance: no The skin for the slider thumb disabled state. The default value is SliderThumbSkin. | Slider | ||
thumbDownSkin | Type: Class CSS Inheritance: no The skin for the slider thumb down state. The default value is SliderThumbSkin. | Slider | ||
thumbOffset | Type: Number Format: Length CSS Inheritance: no The y-position offset (if direction is horizontal) or x-position offset (if direction is vertical) of the thumb relative to the track. The default value is 0. | Slider | ||
thumbOverSkin | Type: Class CSS Inheritance: no The skin for the slider thumb over state. The default value is SliderThumbSkin. | Slider | ||
thumbSkin | Type: Class CSS Inheritance: no The default skin for the slider thumb. The default value is SliderThumbSkin. | Slider | ||
thumbUpSkin | Type: Class CSS Inheritance: no The skin for the slider thumb up state. The default value is SliderThumbSkin. | Slider | ||
tickColor | Type: uint Format: Color CSS Inheritance: no The color of the tick marks. Can be a hex color value or the string name of a known color. The default value is 0x6F7777.. | Slider | ||
tickLength | Type: Number Format: Length CSS Inheritance: no The length in pixels of the tick marks. If direction is Direction.HORIZONTAL,
then adjust the height of the tick marks.
If direction is Direction.VERTICAL,
then adjust the width.
The default value is 3. | Slider | ||
tickOffset | Type: Number Format: Length CSS Inheritance: no The y-position offset (if direction is horizontal) or x-position offset (if direction is vertical) of the tick marks relative to the track. The default value is -6. | Slider | ||
tickThickness | Type: Number Format: Length CSS Inheritance: no The thickness in pixels of the tick marks. If direction is horizontal, then adjust the width of the tick marks. If direction is vertical, then adjust the height. The default value is 1. | Slider | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
trackHighlightSkin | Type: Class CSS Inheritance: no The skin for the slider track when it is selected. | Slider | ||
trackMargin | Type: Number Format: Length CSS Inheritance: no The size of the track margins, in pixels. If undefined, then the track margins will be determined
by the length of the first and last labels.
If given a value, Flex attempts to fit the labels in the available space.
The default value is undefined. | Slider | ||
trackSkin | Type: Class CSS Inheritance: no The skin for the slider track. | Slider | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the track highlight. The default value is #0099FF. | Slider | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus The default value is 0x70B2EE. | Slider | ||
Halo Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo The color of the black section of the border. The default value is 0x919999. | Slider | ||
fillAlphas | Type: Array CSS Inheritance: no Theme: halo Specifies the alpha transparency values used for the background fill of components. You should set this to an Array of either two or four numbers. Elements 0 and 1 specify the start and end values for an alpha gradient. If elements 2 and 3 exist, they are used instead of elements 0 and 1 when the component is in a mouse-over state. The global default value is [ 0.60, 0.40, 0.75, 0.65 ].
Some components, such as the ApplicationControlBar container,
have a different default value. For the ApplicationControlBar container,
the default value is [ 0.0, 0.0 ].
| Slider | ||
fillColors | Type: Array Format: Color CSS Inheritance: no Theme: halo Specifies the colors used to tint the background fill of the component. You should set this to an Array of either two or four uint values that specify RGB colors. Elements 0 and 1 specify the start and end values for a color gradient. If elements 2 and 3 exist, they are used instead of elements 0 and 1 when the component is in a mouse-over state. For a flat-looking control, set the same color for elements 0 and 1 and for elements 2 and 3, The default value is [ 0xFFFFFF, 0xCCCCCC, 0xFFFFFF, 0xEEEEEE ].
Some components, such as the ApplicationControlBar container,
have a different default value. For the ApplicationControlBar container,
the default value is | Slider | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
trackColors | Type: Array Format: Color CSS Inheritance: no Theme: halo The colors of the track, as an array of two colors. You can use the same color twice for a solid track color. You use this property along with the [ 0xE7E7E7, 0xE7E7E7 ]. | Slider | ||
Public Constants
Property Detail
allowThumbOverlap | property |
public var allowThumbOverlap:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If set to false, then each thumb can only be moved to the edge of
the adjacent thumb.
If true, then each thumb can be moved to any position on the track.
The default value is false.
allowTrackClick | property |
public var allowTrackClick:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether clicking on the track will move the slider thumb.
The default value is true.
dataTipFormatFunction | property |
dataTipFormatFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Callback function that formats the data tip text. The function takes a single Number as an argument and returns a formatted String.
The function has the following signature:
funcName(value:Number):String
The following example prefixes the data tip text with a dollar sign and
formats the text using the dataTipPrecision
of a Slider Control named 'slide':
import mx.formatters.NumberBase;
function myDataTipFormatter(value:Number):String {
var dataFormatter:NumberBase = new NumberBase(".", ",", ".", "");
return "$ " + dataFormatter.formatPrecision(String(value), slide.getStyle("dataTipPrecision"));
}
The default value is undefined.
Implementation
public function get dataTipFormatFunction():Function public function set dataTipFormatFunction(value:Function):voiddirection | property |
direction:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The orientation of the slider control.
Valid values in MXML are "horizontal" or "vertical".
In ActionScript, you use the following constants
to set this property:
SliderDirection.VERTICAL and
SliderDirection.HORIZONTAL.
The default value is SliderDirection.HORIZONTAL.
Implementation
public function get direction():String public function set direction(value:String):voidSee also
labels | property |
labels:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of strings used for the slider labels. Flex positions the labels at the beginning of the track, and spaces them evenly between the beginning of the track and the end of the track.
For example, if the array contains three items, the first item is placed at the beginning of the track, the second item in the middle, and the last item at the end of the track.
If only one label is specified, it is placed at the beginning of the track. By default, labels are placed above the tick marks (if present) or above the track. To align the labels with the tick marks, make sure that the number of tick marks is equal to the number of labels.
The default value is undefined.
Implementation
public function get labels():Array public function set labels(value:Array):voidliveDragging | property |
public var liveDragging:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether live dragging is enabled for the slider.
If false, Flex sets the value and
values properties and dispatches the change
event when the user stops dragging the slider thumb.
If true, Flex sets the value and
values properties and dispatches the change
event continuously as the user moves the thumb.
The default value is false.
maximum | property |
maximum:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum allowed value on the slider.
The default value is 10.
Implementation
public function get maximum():Number public function set maximum(value:Number):voidminimum | property |
minimum:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum allowed value on the slider control.
The default value is 0.
Implementation
public function get minimum():Number public function set minimum(value:Number):voidshowDataTip | property |
public var showDataTip:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If set to true, show a data tip during user interaction
containing the current value of the slider.
The default value is true.
sliderDataTipClass | property |
sliderDataTipClass:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the class to use for the data tip.
The default value is SliderDataTip.
Implementation
public function get sliderDataTipClass():Class public function set sliderDataTipClass(value:Class):voidsliderThumbClass | property |
sliderThumbClass:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the class to use for each thumb.
The default value is SliderThumb.
Implementation
public function get sliderThumbClass():Class public function set sliderThumbClass(value:Class):voidsnapInterval | property |
snapInterval:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the increment value of the slider thumb
as the user moves the thumb.
For example, if snapInterval is 2,
the minimum value is 0,
and the maximum value is 10,
the thumb snaps to the values 0, 2, 4, 6, 8, and 10
as the user move the thumb.
A value of 0, means that the slider moves continuously
between the minimum and maximum values.
The default value is 0.
Implementation
public function get snapInterval():Number public function set snapInterval(value:Number):voidthumbCount | property |
thumbCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of thumbs allowed on the slider.
Possible values are 1 or 2.
If set to 1, then the value property contains
the current value of the slider.
If set to 2, then the values property contains
an array of values representing the value for each thumb.
The default value is 1.
Implementation
public function get thumbCount():int public function set thumbCount(value:int):voidthumbStyleFilters | property |
thumbStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Set of styles to pass from the Slider to the thumbs.
Implementation
protected function get thumbStyleFilters():ObjectSee also
tickInterval | property |
tickInterval:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The spacing of the tick marks relative to the maximum value
of the control.
Flex displays tick marks whenever you set the tickInterval
property to a nonzero value.
For example, if tickInterval is 1 and
maximum is 10, then a tick mark is placed at each
1/10th interval along the slider.
A value of 0 shows no tick marks. If the tickValues property
is set to a non-empty Array, then this property is ignored.
The default value is 0.
Implementation
public function get tickInterval():Number public function set tickInterval(value:Number):voidtickValues | property |
tickValues:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The positions of the tick marks on the slider. The positions correspond
to the values on the slider and should be between
the minimum and maximum values.
For example, if the tickValues property
is [0, 2.5, 7.5, 10] and maximum is 10, then a tick mark is placed
in the following positions along the slider: the beginning of the slider,
1/4 of the way in from the left,
3/4 of the way in from the left, and at the end of the slider.
If this property is set to a non-empty Array, then the tickInterval property
is ignored.
The default value is undefined.
Implementation
public function get tickValues():Array public function set tickValues(value:Array):voidvalue | property |
value:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Contains the position of the thumb, and is a number between the
minimum and maximum properties.
Use the value property when thumbCount is 1.
When thumbCount is greater than 1, use the
values property instead.
The default value is equal to the minimum property.
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get value():Number public function set value(value:Number):voidvalues | property |
values:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of values for each thumb when thumbCount
is greater than 1.
This property can be used as the source for data binding. When this property is modified, it dispatches the change event.
Implementation
public function get values():Array public function set values(value:Array):voidConstructor Detail
Slider | () | Constructor |
public function Slider()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
getThumbAt | () | method |
public function getThumbAt(index:int):mx.controls.sliderClasses:SliderThumb| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the thumb object at the given index. Use this method to style and customize individual thumbs in a slider control.
Parameters
index:int — The zero-based index number of the thumb.
|
mx.controls.sliderClasses:SliderThumb — A reference to the SliderThumb object.
|
measure | () | method |
override protected function measure():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the amount of space that the component takes up. A horizontal slider control calculates its height by examining the position of its labels, tick marks, and thumbs relative to the track. The height of the control is equivalent to the position of the bottom of the lowest element subtracted from the position of the top of the highest element. The width of a horizontal slider control defaults to 250 pixels. For a vertical slider control, the width and the length measurements are reversed.
setThumbValueAt | () | method |
public function setThumbValueAt(index:int, value:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This method sets the value of a slider thumb, and updates the display.
Parameters
index:int — The zero-based index number of the thumb to set
the value of, where a value of 0 corresponds to the first thumb.
| |
value:Number — The value to set the thumb to
|
updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Positions the elements of the control.
The track, thumbs, labels, and tick marks are all positioned
and sized by this method.
The track is sized based on the length of the labels and on the track margin.
If you specify a trackMargin, then the size of the track
is equal to the available width minus the trackMargin times 2.
Tick marks are spaced at even intervals along the track starting from the beginning of the track. An additional tick mark is placed
at the end of the track if one doesn't already exist (if the tick interval isn't a factor of the maximum value). The tick mark
y-position is based on the tickOffset. An offset of 0 places the bottom of the tick at the top of the track. Negative offsets
move the ticks upwards while positive offsets move them downward through the track.
Labels are positioned at even intervals along the track. The labels are always horizontally centered above their
interval position unless the trackMargin setting is too small. If you specify a trackMargin, then the first and last labels will
position themselves at the left and right borders of the control. Labels will not crop or resize themselves if they overlap,
so be sure to allow enough space for them to fit on the track. The y-position is based on the labelOffset property. An offset of 0
places the bottom of the label at the top of the track. Unlike tick marks, the labels can not be positioned to overlap the track.
If the offset is a positive number, then the top of the label will be positioned below the bottom of the track.
The thumbs are positioned to overlap the track. Their x-position is determined by their value. The y-position is
controlled by the thumbOffset property. An offset of 0 places the center of the thumb at the center of the track. A negative
offset moves the thumbs upwards while a positive offset moves the thumbs downwards.
The placement of the tick marks, labels and thumbs are all independent from each other. They will not attempt to reposition themselves if they overlap.
For a vertical slider control, the same rules apply. In the above description, substitute width for height, height for width, left for up or top, right for down or bottom, x-position for y-position, and y-position for x-position.
Parameters
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
| |
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
Event Detail
change | Event |
Event Object Type:
property SliderEvent.type =
mx.events.SliderEventproperty SliderEvent.type =
mx.events.SliderEvent.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the slider changes value due to mouse or keyboard interaction.
If the liveDragging property is true,
the event is dispatched continuously as the user moves the thumb.
If liveDragging is false,
the event is dispatched when the user releases the slider thumb.
SliderEvent.CHANGE constant defines the value of the
type property of the event object for a change event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider track or a slider thumb was pressed. |
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. |
keyCode | If the event was triggered by a key press, the keycode for the key. |
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. |
thumbIndex | The zero-based index of the thumb whose position has changed. |
triggerEvent | Contains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent. |
value | The new value of the slider. |
thumbDrag | Event |
Event Object Type:
property SliderEvent.type =
mx.events.SliderEventproperty SliderEvent.type =
mx.events.SliderEvent.THUMB_DRAG| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the slider's thumb is pressed and then moved by the mouse.
This event is always preceded by a thumbPress event.
SliderEvent.THUMB_DRAG constant defines the value of the
type property of the event object for a thumbDrag event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider track or a slider thumb was pressed. |
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. |
keyCode | If the event was triggered by a key press, the keycode for the key. |
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. |
thumbIndex | The zero-based index of the thumb whose position has changed. |
triggerEvent | Contains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent. |
value | The new value of the slider. |
thumbPress | Event |
Event Object Type:
property SliderEvent.type =
mx.events.SliderEventproperty SliderEvent.type =
mx.events.SliderEvent.THUMB_PRESS| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the slider's thumb is pressed, meaning the user presses the mouse button over the thumb.
TheSliderEvent.THUMB_PRESS constant defines the value of the
type property of the event object for a thumbPress event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider track or a slider thumb was pressed. |
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. |
keyCode | If the event was triggered by a key press, the keycode for the key. |
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. |
thumbIndex | The zero-based index of the thumb whose position has changed. |
triggerEvent | Contains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent. |
value | The new value of the slider. |
thumbRelease | Event |
Event Object Type:
property SliderEvent.type =
mx.events.SliderEventproperty SliderEvent.type =
mx.events.SliderEvent.THUMB_RELEASE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the slider's thumb is released,
meaning the user releases the mouse button after
a thumbPress event.
SliderEvent.THUMB_RELEASE constant defines the value of the
type property of the event object for a thumbRelease event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider track or a slider thumb was pressed. |
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. |
keyCode | If the event was triggered by a key press, the keycode for the key. |
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. |
thumbIndex | The zero-based index of the thumb whose position has changed. |
triggerEvent | Contains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent. |
value | The new value of the slider. |
Thu May 20 2010, 02:19 AM -07:00