blob: 57efdd7b3a4c6b4df9809f03a4a72c59b05bcc6b [file] [log] [blame]
<!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="ScrollPolicy,flashx.textLayout.container.ScrollPolicy,AUTO,OFF,ON,_mouseWheelListenerAttached,absoluteStart,alignmentBaseline,backgroundAlpha,backgroundColor,baselineShift,blockProgression,borderBottomColor,borderBottomPriority,borderBottomWidth,borderLeftColor,borderLeftPriority,borderLeftWidth,borderRightColor,borderRightPriority,borderRightWidth,borderTopColor,borderTopPriority,borderTopWidth,breakOpportunity,cellCount,cellPadding,cellSpacing,cffHinting,clearFloats,color,columnBreakAfter,columnBreakBefore,columnCount,columnCount,columnGap,columnGap,columnState,columnWidth,columnWidth,compositionHeight,compositionHeight,compositionWidth,compositionWidth,computedFormat,configuration,container,container,containerBreakAfter,containerBreakBefore,containerControllerInitialFormat,coreStyles,defaultConfiguration,digitCase,digitWidth,direction,dominantBaseline,editingMode,firstBaselineOffset,flowComposer,fontFamily,fontLookup,fontSize,fontStyle,fontWeight,format,frame,horizontalScrollPolicy,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,hostFormat,interactionManager,interactiveObjects,justificationRule,justificationStyle,kerning,leadingModel,ligatureLevel,lineBreak,lineHeight,lineThrough,linkActiveFormat,linkHoverFormat,linkNormalFormat,listAutoPadding,listMarkerFormat,listStylePosition,listStyleType,locale,marginBottom,marginLeft,marginRight,marginTop,maxCellHeight,minCellHeight,numLines,oldInteractiveObjects,paddingBottom,paddingLeft,paddingRight,paddingTop,paragraphEndIndent,paragraphSpaceAfter,paragraphSpaceBefore,paragraphStartIndent,preserveSelectionOnSetText,renderingMode,rootElement,rules,styleName,styles,swfContext,tabStops,tableColumnWidth,tableWidth,textAlign,textAlignLast,textAlpha,textDecoration,textFlow,textIndent,textJustify,textLength,textRotation,trackingLeft,trackingRight,typographicCase,userStyles,usesDiscretionaryHyphens,verticalAlign,verticalScrollPolicy,verticalScrollPolicy,verticalScrollPosition,verticalScrollPosition,whiteSpaceCollapse,wordSpacing"><title>flashx.textLayout.container.ScrollPolicy</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 = 'ScrollPolicy - 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>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?flashx/textLayout/container/ScrollPolicy.html&amp;flashx/textLayout/container/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">ScrollPolicy</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ScrollPolicy"); titleBar_setSubNav(true,false,false,false,false,false,false,false,false,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')">flashx.textLayout.container</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public final class ScrollPolicy</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ScrollPolicy <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 :&nbsp;</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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p>
The ScrollPolicy class is an enumeration class that defines values for setting the <code>horizontalScrollPolicy</code> and
<code>verticalScrollPolicy</code> properties of the ContainerController class, which defines a text flow
container.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="ContainerController.html#horizontalScrollPolicy" target="">ContainerController.horizontalScrollPolicy</a><br/><a href="ContainerController.html#verticalScrollPolicy" target="">ContainerController.verticalScrollPolicy</a></div><br/><hr></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>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#AUTO" class="signatureLink">AUTO</a> : String = auto<div class="summaryTableDescription">[static]
Specifies that scrolling is to occur if the content exceeds the container's dimension.</div></td><td class="summaryTableOwnerCol">ScrollPolicy</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#OFF" class="signatureLink">OFF</a> : String = off<div class="summaryTableDescription">[static]
Causes the runtime to not display overflow lines, which means that the user cannot navigate to them.</div></td><td class="summaryTableOwnerCol">ScrollPolicy</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#ON" class="signatureLink">ON</a> : String = on<div class="summaryTableDescription">[static]
Specifies that scrolling is available to access content that exceeds the container's dimension.</div></td><td class="summaryTableOwnerCol">ScrollPolicy</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="AUTO"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">AUTO</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const AUTO:String = auto</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Specifies that scrolling is to occur if the content exceeds the container's dimension. The runtime calculates
the number of lines that overflow the container and the user can navigate to them with cursor keys, by drag selecting,
or by rotating the mouse wheel. You can also cause scrolling to occur by setting the corresponding position value,
either <code>ContainerController.horizontalScrollPosition</code> or <code>ContainerController.verticalScrollPosition</code>. Also, the runtime can automatically
scroll the contents of the container during editing.
</p></div><a name="constantDetail"></a><a name="OFF"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">OFF</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const OFF:String = off</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Causes the runtime to not display overflow lines, which means that the user cannot navigate to them.
In this case, setting the corresponding <code>ContainerController.horizontalScrollPosition</code> and
<code>ContainerController.verticalScrollPosition</code> properties have no effect.
</p></div><a name="constantDetail"></a><a name="ON"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ON</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const ON:String = on</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Specifies that scrolling is available to access content that exceeds the container's dimension. The runtime calculates the
number of lines that overflow the container and allows the user to scroll them into view with the cursor keys, by drag selecting,
or by rotating the mouse wheel. You can also scroll by setting the corresponding position value, either
<code>ContainerController.horizontalScrollPosition</code> or <code>ContainerController.verticalScrollPosition</code>. Also, the runtime can automatically scroll the contents
of the container during editing.
</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 -->