| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="SplashScreenImageSource,spark.preloaders.SplashScreenImageSource,aspectRatio,dpi,minResolution,mxmlContent,preloader,source,stageHeight,stageWidth"><title>spark.preloaders.SplashScreenImageSource</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'SplashScreenImageSource - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?spark/preloaders/SplashScreenImageSource.html&spark/preloaders/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">SplashScreenImageSource</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("SplashScreenImageSource"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">spark.preloaders</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SplashScreenImageSource</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">SplashScreenImageSource <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p></p><p></p><p></p> |
| 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. |
| <p>You typically use one or more SplashScreenImageSource |
| objects to define a SplashScreenImage class in MXML |
| and set the application's <code>splashScreenImage</code> property to that class.</p> |
| <p>Shown below is SplashScreenImage component with three different |
| definitions for SplashScreenImageSource:</p> |
| <pre> |
| <?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> |
| </pre> |
| <p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> |
| <p>The <code><s:SplashScreenImageSource></code> tag inherits all of the tag |
| attributes of its superclass and adds the following tag attributes:</p> |
| |
| <pre> |
| <s:SplashScreenImageSource |
| <strong>Properties</strong> |
| aspectRatio="null" |
| dpi="NaN" |
| minResolution="NaN" |
| source="null" |
| > |
| </pre> |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="SplashScreenImage.html" target="">spark.preloaders.SplashScreenImage</a><br/><a href="../../spark/components/Application.html#splashScreenImage" target="">spark.components.Application.splashScreenImage</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#aspectRatio" class="signatureLink">aspectRatio</a> : String = null<div class="summaryTableDescription"> |
| The required aspect ratio of the mobile device.</div></td><td class="summaryTableOwnerCol">SplashScreenImageSource</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#dpi" class="signatureLink">dpi</a> : Number = NaN<div class="summaryTableDescription"> |
| The required DPI of the device to display the associated image.</div></td><td class="summaryTableOwnerCol">SplashScreenImageSource</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#minResolution" class="signatureLink">minResolution</a> : Number = NaN<div class="summaryTableDescription"> |
| The required minimum size of the mobile device's resolution needed |
| to display the image.</div></td><td class="summaryTableOwnerCol">SplashScreenImageSource</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#source" class="signatureLink">source</a> : Class<div class="summaryTableDescription"> |
| The image class for the splash screen to use for the defined |
| device configuration.</div></td><td class="summaryTableOwnerCol">SplashScreenImageSource</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#SplashScreenImageSource()" class="signatureLink">SplashScreenImageSource</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">SplashScreenImageSource</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="aspectRatio"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> aspectRatio</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var aspectRatio:String = null</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p></p><p> |
| The required aspect ratio of the mobile device. |
| This property can be either <code>flash.display.StageAspectRatio.PORTRAIT</code> |
| or <code>flash.display.StageAspectRatio.LANDSCAPE</code>. |
| |
| <p>If not set, then <code>SplashScreenImage</code> ignores this property.</p> |
| </p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.StageAspectRatio</div></div><a name="propertyDetail"></a><a name="dpi"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> dpi</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var dpi:Number = NaN</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p></p><p> |
| The required DPI of the device to display the associated image. |
| |
| <p>A value of NaN means the property is ignored by SplashScreenImage.</p> |
| |
| </p><p> The default value is <code>NaN</code>.</p></div><a name="propertyDetail"></a><a name="minResolution"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> minResolution</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var minResolution:Number = NaN</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p></p><p> |
| 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 <code>minResolution</code> property is compared against the larger |
| of the values of the <code>Stage.stageWidth</code> and <code>Stage.stageHeight</code> properties. |
| The larger of the two values must be equal to or greater than the <code>minResolution</code> property. |
| |
| <p>You can use this property to display different images based on the pixel |
| resolution of a device.</p> |
| <p>A value of NaN means the property is ignored by the SplashScreenImage.</p> |
| |
| </p><p> The default value is <code>NaN</code>.</p></div><a name="propertyDetail"></a><a name="source"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> source</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var source:Class</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p></p><p> |
| The image class for the splash screen to use for the defined |
| device configuration. |
| Typically you set this property to an embedded resource. |
| |
| <p>For example:</p> |
| <pre> |
| <s:SplashScreenImageSource |
| source="@Embed('assets/logo240Portrait.jpg')" |
| dpi="240" |
| aspectRatio="portrait"/> |
| </pre> |
| |
| </p><p> The default value is <code>null</code>.</p><p><span class="label">See also</span></p><div class="seeAlso"><a href="SplashScreenImage.html" target="">spark.preloaders.SplashScreenImage</a></div></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="SplashScreenImageSource()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> SplashScreenImageSource</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function SplashScreenImageSource()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>AIR 3</td></tr></table><p></p><p> |
| Constructor. |
| |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
