| <!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="IViewport,spark.core.IViewport,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.IViewport</title><script src="../../AC_OETags.js" type="text/javascript"></script></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 = 'IViewport - 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/IViewport.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">IViewport</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#includeExamplesSummary">Examples</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("IViewport"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,true,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">Interface</td><td class="classSignature">public interface IViewport extends <a href="../../mx/core/IVisualElement.html">IVisualElement</a>, <a href="../../mx/core/ILayoutElement.html">ILayoutElement</a>, <a href="../../mx/core/ILayoutDirectionElement.html">ILayoutDirectionElement</a>, flash.events.IEventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../spark/components/supportClasses/GroupBase.html">GroupBase</a>, <a href="../../spark/components/RichEditableText.html">RichEditableText</a></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 IViewport interface is implemented by components that support a viewport. |
| If a component's children are larger than the component, |
| and you want to clip the children to the component boundaries, you can define a viewport and scroll bars. |
| A viewport is a rectangular subset of the area of a component that you want to display, |
| rather than displaying the entire component. |
| <p>A viewport on its own is not movable by the application user. |
| However, you can combine a viewport with scroll bars so the user can scroll |
| the viewport to see the entire content of the component. |
| Use the Scroller component to add scrolbars to the component.</p> |
| <p></p><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../spark/components/Scroller.html" target="">spark.components.Scroller</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></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="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#alpha" class="signatureLink">alpha</a> : Number<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#baseline" class="signatureLink">baseline</a> : Object<div class="summaryTableDescription"> |
| The vertical distance in pixels from the anchor target to |
| the control's baseline position.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#baselinePosition" class="signatureLink">baselinePosition</a> : Number<div class="summaryTableDescription">[read-only] |
| The y-coordinate of the baseline |
| of the first line of text of the component.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#bottom" class="signatureLink">bottom</a> : Object<div class="summaryTableDescription"> |
| The vertical distance in pixels from the bottom edge of the component to the |
| anchor target's bottom edge.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#clipAndEnableScrolling" class="signatureLink">clipAndEnableScrolling</a> : Boolean<div class="summaryTableDescription"> |
| If true, specifies to clip the children to the boundaries of the viewport.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#contentHeight" class="signatureLink">contentHeight</a> : Number<div class="summaryTableDescription">[read-only] |
| The height of the viewport's content.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#contentWidth" class="signatureLink">contentWidth</a> : Number<div class="summaryTableDescription">[read-only] |
| The width of the viewport's contents.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#depth" class="signatureLink">depth</a> : Number<div class="summaryTableDescription"> |
| Determines the order in which items inside of containers |
| are rendered.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#designLayer" class="signatureLink">designLayer</a> : <a href="../../mx/core/DesignLayer.html">DesignLayer</a><div class="summaryTableDescription"> |
| Specifies the optional DesignLayer instance associated with this visual |
| element.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#hasLayoutMatrix3D" class="signatureLink">hasLayoutMatrix3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Contains true if the element has 3D Matrix.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#height" class="signatureLink">height</a> : Number<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#horizontalCenter" class="signatureLink">horizontalCenter</a> : Object<div class="summaryTableDescription"> |
| The horizontal distance in pixels from the center of the component to the |
| center of the anchor target's content area.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#horizontalScrollPosition" class="signatureLink">horizontalScrollPosition</a> : Number<div class="summaryTableDescription"> |
| The x coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#includeInLayout" class="signatureLink">includeInLayout</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether this component is included in the layout of the |
| parent container.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#is3D" class="signatureLink">is3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Contains true when the element is in 3D.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutDirectionElement.html#layoutDirection" class="signatureLink">layoutDirection</a> : String<div class="summaryTableDescription"> |
| Specifies the desired layout direction for an element: one of LayoutDirection.LTR |
| (left to right), LayoutDirection.RTL (right to left), or null (inherit).</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutDirectionElement.html">ILayoutDirectionElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#left" class="signatureLink">left</a> : Object<div class="summaryTableDescription"> |
| The horizontal distance in pixels from the left edge of the component to the |
| anchor target's left edge.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#owner" class="signatureLink">owner</a> : DisplayObjectContainer<div class="summaryTableDescription"> |
| The owner of this IVisualElement object.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#parent" class="signatureLink">parent</a> : DisplayObjectContainer<div class="summaryTableDescription">[read-only] |
| The parent container or component for this component.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#percentHeight" class="signatureLink">percentHeight</a> : Number<div class="summaryTableDescription"> |
| Specifies the height of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#percentWidth" class="signatureLink">percentWidth</a> : Number<div class="summaryTableDescription"> |
| Specifies the width of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#postLayoutTransformOffsets" class="signatureLink">postLayoutTransformOffsets</a> : <a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a><div class="summaryTableDescription"> |
| Defines a set of adjustments that can be applied to the object's |
| transform in a way that is invisible to its parent's layout.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#right" class="signatureLink">right</a> : Object<div class="summaryTableDescription"> |
| The horizontal distance in pixels from the right edge of the component to the |
| anchor target's right edge.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#top" class="signatureLink">top</a> : Object<div class="summaryTableDescription"> |
| The vertical distance in pixels from the top edge of the component to the |
| anchor target's top edge.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/ILayoutElement.html#verticalCenter" class="signatureLink">verticalCenter</a> : Object<div class="summaryTableDescription"> |
| The vertical distance in pixels from the center of the component to the |
| center of the anchor target's content area.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalScrollPosition" class="signatureLink">verticalScrollPosition</a> : Number<div class="summaryTableDescription"> |
| The y coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#visible" class="signatureLink">visible</a> : Boolean<div class="summaryTableDescription"> |
| Controls the visibility of this visual element.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#width" class="signatureLink">width</a> : Number<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#x" class="signatureLink">x</a> : Number<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/core/IVisualElement.html#y" class="signatureLink">y</a> : Number<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getBoundsXAtSize()" class="signatureLink">getBoundsXAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the x coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getBoundsYAtSize()" class="signatureLink">getBoundsYAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the y coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getHorizontalScrollPositionDelta()" class="signatureLink">getHorizontalScrollPositionDelta</a>(navigationUnit:uint):Number</div><div class="summaryTableDescription"> |
| Returns the amount to add to the viewport's current |
| horizontalScrollPosition to scroll by the requested scrolling unit.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutBoundsHeight()" class="signatureLink">getLayoutBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's layout height.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutBoundsWidth()" class="signatureLink">getLayoutBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's layout width.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutBoundsX()" class="signatureLink">getLayoutBoundsX</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the x coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutBoundsY()" class="signatureLink">getLayoutBoundsY</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the y coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutMatrix()" class="signatureLink">getLayoutMatrix</a>():Matrix</div><div class="summaryTableDescription"> |
| Returns the transform matrix that is used to calculate the component's |
| layout relative to its siblings.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getLayoutMatrix3D()" class="signatureLink">getLayoutMatrix3D</a>():Matrix3D</div><div class="summaryTableDescription"> |
| Returns the layout transform Matrix3D for this element.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getMaxBoundsHeight()" class="signatureLink">getMaxBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's maximum height.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getMaxBoundsWidth()" class="signatureLink">getMaxBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's maximum width.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getMinBoundsHeight()" class="signatureLink">getMinBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's minimum height.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getMinBoundsWidth()" class="signatureLink">getMinBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's minimum width.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getPreferredBoundsHeight()" class="signatureLink">getPreferredBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's preferred height.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#getPreferredBoundsWidth()" class="signatureLink">getPreferredBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's preferred width.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getVerticalScrollPositionDelta()" class="signatureLink">getVerticalScrollPositionDelta</a>(navigationUnit:uint):Number</div><div class="summaryTableDescription"> |
| Returns the amount to add to the viewport's current |
| verticalScrollPosition to scroll by the requested scrolling unit.</div></td><td class="summaryTableOwnerCol">IViewport</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutDirectionElement.html#invalidateLayoutDirection()" class="signatureLink">invalidateLayoutDirection</a>():void</div><div class="summaryTableDescription"> |
| An element must call this method when its layoutDirection changes or |
| when its parent's layoutDirection changes.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutDirectionElement.html">ILayoutDirectionElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#setLayoutBoundsPosition()" class="signatureLink">setLayoutBoundsPosition</a>(x:Number, y:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| Sets the coordinates that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#setLayoutBoundsSize()" class="signatureLink">setLayoutBoundsSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| Sets the layout size of the element.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#setLayoutMatrix()" class="signatureLink">setLayoutMatrix</a>(value:Matrix, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| Sets the transform Matrix that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#setLayoutMatrix3D()" class="signatureLink">setLayoutMatrix3D</a>(value:Matrix3D, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| Sets the transform Matrix3D that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/ILayoutElement.html#transformAround()" class="signatureLink">transformAround</a>(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void</div><div class="summaryTableDescription"> |
| A utility method to update the rotation, scale, and translation of the |
| transform while keeping a particular point, specified in the component's |
| own coordinate space, fixed in the parent's coordinate space.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/ILayoutElement.html">ILayoutElement</a></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="clipAndEnableScrolling"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clipAndEnableScrolling</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>clipAndEnableScrolling: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> |
| If <code>true</code>, specifies to clip the children to the boundaries of the viewport. |
| If <code>false</code>, the container children extend past the container boundaries, |
| regardless of the size specification of the component. |
| |
| </p><p> The default value is <code>false</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get clipAndEnableScrolling():Boolean</code><br/><code> public function set clipAndEnableScrolling(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/layouts/supportClasses/LayoutBase.html#updateScrollRect" target="">spark.layouts.supportClasses.LayoutBase.updateScrollRect</a><br/><a href="IViewport.html#verticalScrollPosition" target="">verticalScrollPosition</a><br/><a href="IViewport.html#horizontalScrollPosition" target="">horizontalScrollPosition</a></div></div><a name="propertyDetail"></a><a name="contentHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>contentHeight:Number</code> [read-only] <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> |
| The height of the viewport's content. |
| |
| If <code>clipAndEnabledScrolling</code> is true, the viewport's |
| <code>contentHeight</code> defines the limit for vertical scrolling |
| and the viewport's actual height defines how much of the content is visible. |
| |
| To scroll through the content vertically, vary the |
| <code>verticalScrollPosition</code> between 0 and |
| <code>contentHeight - height</code>. |
| <p>Implementations of this property must be Bindable and |
| must generate events of type <code>propertyChange</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get contentHeight():Number</code><br/></div><a name="propertyDetail"></a><a name="contentWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>contentWidth:Number</code> [read-only] <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> |
| The width of the viewport's contents. |
| |
| If <code>clipAndEnabledScrolling</code> is true, the viewport's |
| <code>contentWidth</code> defines the limit for horizontal scrolling |
| and the viewport's actual width defines how much of the content is visible. |
| |
| To scroll through the content horizontally, vary the |
| <code>horizontalScrollPosition</code> between 0 and |
| <code>contentWidth - width</code>. |
| |
| <p>Implementations of this property must be Bindable and |
| must generate events of type <code>propertyChange</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get contentWidth():Number</code><br/></div><a name="propertyDetail"></a><a name="horizontalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalScrollPosition:Number</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> |
| The x coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component. |
| |
| If <code>clipAndEnableScrolling</code> is <code>true</code>, setting this property |
| typically causes the viewport to be set to: |
| <pre> |
| new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height) |
| </pre> |
| |
| Implementations of this property must be Bindable and |
| must generate events of type <code>propertyChange</code>. |
| |
| </p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get horizontalScrollPosition():Number</code><br/><code> public function set horizontalScrollPosition(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="IViewport.html#target" target="">target</a><br/><a href="IViewport.html#verticalScrollPosition" target="">verticalScrollPosition</a></div></div><a name="propertyDetail"></a><a name="verticalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalScrollPosition:Number</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> |
| The y coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component. |
| |
| If <code>clipAndEnableScrolling</code> is <code>true</code>, setting this property |
| typically causes the viewport to be set to: |
| <pre> |
| new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height) |
| </pre> |
| |
| Implementations of this property must be Bindable and |
| must generate events of type <code>propertyChange</code>. |
| |
| </p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get verticalScrollPosition():Number</code><br/><code> public function set verticalScrollPosition(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="IViewport.html#horizontalScrollPosition" target="">horizontalScrollPosition</a></div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getHorizontalScrollPositionDelta()"></a><a name="getHorizontalScrollPositionDelta(uint)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getHorizontalScrollPositionDelta</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number</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 the amount to add to the viewport's current |
| <code>horizontalScrollPosition</code> to scroll by the requested scrolling unit. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">navigationUnit</span>:uint</code> — The amount to scroll. |
| The value must be one of the following spark.core.NavigationUnit |
| constants: |
| <ul> |
| <li><code>LEFT</code></li> |
| <li><code>RIGHT</code></li> |
| <li><code>PAGE_LEFT</code></li> |
| <li><code>PAGE_RIGHT</code></li> |
| <li><code>HOME</code></li> |
| <li><code>END</code></li> |
| </ul> |
| To scroll by a single column, use <code>LEFT</code> or <code>RIGHT</code>. |
| To scroll to the first or last column, use <code>HOME</code> or <code>END</code>. |
| </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>Number</code> — The number of pixels to add to <code>horizontalScrollPosition</code>. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="NavigationUnit.html" target="">spark.core.NavigationUnit</a></div></div><a name="getVerticalScrollPositionDelta()"></a><a name="getVerticalScrollPositionDelta(uint)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getVerticalScrollPositionDelta</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getVerticalScrollPositionDelta(navigationUnit:uint):Number</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 the amount to add to the viewport's current |
| <code>verticalScrollPosition</code> to scroll by the requested scrolling unit. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">navigationUnit</span>:uint</code> — The amount to scroll. |
| The value of unit must be one of the following spark.core.NavigationUnit |
| constants: |
| <ul> |
| <li><code>UP</code></li> |
| <li><code>DOWN</code></li> |
| <li><code>PAGE_UP</code></li> |
| <li><code>PAGE_DOWN</code></li> |
| <li><code>HOME</code></li> |
| <li><code>END</code></li> |
| </ul> |
| To scroll by a single row use <code>UP</code> or <code>DOWN</code>. |
| To scroll to the first or last row, use <code>HOME</code> or <code>END</code>. |
| </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>Number</code> — The number of pixels to add to <code>verticalScrollPosition</code>. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="NavigationUnit.html" target="">spark.core.NavigationUnit</a></div></div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples</div><div class="exampleHeader">IViewportExample.mxml</div><div class="detailBody"><div class="listing"><pre><?xml version="1.0" encoding="utf-8"?> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| --> |
| <!-- Simple example to demonstrate Spark IViewport interface --> |
| <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" |
| xmlns:mx="library://ns.adobe.com/flex/mx" |
| xmlns:s="library://ns.adobe.com/flex/spark" > |
| <s:layout> |
| <s:HorizontalLayout/> |
| </s:layout> |
| |
| <s:Panel title="IViewport Component Example" |
| width="75%" height="75%" |
| horizontalCenter="0" verticalCenter="0"> |
| |
| <s:Label text="The Group container implements IViewport. Therefore, you can clip its contents and use it with scrollbars." |
| color="blue" |
| top="10"/> |
| <s:Group id="myGroup" width="100" height="100" |
| clipAndEnableScrolling="true" |
| horizontalScrollPosition="50" verticalScrollPosition="50" |
| left="100" top="40"> |
| <mx:Image width="300" height="400" |
| source="@Embed(source='/assets/logo.jpg')"/> |
| </s:Group> |
| <s:VScrollBar viewport="{myGroup}" height="100" left="210" top="40"/> |
| <s:HScrollBar viewport="{myGroup}" width="100" left="100" top="150"/> |
| |
| </s:Panel> |
| </s:Application> |
| </pre></div><script language="javascript" type="text/javascript"><!-- AC_FL_RunContent( "src", "examples/IViewportExample", "width", "100%", |
| "height","400px", "salign", "TL", "id", "example1", "quality", "high", "bgcolor", "", "name", |
| "example1", "flashvars","", "allowScriptAccess","sameDomain", "type", |
| "application/x-shockwave-flash","pluginspage", "http://www.macromedia.com/go/getflashplayer" ); --></script></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 --> |
