Packagecom.dwuser.ss4.ui.loaders
Classpublic class UILoader
InheritanceUILoader Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
SubclassesGroupLoader, SingleLoader

The UILoader class functions as the base class for the SingleLoader and GroupLoader elements, which display the loading progress for image preloading.

The SingleLoader element is displayed when a single image is being loaded; the GroupLoader element is displayed when a group of images (such as an entire gallery) is being preloaded.

The UILoader creates the actual loader display based on the type style parameter. This new loader (which is, based on the type, an mx.controls.ProgressBar or custom variant thereof) inherits all of the styles directly from the UILoader instance. Because of this, all relevant loader styles set on the UILoader instance will directly affect the loader display. It may be helpful to reference the mx.controls.ProgressBar documentation for more possible style values in addition to the common ones listed directly on this class.

Generally, the themeColor, trackColors and barColor properties are the most important and affect the most settings.

Layout XML Syntax Example:

Because the UILoader subclass elements are used to display all loading progress, it is often best to place it inside an overlay-type layout view.

The UILoader should NOT be used by itself; instead, it should be implemented through a SingleLoader or GroupLoader instance.

The UILoader class inherits all of the tag attributes of its superclass. The themeColor and color styles have customized defaults.

   <UILoader 
      Main Styles
      type="ProgressCircle|ProgressBar|ProgressLine|ProgressZipLine|ProgressImage"
      showDelay="1000"
      fadeTime="1000"
      labelPlacement="bottom|top|left|right|center"
      defaultWidth="125"
      defaultHeight="-65"
      baseLabel="Loading Image...{P}% or Loading Images...{P}%"
      customImageURL="undefined"
      customImageScaleMode="scaleDown"
      
      LoadingCircle-Specific Styles
      frameWidth="1"
      innerRadius="12"
      alphaInner="0.4"
      alphaBackground="0.8"    
  
      Loader-Specific Styles (May not apply to all "type"s)
      barColor="undefined"
      barSkin="ProgressBarSkin|ProgressBarSkinCircle"
      borderColor="#AAB3B3"
      color="#FFFFFF"
      disabledColor="#AAB3B3"
      fontAntiAliasType="advanced"
      fontFamily="Verdana"
      fontGridFitType="pixel"
      fontSharpness="0"
      fontSize="10"
      fontThickness="0"
      fontStyle="normal|italic"
      fontWeight="normal|bold"
      horizontalGap="8"
      indeterminateMoveInterval="26"
      indeterminateSkin="ProgressIndeterminateSkin"
      labelWidth="Computed"
      leading="0"
      maskSkin="ProgressMaskSkin|ProgressMaskSkinCircle"
      paddingLeft="0"
      paddingRight="0"
      textAlign="left|right|center"
      textDecoration="none|underline"
      textIndent="0"
      themeColor="#FFFFFF"
      trackColors="#E6EEEE"
      trackHeight="Calculated"
      trackSkin="ProgressTrackSkin,ProgressTrackSkinCircle"
      verticalGap="6"
   />
   

Element Pictorial Example:

See also

GroupLoader
SingleLoader
mx.controls.ProgressBar


Public Properties
 PropertyDefined by
 InheritedactiveEffects : Array
The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationTabularData : Object
An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
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
 InheritedbaselinePosition : Number
The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedcacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
The name of this instance's class, such as "Button".
UIComponent
 InheritedcontentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcurrentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedglobalX : Number
UIComponent
 InheritedglobalY : Number
UIComponent
 Inheritedheight : Number
Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : Boolean
Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmiscHolder : Object
A utility holder for any various properties
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 Inheritedmove_enableProtection : Boolean = false
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
The number of automation children this container has.
UIComponent
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
 Inheritedparent : DisplayObjectContainer
The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedrepeater : IRepeater
A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 InheritedscaleX : Number
Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
Number that specifies the vertical scaling factor.
UIComponent
 Inheritedscreen : Rectangle
Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedsetActualSize_enableProtection : Boolean = false
UIComponent
 InheritedsetVisible_enableProtection : Boolean = true
