| Package | spark.components.supportClasses |
| Class | public class SliderBase |
| Inheritance | SliderBase  TrackBase Range SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
| Implements | IFocusManagerComponent |
| Subclasses | HSlider, VSlider |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Hide MXML SyntaxThe <s:SliderBase> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<s:SliderBase
Properties
dataTipFormatFunction="20"
dataTipPrecision="2"
maximum="10"
showDataTip="true"
maxDragRate=30
Styles
alignmentBaseline="USE_DOMINANT_BASELINE"
baselineShift="0.0"
cffHinting="HORIZONTAL_STEM"
color="0"
digitCase="DEFAULT"
digitWidth="DEFAULT"
direction="LTR"
dominantBaseline="AUTO"
focusAlph="0.55"
focusColor="0xFFFFFF"
fontFamily="Arial"
fontLookup="DEVICE"
fontSize="12"
fontStyle="NORMAL"
fontWeight="NORMAL"
justificationRule="AUTO"
justificationStyle="AUTO"
kerning="AUTO"
ligatureLevel="COMMON"
lineHeight="120%"
lineThrough="false"
liveDragging="true"
local="en"
renderingMode="CFF"
textAlignLast="START"
textAlpha="1"
textDecoration="NONE"
textJustify="INTER_WORD"
trackingLeft="0"
trackingRight="0"
typographicCase="DEFAULT"
/>
See also
| 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 | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| 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 | |
| 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
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | |
| 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 | |
| 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. | SliderBase | ||
| dataTipPrecision : int = 2
Number of decimal places to use for the data tip text. | SliderBase | ||
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains 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 | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | 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 | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maximum : Number [override]
Number which represents the maximum value possible for
value. | SliderBase | ||
| 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 valid value. | Range | |
| 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 | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| 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 | |
| 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 : 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 | |
| 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
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | 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]
| UIComponent | |
| 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 | |
| showDataTip : Boolean = true
If set to true, shows a data tip during user interaction
containing the current value of the slider. | SliderBase | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| snapInterval : Number
The snapInterval property controls the valid values of the value property. | Range | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| stepSize : Number
The amount that the value property
changes when the changeValueByStep() method is called. | Range | |
| 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
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| 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 | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| 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 | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Number
The current value for this range. | Range | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | 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]
| UIComponent | |
| Property | Defined By | ||
|---|---|---|---|
| currentCSSState : String [override] [read-only]
The state to be used when matching CSS pseudo-selectors. | SkinnableComponent | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| maxDragRate : Number = 30
Maximum number of times per second we will change the slider position
and update the display while dragging. | SliderBase | ||
| pendingValue : Number
The value the slider will have when the mouse button is released. | SliderBase | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SliderBase | ||
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| changeValueByStep(increase:Boolean = true):void
Increases or decreases value by stepSize. | Range | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
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 | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
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 | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRepeaterItem(whichRepeater:int = -1):Object
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 | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHTMLText(htmlText:String):TextLineMetrics
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 | |
| measureText(text:String):TextLineMetrics
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 | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
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 | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
| toString():String [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 | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
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 | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
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 | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| addMXMLChildren(comps:Array):void | UIComponent | |
| adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | |
| applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
| attachSkin():void
Create the skin for the component. | SkinnableComponent | |
| canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | |
| childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | |
| clearSkinParts():void
Clear out references to skin parts. | SkinnableComponent | |
| commitProperties():void
Processes the properties set on the component. | UIComponent | |
| createChildren():void
Create child objects of the component. | UIComponent | |
| createDynamicPartInstance(partName:String):Object
Create an instance of a dynamic skin part. | SkinnableComponent | |
| createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
| createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | |
| detachSkin():void
Destroys and removes the skin for this component. | SkinnableComponent | |
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
| findSkinParts():void
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | |
| focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | |
| focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | |
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
| getCurrentSkinState():String
Returns the name of the state to be applied to the skin. | SkinnableComponent | |
| getDynamicPartAt(partName:String, index:int):Object
Returns a specific instance of a dynamic part. | SkinnableComponent | |
| initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
| initializationComplete():void
Finalizes the initialization of this component. | UIComponent | |
| initializeAccessibility():void
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 | |
| isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
| keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | |
| keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | |
| measure():void
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
| nearestValidValue(value:Number, interval:Number):Number
Returns the sum of the minimum with an integer multiple of interval that's
closest to value, unless value is closer to the maximum limit,
in which case the maximum is returned. | Range | |
| numDynamicParts(partName:String):int
Returns the number of instances of a dynamic part. | SkinnableComponent | |
| partAdded(partName:String, instance:Object):void
Called when a skin part is added. | SkinnableComponent | |
| partRemoved(partName:String, instance:Object):void
Called when an instance of a skin part is being removed. | SkinnableComponent | |
| pointToValue(x:Number, y:Number):Number
Converts a track-relative x,y pixel location into a value between
the minimum and maximum, inclusive. | TrackBase | |
| removeDynamicPartInstance(partName:String, instance:Object):void
Remove an instance of a dynamic part. | SkinnableComponent | |
| resourcesChanged():void
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 | |
| setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
| setValue(value:Number):void
Sets the backing store for the value property and
dispatches a valueCommit event if the property changes. | Range | |
| stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
updateDataTip(dataTipInstance:IDataRenderer, initialPosition:Point):void
Used to position the data tip when it is visible. | SliderBase | ||
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children. | UIComponent | |
| updateSkinDisplayList():void
Sets the bounds of skin parts, typically the thumb, whose geometry isn't fully
specified by the skin's layout. | TrackBase | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
alignmentBaseline | Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline For the Mobile theme, this is not supported. See also | SliderBase | ||
| 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 | ||
baselineShift | Type: Object CSS Inheritance: yes Amount to shift the baseline. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift. For the Mobile theme, this is not supported. See also | SliderBase | ||
| 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 | ||
cffHinting | Type: String CSS Inheritance: yes The type of CFF hinting used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting. For the Mobile theme, this is not supported. See also | SliderBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | ||
digitCase | Type: String CSS Inheritance: yes The type of digit case used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase. For the Mobile theme, this is not supported. See also | SliderBase | ||
digitWidth | Type: String CSS Inheritance: yes Type of digit width used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth. For the Mobile theme, this is not supported. See also | SliderBase | ||
direction | Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction. For the Mobile theme, this is not supported. See also | SliderBase | ||
dominantBaseline | Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to
determine the vertical position of the element on the line.
For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline. For the Mobile theme, this is not supported. See also | SliderBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
focusAlpha | Type: Number CSS Inheritance: no Theme: spark, mobile The alpha of the focus ring for this component. The default value is 0.55. | SliderBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The default value is 0xFFFFFF. | SliderBase | ||
| 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 | ||
fontFamily | Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontFamily, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontFamily. The default value for the Spark theme is See also | SliderBase | ||
fontLookup | Type: String CSS Inheritance: yes Font lookup to use. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup For the Mobile theme, this is not supported. See also | SliderBase | ||
fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontStyle, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontStyle. See also | SliderBase | ||
| 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 | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
justificationRule | Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule For the Mobile theme, this is not supported. See also | SliderBase | ||
justificationStyle | Type: String CSS Inheritance: yes The style used for justification of the paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle For the Mobile theme, this is not supported. See also | SliderBase | ||
kerning | Type: String CSS Inheritance: yes The style used for justification of the paragraph. Kerning is enabled by default for Spark components, but is disabled by default for MX components.
Spark components interpret For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning For the Mobile theme, this is not supported. See also | SliderBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
leading | Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported. See also | SliderBase | ||
| 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 | ||
letterSpacing | Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported. See also | SliderBase | ||
ligatureLevel | Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel For the Mobile theme, this is not supported. See also | SliderBase | ||
lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.
For the Mobile theme, this is not supported. See See also | SliderBase | ||
lineThrough | Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough For the Mobile theme, this is not supported. See also | SliderBase | ||
liveDragging | Type: Boolean CSS Inheritance: no When true, the thumb's value is
committed as it is dragged along the track instead
of when the thumb button is released.
The default value is true. | SliderBase | ||
locale | Type: String CSS Inheritance: yes The locale of the text. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese. The default value is undefined. This property inherits its value from an ancestor; if
still undefined, it inherits from the global When using the Spark formatters and globalization classes, you can set this style on the
root application to the value of the undefined.See also | SliderBase | ||
renderingMode | Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode For the Mobile theme, this is not supported. See also | SliderBase | ||
| 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 | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
| Type: Number Format: Time CSS Inheritance: no Duration in milliseconds for a sliding animation when you click on the track to move a thumb. | TrackBase | ||
textAlignLast | Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast For the Mobile theme, this is not supported. See also | SliderBase | ||
textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha For the Mobile theme, this is not supported. See also | SliderBase | ||
textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textDecoration, and if using StyleableStageText, this is not supported. See also | SliderBase | ||
textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify For the Mobile theme, this is not supported. See also | SliderBase | ||
| 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 | ||
trackingLeft | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft For the Mobile theme, this is not supported. See also | SliderBase | ||
trackingRight | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight For the Mobile theme, this is not supported. See also | SliderBase | ||
typographicCase | Type: String CSS Inheritance: yes The type of typographic case used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase For the Mobile theme, this is not supported. See also | SliderBase | ||
| 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 | ||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
dataTip:IFactory | Required: false Part Type: Dynamic A skin part that defines a dataTip that displays a formatted version of the current value. The dataTip appears while the thumb is being dragged. This is a dynamic skin part and must be of type IFactory. The IFactory must return an object of type IDataRenderer | SliderBase | ||
| Required: false Part Type: Static A skin part that defines a button that can be dragged along the track to increase or decrease the value property. Updates to the value property automatically update the position of the thumb button with respect to the track. | TrackBase | ||
| Required: false Part Type: Static A skin part that defines a button that, when pressed, sets the value property to the value corresponding with the current button position on the track. | TrackBase | ||
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| dataTipFormatFunction | property |
dataTipFormatFunction:Function| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
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):Object
The following example prefixes the data tip text with a dollar sign and
formats the text using the dataTipPrecision
of a SliderBase Control named 'slide':
import mx.formatters.NumberBase;
function myDataTipFormatter(value:Number):Object {
var dataFormatter:NumberBase = new NumberBase(".", ",", ".", "");
return "$ " + dataFormatter.formatPrecision(String(value), slide.dataTipPrecision);
}
The default value is undefined.
public function get dataTipFormatFunction():Function public function set dataTipFormatFunction(value:Function):void| dataTipPrecision | property |
public var dataTipPrecision:int = 2| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Number of decimal places to use for the data tip text.
A value of 0 means to round all values to an integer.
This value is ignored if dataTipFormatFunction is defined.
The default value is 2.
| maxDragRate | property |
protected var maxDragRate:Number = 30| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Maximum number of times per second we will change the slider position and update the display while dragging.
| maximum | property |
maximum:Number[override] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Number which represents the maximum value possible for
value. If the values for either
minimum or value are greater
than maximum, they will be changed to
reflect the new maximum
The default value is 10.
public function get maximum():Number public function set maximum(value:Number):void| pendingValue | property |
pendingValue:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The value the slider will have when the mouse button is released. This property
also holds the temporary values set during an animation of the thumb if
the liveDragging style is true; the real value is only set
when the animation ends.
If the liveDragging style is false, then the slider's value is only set
when the mouse button is released. The value is not updated while the slider thumb is
being dragged.
This property is updated when the slider thumb moves, even if
liveDragging is false.
The default value is 0.
protected function get pendingValue():Number protected function set pendingValue(value:Number):void| showDataTip | property |
public var showDataTip:Boolean = true| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
If set to true, shows a data tip during user interaction
containing the current value of the slider. In addition, the skinPart,
dataTip, must be defined in the skin in order to
display a data tip.
The default value is true.
| SliderBase | () | Constructor |
public function SliderBase()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
| updateDataTip | () | method |
protected function updateDataTip(dataTipInstance:IDataRenderer, initialPosition:Point):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Used to position the data tip when it is visible. Subclasses must implement this function.
Parameters
dataTipInstance:IDataRenderer — The dataTip instance to update and position
| |
initialPosition:Point — The initial position of the dataTip in the skin
|