ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.container 

ScrollPolicy  - AS3

Packageflashx.textLayout.container
Classpublic final class ScrollPolicy
InheritanceScrollPolicy Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The ScrollPolicy class is an enumeration class that defines values for setting the horizontalScrollPolicy and verticalScrollPolicy properties of the ContainerController class, which defines a text flow container.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  AUTO : String = "auto"
[static] Specifies that scrolling is to occur if the content exceeds the container's dimension.
ScrollPolicy
  OFF : String = "off"
[static] Causes the runtime to not display overflow lines, which means that the user cannot navigate to them.
ScrollPolicy
  ON : String = "on"
[static] Specifies that scrolling is available to access content that exceeds the container's dimension.
ScrollPolicy
Constant Detail

AUTO

Constant
public static const AUTO:String = "auto"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

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 ContainerController.horizontalScrollPosition or ContainerController.verticalScrollPosition. Also, the runtime can automatically scroll the contents of the container during editing.

OFF

Constant 
public static const OFF:String = "off"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Causes the runtime to not display overflow lines, which means that the user cannot navigate to them. In this case, setting the corresponding ContainerController.horizontalScrollPosition and ContainerController.verticalScrollPosition properties have no effect.

ON

Constant 
public static const ON:String = "on"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

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 ContainerController.horizontalScrollPosition or ContainerController.verticalScrollPosition. Also, the runtime can automatically scroll the contents of the container during editing.