UIComponent
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
  slideshow : FlashSlideshow
UILoader
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the styleName property) override inline styles.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 Inheritedvisible : Boolean
Controls the visibility of this UIComponent.
UIComponent
 Inheritedvisible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
UIComponent
 Inheritedwidth : Number
Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 InheritedxmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
UIComponent
 Inheritedy : Number
Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
Protected Properties
 PropertyDefined by
 InheritedunscaledHeight : Number
A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
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
 MethodDefined by
  
UILoader
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
UIComponent
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
UIComponent
 Inherited
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
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
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may 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
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
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
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
  
setProgress(progressPercent:Number):void
Sets the progress percentage displayed on the loader.
UILoader
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
UIComponent
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
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
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
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
Protected Methods
 MethodDefined by
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
  
UILoader
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
  
measure():void
UILoader
 Inherited
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
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
UILoader
Events
 EventSummaryDefined by
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIComponent
 Inherited Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited Dispatched after the view state has changed.UIComponent
 Inherited Dispatched after the currentState property changes, but before the view state changes.UIComponent
 Inherited 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
 Inherited Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited Dispatched after an effect ends.UIComponent
 Inherited Dispatched just before an effect starts.UIComponent
 Inherited Dispatched after the component has returned to the root view state.UIComponent
 Inherited Dispatched before the component exits from the root view state.UIComponent
 Inherited Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited Dispatched when the object has moved.UIComponent
 Inherited Dispatched at the beginning of the component initialization sequence.UIComponent
 Inherited Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIComponent
 Inherited Dispatched when the component is resized.UIComponent
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 StyleDescriptionDefined by
  
alphaBackground
Type: Number   Format: Alpha   CSS Inheritance: no
Specifies the alpha (opacity) of the background ring when using the ProgressCircle loader type. Valid values range from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 0.4.
UILoader
  
alphaInner
Type: Number   Format: Alpha   CSS Inheritance: no
Specifies the alpha (opacity) of the ring's fill when using the ProgressCircle loader type. Valid values range from 0.0 (fully transparent) to 1.0 (fully opaque). The default value is 0.8.
UILoader
  
barColor
Type: uint   Format: Color   CSS Inheritance: yes
Determines the color of a ProgressBar. A ProgressBar is filled with a vertical gradient between this color and a brighter color computed from it. This style has no effect on other components, but can be set on a container to control the appearance of all progress bars found within. The default value is undefined, which means it is not set. In this case, the themeColor style property is used.
UILoader
  
barSkin
Type: Class   CSS Inheritance: no
Skin style for a determinate progress bar. The default value is mx.skins.halo.ProgressBarSkin or com.dwuser.ss4.skins.ProgressBarSkinCircle based upon <code>type</code>.
UILoader
  
baseLabel
Type: String   CSS Inheritance: no
Specifies the label displayed on the loader. Set this value to an empty string to not display any label; customize it if you want to localize the displayed label.

To display the currently-completed percentage, use the {P} replacement value in the label value.

For the SingleLoader, the default value is: Loading Image...{P}%

For the GroupLoader, the default value is: Loading Images...{P}%

The default value is Loading Image...{P}% _or_ Loading Images...{P}%".
UILoader
 Inherited 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
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Black section of a three-dimensional border, or the color section of a two-dimensional border. The default value is #B7BABC.
UILoader
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color brightness of the component.
UIComponent
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.
UILoader
 Inherited Type: Number   CSS Inheritance: no
The color contrast of the component.
UIComponent
  
customImageURL
Type: String   Format: File   CSS Inheritance: no
Specifies the URL of a custom loading image or animation. By default, this parameter is set to undefined. If this value is explicitly set, the type parameter will automatically be updated to be ProgressImage so that the custom image is displayed. The URL should be to an image file (JPEG, PNG, or GIF), or a SWF animation. The default value is undefined.
UILoader
  
