| <!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="CSSDimension,mx.styles.CSSDimension,CLASS,ID,NOT_A_COLOR,NO_UNIT,PSEUDO,UNIT_CM,UNIT_DP,UNIT_INCH,UNIT_PT,ancestor,className,className,className,conditions,defaultFactory,factory,filterMap,id,id,id,inheritingStyles,inheritingStyles,inheritingStyles,kind,major,minor,moduleFactory,nonInheritingStyles,nonInheritingStyles,nonInheritingStyles,overrides,parent,pixelValue,revision,selector,selectorIndex,selectors,selectors,source,specificity,specificity,specificity,styleDeclaration,styleDeclaration,styleDeclaration,styleManager,styleName,styleName,styleName,styleParent,styleParent,styleParent,subject,subject,unit,value,value,clearStyle,clearStyle,clearStyle,clearStyle,clearStyleDeclaration,clearStyleDeclaration,compareTo,compareTo,getClassStyleDeclarations,getClassStyleDeclarations,getClassStyleDeclarations,getColorName,getColorName,getColorNames,getColorNames,getMergedStyleDeclaration,getStyle,getStyle,getStyle,getStyle,getStyleDeclaration,getStyleDeclaration,getStyleManager,hasCSSState,hasCSSState,hasCSSState,initialized,isColorName,isColorName,isInheritingStyle,isInheritingStyle,isInheritingTextFormatStyle,isInheritingTextFormatStyle,isParentDisplayListInvalidatingStyle,isParentDisplayListInvalidatingStyle,isParentSizeInvalidatingStyle,isParentSizeInvalidatingStyle,isSizeInvalidatingStyle,isSizeInvalidatingStyle,isValidStyleValue,isValidStyleValue,loadStyleDeclarations,loadStyleDeclarations,matchesCSSState,matchesCSSState,matchesCSSState,matchesCSSType,matchesCSSType,matchesCSSType,matchesStyleClient,matchesStyleClient,matchesStyleClient,notifyStyleChangeInChildren,notifyStyleChangeInChildren,notifyStyleChangeInChildren,regenerateStyleCache,regenerateStyleCache,regenerateStyleCache,registerColorName,registerColorName,registerEffects,registerEffects,registerEffects,registerInheritingStyle,registerInheritingStyle,registerParentDisplayListInvalidatingStyle,registerParentDisplayListInvalidatingStyle,registerParentSizeInvalidatingStyle,registerParentSizeInvalidatingStyle,registerSizeInvalidatingStyle,registerSizeInvalidatingStyle,setDeferredStyles,setStyle,setStyle,setStyle,setStyle,setStyleDeclaration,setStyleDeclaration,setStyleDeclarations,styleChanged,styleChanged,styleChanged,stylesInitialized,stylesInitialized,stylesInitialized,toString,toString,toString,toString,unload,unloadStyleDeclarations,unloadStyleDeclarations"><title>mx.styles.CSSDimension</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 = 'CSSDimension - 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?mx/styles/CSSDimension.html&mx/styles/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">CSSDimension</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</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("CSSDimension"); titleBar_setSubNav(true,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')">mx.styles</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CSSDimension</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CSSDimension <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.13</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.0</td></tr></table><p></p><p></p><p></p><p></p> |
| Represents a dimension with an optional unit, to be used in css media queries. |
| <p>Valid units are: |
| no unit |
| px : pixel |
| in : inch |
| cm : centimeter |
| pt : point |
| dp : device independent pixel ( 1 pix at about 160 DPI ) |
| </p> |
| |
| <p></p><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"><a href="#pixelValue" class="signatureLink">pixelValue</a> : Number<div class="summaryTableDescription">[read-only] |
| Dimension converted to actual pixels, considering the current device DPI |
| </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#unit" class="signatureLink">unit</a> : String<div class="summaryTableDescription">[read-only] Dimension unit, as a string, or empty string if no unit |
| </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#value" class="signatureLink">value</a> : Number<div class="summaryTableDescription">[read-only] Dimension value as a number, without the unit |
| </div></td><td class="summaryTableOwnerCol">CSSDimension</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"><a href="#CSSDimension()" class="signatureLink">CSSDimension</a>(value:Number, refDPI:Number, unit:String)</div><div class="summaryTableDescription"> Constructor |
| </div></td><td class="summaryTableOwnerCol">CSSDimension</td></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="#compareTo()" class="signatureLink">compareTo</a>(other:<a href="../../mx/styles/CSSDimension.html">CSSDimension</a>):int</div><div class="summaryTableDescription"> |
| Compares to another CSSDimension instance.</div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription"> |
| Printable string of the dimension |
| </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#NO_UNIT" class="signatureLink">NO_UNIT</a> : String<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#UNIT_CM" class="signatureLink">UNIT_CM</a> : String = cm<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#UNIT_DP" class="signatureLink">UNIT_DP</a> : String = dp<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#UNIT_INCH" class="signatureLink">UNIT_INCH</a> : String = in<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">CSSDimension</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#UNIT_PT" class="signatureLink">UNIT_PT</a> : String = pt<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">CSSDimension</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="pixelValue"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">pixelValue</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>pixelValue:Number</code> [read-only] <p></p><p></p><p> |
| Dimension converted to actual pixels, considering the current device DPI |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get pixelValue():Number</code><br/></div><a name="propertyDetail"></a><a name="unit"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unit</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>unit:String</code> [read-only] <p></p><p></p><p> Dimension unit, as a string, or empty string if no unit |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get unit():String</code><br/></div><a name="propertyDetail"></a><a name="value"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">value</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>value:Number</code> [read-only] <p></p><p></p><p> Dimension value as a number, without the unit |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get value():Number</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CSSDimension()"></a><a name="CSSDimension(Number,Number,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CSSDimension</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CSSDimension(value:Number, refDPI:Number, unit:String)</code><p></p><p> Constructor |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">value</span>:Number</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">refDPI</span>:Number</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">unit</span>:String</code> (default = <code>NaN</code>)<code></code></td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="compareTo()"></a><a name="compareTo(mx.styles.CSSDimension)"></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"> compareTo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function compareTo(other:<a href="../../mx/styles/CSSDimension.html">CSSDimension</a>):int</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.13</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.0</td></tr></table><p></p><p></p><p> |
| Compares to another CSSDimension instance. |
| Actual pixel values are used for comparison, so dimensions can have different units. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">other</span>:<a href="../../mx/styles/CSSDimension.html">CSSDimension</a></code> — another CSSDimension instance |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code> — 0 if both dimensions are of equal value. rounding errors may occur due to conversion |
| -1 if <code>this</code> is lower than <code>other</code>. |
| 1 if <code>this</code> is greater than <code>other</code>. |
| </td></tr></table></div><a name="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function toString():String</code><p></p><p></p><p> |
| Printable string of the dimension |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> — version as a string |
| </td></tr></table></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="NO_UNIT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">NO_UNIT</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const NO_UNIT:String</code><p></p></div><a name="constantDetail"></a><a name="UNIT_CM"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UNIT_CM</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const UNIT_CM:String = cm</code><p></p></div><a name="constantDetail"></a><a name="UNIT_DP"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UNIT_DP</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const UNIT_DP:String = dp</code><p></p></div><a name="constantDetail"></a><a name="UNIT_INCH"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UNIT_INCH</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const UNIT_INCH:String = in</code><p></p></div><a name="constantDetail"></a><a name="UNIT_PT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UNIT_PT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const UNIT_PT:String = pt</code><p></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 --> |
