| <!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="NavigationUnit,spark.core.NavigationUnit,ALPHA,AUTO,CLIP,DOWN,END,HOME,LEFT,LUMINOSITY,NEVER,OWNS_SHARED_OBJECT,OWNS_UNSHARED_OBJECT,PAGE_DOWN,PAGE_LEFT,PAGE_RIGHT,PAGE_UP,RIGHT,UNTRUSTED,UP,USES_SHARED_OBJECT,accessibilityProperties,activeRequests,baseline,baselinePosition,blendMode,bottom,cacheEntries,cachedData,clipAndEnableScrolling,complete,content,contentHeight,contentWidth,depth,designLayer,displayAsPassword,displayObject,displayObjectSharingMode,editable,enableCaching,enableQueueing,enabled,focusEnabled,hasLayoutMatrix3D,horizontalCenter,horizontalScrollPosition,horizontalScrollPosition,id,includeInLayout,is3D,isTruncated,layoutDirection,left,lineBreak,luminosityClip,luminosityInvert,mask,maskType,maxActiveRequests,maxCacheEntries,maxChars,moduleFactory,multiline,numCacheEntries,owner,percentHeight,percentWidth,postLayoutTransformOffsets,priorityGroup,redrawRequested,requestQueue,restrict,right,rotationX,rotationY,selectable,selectionActivePosition,selectionAnchorPosition,tabIndex,text,top,transformX,transformY,transformZ,verticalCenter,verticalScrollPosition,verticalScrollPosition,viewHeight,viewWidth,visible,addCacheEntry,appendText,canShareWithNext,canShareWithPrevious,createDisplayObject,getBoundsXAtSize,getBoundsYAtSize,getCacheEntry,getHorizontalScrollPositionDelta,getLayoutBoundsHeight,getLayoutBoundsWidth,getLayoutBoundsX,getLayoutBoundsY,getLayoutMatrix,getLayoutMatrix3D,getMaxBoundsHeight,getMaxBoundsWidth,getMinBoundsHeight,getMinBoundsWidth,getPreferredBoundsHeight,getPreferredBoundsWidth,getVerticalScrollPositionDelta,initialized,insertText,invalidateGraphicElementDisplayList,invalidateGraphicElementProperties,invalidateGraphicElementSharing,invalidateGraphicElementSize,invalidateLayoutDirection,invalidateParentSizeAndDisplayList,isNavigationUnit,keepSoftKeyboardActive,load,load,parentChanged,prepareForTouchScroll,prioritize,removeAllCacheEntries,removeAllQueueEntries,removeCacheEntry,scrollToRange,selectAll,selectRange,setFocus,setLayoutBoundsPosition,setLayoutBoundsSize,setLayoutMatrix,setLayoutMatrix3D,setSharedDisplayObject,transformAround,transformHeightForLayout,transformPointToParent,transformWidthForLayout,validateDisplayList,validateProperties,validateSize"><title>spark.core.NavigationUnit</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 = 'NavigationUnit - 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/core/NavigationUnit.html&spark/core/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">NavigationUnit</td><td class="titleTableSubNav" id="subNav" align="right"><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("NavigationUnit"); titleBar_setSubNav(true,false,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.core</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public final class NavigationUnit</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">NavigationUnit <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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p> |
| The NavigationUnit class defines the possible values for the |
| <code>getVerticalScrollPositionDelta()</code> and |
| <code>getHorizontalScrollPositionDelta()</code> |
| methods of the IViewport class. |
| |
| <p>All of these constants have the same values as their flash.ui.Keyboard |
| counterparts, except PAGE_LEFT and PAGE_RIGHT, for which no keyboard |
| key equivalents exist.</p> |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso">flash.ui.Keyboard<br/><a href="IViewport.html#getVerticalScrollPositionDelta" target="">IViewport.getVerticalScrollPositionDelta</a><br/><a href="IViewport.html#getHorizontalScrollPositionDelta" target="">IViewport.getHorizontalScrollPositionDelta</a></div><br/><hr></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="#isNavigationUnit()" class="signatureLink">isNavigationUnit</a>(keyCode:uint):Boolean</div><div class="summaryTableDescription">[static] |
| Returns true if the keyCode maps directly |
| to a NavigationUnit enum value.</div></td><td class="summaryTableOwnerCol">NavigationUnit</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="#DOWN" class="signatureLink">DOWN</a> : uint = 40.0<div class="summaryTableDescription">[static] |
| Navigate one line or "step" downwards.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#END" class="signatureLink">END</a> : uint = 35.0<div class="summaryTableDescription">[static] |
| Navigate to the end of the document.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#HOME" class="signatureLink">HOME</a> : uint = 36.0<div class="summaryTableDescription">[static] |
| Navigate to the origin of the document.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#LEFT" class="signatureLink">LEFT</a> : uint = 37.0<div class="summaryTableDescription">[static] |
| Navigate one line or "step" to the left.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#PAGE_DOWN" class="signatureLink">PAGE_DOWN</a> : uint = 34.0<div class="summaryTableDescription">[static] |
| Navigate one page downwards.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#PAGE_LEFT" class="signatureLink">PAGE_LEFT</a> : uint = 0x2397<div class="summaryTableDescription">[static] |
| Navigate one page to the left.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#PAGE_RIGHT" class="signatureLink">PAGE_RIGHT</a> : uint = 0x2398<div class="summaryTableDescription">[static] |
| Navigate one page to the right.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#PAGE_UP" class="signatureLink">PAGE_UP</a> : uint = 33.0<div class="summaryTableDescription">[static] |
| Navigate one page upwards.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#RIGHT" class="signatureLink">RIGHT</a> : uint = 39.0<div class="summaryTableDescription">[static] |
| Navigate one line or "step" to the right.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#UP" class="signatureLink">UP</a> : uint = 38.0<div class="summaryTableDescription">[static] |
| Navigate one line or "step" upwards.</div></td><td class="summaryTableOwnerCol">NavigationUnit</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="isNavigationUnit()"></a><a name="isNavigationUnit(uint)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isNavigationUnit</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function isNavigationUnit(keyCode:uint):Boolean</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns <code>true</code> if the <code>keyCode</code> maps directly |
| to a NavigationUnit enum value. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">keyCode</span>:uint</code> — A key code value. |
| </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>Boolean</code> — <code>true</code> if the <code>keyCode</code> maps directly |
| to a NavigationUnit enum value. |
| |
| </td></tr></table></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="DOWN"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DOWN</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const DOWN:uint = 40.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one line or "step" downwards. |
| |
| </p></div><a name="constantDetail"></a><a name="END"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">END</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const END:uint = 35.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate to the end of the document. |
| |
| </p></div><a name="constantDetail"></a><a name="HOME"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">HOME</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const HOME:uint = 36.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate to the origin of the document. |
| |
| </p></div><a name="constantDetail"></a><a name="LEFT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">LEFT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const LEFT:uint = 37.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one line or "step" to the left. |
| |
| </p></div><a name="constantDetail"></a><a name="PAGE_DOWN"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">PAGE_DOWN</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const PAGE_DOWN:uint = 34.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one page downwards. |
| |
| </p></div><a name="constantDetail"></a><a name="PAGE_LEFT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">PAGE_LEFT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const PAGE_LEFT:uint = 0x2397</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one page to the left. |
| |
| The value of this constant, 0x2397, is the same as the Unicode |
| "previous page" character. |
| |
| </p></div><a name="constantDetail"></a><a name="PAGE_RIGHT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">PAGE_RIGHT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const PAGE_RIGHT:uint = 0x2398</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one page to the right. |
| |
| The value of this constant, 0x2398, is the same as the Unicode |
| "next page" character. |
| |
| </p></div><a name="constantDetail"></a><a name="PAGE_UP"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">PAGE_UP</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const PAGE_UP:uint = 33.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one page upwards. |
| |
| </p></div><a name="constantDetail"></a><a name="RIGHT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">RIGHT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const RIGHT:uint = 39.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one line or "step" to the right. |
| |
| </p></div><a name="constantDetail"></a><a name="UP"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UP</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const UP:uint = 38.0</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</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Navigate one line or "step" upwards. |
| |
| </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 --> |