defaultHeight
Type: Number   Format: Length   CSS Inheritance: no
Specifies the default height of the component. This style is generally not used, because if you want to explicitly set the width or height on a SingleLoader or GroupLoader element, you do so as follows in the Layout XML:
   <SingleLoader|GroupLoader ... height="50" ... />
   

Instead, this is simply a global default value which establishes the standard or "normal" size. You should only explicitly modify the width or height values if the default dimensions are not resulting in proper centering. This especially could be the case if you are using a type of ProgressImage (displaying a custom loader image).

The default value is -65.
UILoader
  
defaultWidth
Type: Number   Format: Length   CSS Inheritance: no
Specifies the default width of the component. This style is generally not used, because if you want to explicitly set the width or height on a SingleLoader or GroupLoader element, you do so as follows in the Layout XML:
   <SingleLoader|GroupLoader ... width="100" ... />
   

Instead, this is simply a global default value which establishes the standard or "normal" size. You should only explicitly modify the width or height values if the default dimensions are not resulting in proper centering. This especially could be the case if you are using a type of ProgressImage (displaying a custom loader image).

The default value is 125.
UILoader
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.
UILoader
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
  
fadeTime
Type: Number   Format: Time   CSS Inheritance: no
Specifies the duration, in milliseconds, over which the fade-in or fade-out effect should take place when the loader is hidden or revealed. To have an immediate show/hide, with no fade effect, set this value to 0. Using a value such as 1000 (1 second; the default) provides a more smooth visual transition. The default value is 1000.
UILoader
 Inherited Type: String   CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 Inherited Type: Class   CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the font. Set to "normal" to disable the advanced anti-aliasing.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others.

The default value is "advanced".
UILoader
  
fontFamily
Type: String   CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana".
UILoader
  
fontGridFitType
Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "pixel".
UILoader
  
fontSharpness
Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
UILoader
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
UILoader
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".
UILoader
  
fontThickness
Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
UILoader
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
UILoader
  
frameWidth
Type: Number   Format: Length   CSS Inheritance: no
Specifies the width of the outer ring when using the ProgressCircle loader type. The default value is 1.
UILoader
 Inherited 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
  
horizontalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8.
UILoader
 Inherited
hue
Type: Number   CSS Inheritance: no
The color hue of the component.
UIComponent
  
indeterminateMoveInterval
Type: Number   CSS Inheritance: no
The number of pixels to move the indeterminate progress bar for each indeterminate loop. Once the progress bar has moved the specified number of pixels, it gets respositioned back to its starting point. A value of 0 means that the bar is not moved. The default value is 26.
UILoader
  
indeterminateSkin
Type: Class   CSS Inheritance: no
Skin style for an indeterminate progress bar. The default value is mx.skins.halo.ProgressIndeterminateSkin.
UILoader
  
innerRadius
Type: Number   Format: Length   CSS Inheritance: no
Specifies the radius of the inner ring when using the ProgressCircle loader type. The default value is 12.
UILoader
  
kerning
Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.
UILoader
  
labelPlacement
Type: String   Format: Enumerated   CSS Inheritance: no
Specifies the placement of the label.

Only applicable when the type parameter is set to ProgressCircle, ProgressBar, or ProgressLine.

Valid values are "right", "left", "bottom", "center", and "top". The default value is bottom.
UILoader
  
labelWidth
Type: Number   Format: Length   CSS Inheritance: yes
The width of the label in pixels. If the value is NaN, the control sets it to the width of the control. The default value is NaN.
UILoader
  
leading
Type: Number   Format: Length   CSS Inheritance: yes
Additional vertical space between lines of text.

The default value is 2.

The default value is 2.
UILoader
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.
UILoader
  
maskSkin
Type: Class   CSS Inheritance: no
Skin style for the mask of the determinate and indeterminate bars. The default value is mx.skins.halo.ProgressMaskSkin or com.dwuser.ss4.skins.ProgressMaskSkinCircle based upon <code>type</code>.
UILoader
 Inherited Type: Number   CSS Inheritance: no
