Packagespark.preloaders
Classpublic class SplashScreenImageSource
InheritanceSplashScreenImageSource Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

Use the SplashScreenImageSource class to specify a Class (typically an embedded image) to be displayed as splash screen at a particular device configuration such as DPI, orientation and resolution.

You typically use one or more SplashScreenImageSource objects to define a SplashScreenImage class in MXML and set the application's splashScreenImage property to that class.

Shown below is SplashScreenImage component with three different definitions for SplashScreenImageSource:

    <?xml version="1.0" encoding="utf-8"?> 
    <s:SplashScreenImage xmlns:fx="http://ns.adobe.com/mxml/2009" 
        xmlns:s="library://ns.adobe.com/flex/spark"> 
     
        <!-- Default splashscreen image. --> 
        <s:SplashScreenImageSource 
            source="@Embed('assets/logoDefault.jpg')"/> 
        
        <s:SplashScreenImageSource 
            source="@Embed('assets/logo240Portrait.jpg')" 
            dpi="240" 
            aspectRatio="portrait"/> 
        
        <s:SplashScreenImageSource 
            source="@Embed('assets/logo240Landscape.jpg')" 
            dpi="240" 
            aspectRatio="landscape"/> 
        
    </s:SplashScreenImage>      
  

MXML SyntaxexpandedHide MXML Syntax

The <s:SplashScreenImageSource> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:SplashScreenImageSource
   Properties
    aspectRatio="null"
    dpi="NaN"
    minResolution="NaN"
    source="null"
  >
  

See also

spark.preloaders.SplashScreenImage
spark.components.Application.splashScreenImage


Public Properties
 PropertyDefined By
  AIR-only aspectRatio : String = null
The required aspect ratio of the mobile device.
SplashScreenImageSource
  AIR-only dpi : Number = NaN
The required DPI of the device to display the associated image.
SplashScreenImageSource
  AIR-only minResolution : Number = NaN
The required minimum size of the mobile device's resolution needed to display the image.
SplashScreenImageSource
  AIR-only source : Class
The image class for the splash screen to use for the defined device configuration.
SplashScreenImageSource
Public Methods
 MethodDefined By
  
Constructor.
SplashScreenImageSource
Property Detail
AIR-only aspectRatioproperty
public var aspectRatio:String = null

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

The required aspect ratio of the mobile device. This property can be either flash.display.StageAspectRatio.PORTRAIT or flash.display.StageAspectRatio.LANDSCAPE.

If not set, then SplashScreenImage ignores this property.

See also

flash.display.StageAspectRatio
AIR-only dpiproperty 
public var dpi:Number = NaN

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

The required DPI of the device to display the associated image.

A value of NaN means the property is ignored by SplashScreenImage.

The default value is NaN.

AIR-only minResolutionproperty 
public var minResolution:Number = NaN

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

The required minimum size of the mobile device's resolution needed to display the image. The device resolution is the maximum of the stage width and height, in pixels. The value of the minResolution property is compared against the larger of the values of the Stage.stageWidth and Stage.stageHeight properties. The larger of the two values must be equal to or greater than the minResolution property.

You can use this property to display different images based on the pixel resolution of a device.

A value of NaN means the property is ignored by the SplashScreenImage.

The default value is NaN.

AIR-only sourceproperty 
public var source:Class

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

The image class for the splash screen to use for the defined device configuration. Typically you set this property to an embedded resource.

For example:

            <s:SplashScreenImageSource 
                source="@Embed('assets/logo240Portrait.jpg')" 
                dpi="240" 
                aspectRatio="portrait"/> 
      

The default value is null.

See also

Constructor Detail
AIR-only SplashScreenImageSource()Constructor
public function SplashScreenImageSource()

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : AIR 3

Constructor.