The opacity of the component.
UIComponent
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.

The default value is 0.

UILoader
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.

The default value is 0.

UILoader
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color saturation of the component.
UIComponent
  
scaleMode
Type: String   Format: Enumerated   CSS Inheritance: no
Specifies the scaling mode used on the custom loading image/animation (if one has been specified). Possible values include showAvailable, scaleDown, scaleUpAndDown, and fillArea. To learn more about each of these values, see the IndividualSlide.scaleMode property. The default value is scaleDown.
UILoader
  
showDelay
Type: Number   Format: Time   CSS Inheritance: no
Specifies the delay, in milliseconds, before the loader appears after it has been requested. By setting this to a small duration, such as 1000 (1 second), the loader will only appear if the loading takes at least one whole second to complete. This ensures that quick loads never disrupt the user with a momentary in-out flash of the progress bar. The default value is 1000.
UILoader
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

UILoader
  
textDecoration
Type: String   CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".
UILoader
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.
UILoader
  
themeColor
Type: uint   Format: Color   CSS Inheritance: yes
Theme color of the loader. If the type property is set to ProgressBar, ProgressLine, or ProgressCircle, this determines the theme color, especially of the fill. If the type is set to ProgressImage, this property is not used. The default value is Inherited themeColor.
UILoader
 Inherited
top
Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
  
trackColors
Type: Array   Format: Color   CSS Inheritance: no
The colors of the track, as an array of two numerical colors or a single hex color value. You can use the same color twice for a solid track color. The default value is #E6EEEE.
UILoader
  
trackHeight
Type: Number   Format: Length   CSS Inheritance: no
The height of the track in pixels. If the value is NaN, then use the height of the skin specified by the trackSkin property. The default value is NaN.
UILoader
  
trackSkin
Type: Class   CSS Inheritance: no
Skin style for the progress indicator track. The default value is mx.skins.halo.ProgressTrackSkin or com.dwuser.ss4.skins.ProgressTrackSkinCircle based upon <code>type</code>.
UILoader
  
type
Type: String   Format: Enumerated   CSS Inheritance: no
Defines the type of loader displayed. Possible values include:

  • ProgressCircle - (Default) Displays a ring indicator which fills in a clockwise manner as the loading takes place.
  • ProgressBar - Displays a progress bar which fills as the loading takes place.
  • ProgressLine - Just like ProgressBar, but is automatically set to have a thickness of only 1 pixels. This makes only a single line visible, for a minimalist appearance.
  • ProgressZipLine - Similar to ProgressLine; displays a label-less indicator line with a thickness of 1 pixel. When revealed, it rapidly expands in width, fills, then rapidly contracts back. This makes only a single line visible, for a minimalist appearance.
  • ProgressImage - Displays a custom preloading image or animation, based on the image or SWF URL specified in the customImageURL property.

If the customImageURL style property is set, the type automatically defaults to ProgressImage.

The default value is ProgressCircle, or ProgressImage if customImageURL has been set.
UILoader
 Inherited 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
  
verticalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6.
UILoader
Effects
 EffectDescriptionDefined by
 Inherited Triggering event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering event: move
Played when the component is moved.
UIComponent
 Inherited Triggering event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined by
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property detail
slideshowproperty
slideshow:FlashSlideshow  [read-write]Implementation
    public function get slideshow():FlashSlideshow
    public function set slideshow(value:FlashSlideshow):void
Constructor detail
UILoader()constructor
public function UILoader()
Method detail
createChildren()method
protected override function createChildren():void
measure()method 
protected override function measure():void
setProgress()method 
public function setProgress(progressPercent:Number):void

Sets the progress percentage displayed on the loader. This method is called automatically as loading takes place and should NOT be called directly.

Parameters
progressPercent:Number — The percentage of loading which is complete, 0 - 100.
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number
 
unscaledHeight:Number