Packagefeathers.controls
Classpublic class ScrollText
InheritanceScrollText Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite

Displays long passages of text in a scrollable container using the runtime's software-based flash.text.TextField as an overlay above Starling content on the classic display list. This component will always appear above Starling content. The only way to put something above ScrollText is to put something above it on the classic display list.

Meant as a workaround component for when TextFieldTextRenderer runs into the runtime texture limits.

Since this component is rendered with the runtime's software renderer, rather than on the GPU, it may not perform very well on mobile devices with high resolution screens.

The following example displays some text:

     var scrollText:ScrollText = new ScrollText();
     scrollText.text = "Hello World";
     this.addChild( scrollText );

See also

How to use the Feathers ScrollText component
flash.text.TextField


Public Properties
 PropertyDefined By
  antiAliasType : String
The type of anti-aliasing used for this text field, defined as constants in the flash.text.AntiAliasType class.
ScrollText
 InheritedautoHideBackground : Boolean
If true, the background's visible property will be set to false when the scroll position is greater than or equal to the minimum scroll position and less than or equal to the maximum scroll position.
Scroller
  background : Boolean
Specifies whether the text field has a background fill.
ScrollText
  backgroundColor : uint
The color of the text field background that is displayed if the background property is set to true.
ScrollText
 InheritedbackgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
 InheritedbackgroundSkin : DisplayObject
The default background to display.
Scroller
  border : Boolean
Specifies whether the text field has a border.
ScrollText
  borderColor : uint
The color of the text field border that is displayed if the border property is set to true.
ScrollText
  cacheAsBitmap : Boolean
If set to true, an internal bitmap representation of the TextField on the classic display list is cached by the runtime.
ScrollText
 InheritedclipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
  condenseWhite : Boolean
A boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed.
ScrollText
 InheritedcustomHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName.
Scroller
 InheritedcustomHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
 InheritedcustomVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName.
Scroller
 InheritedcustomVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 InheriteddecelerationRate : Number
This value is used to decelerate the scroller when "thrown".
Scroller
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
  disabledTextFormat : TextFormat
The font and styles used to draw the text when the component is disabled.
ScrollText
  displayAsPassword : Boolean
Specifies whether the text field is a password text field that hides the input characters using asterisks instead of the actual characters.
ScrollText
 Inheritedelasticity : Number
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier.
Scroller
 InheritedelasticSnapDuration : Number
The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.
Scroller
  embedFonts : Boolean
Determines if the TextField should use an embedded font or not.
ScrollText
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all ScrollText components.
ScrollText
  gridFitType : String
Determines whether Flash Player forces strong horizontal and vertical lines to fit to a pixel or subpixel grid, or not at all using the constants defined in the flash.text.GridFitType class.
ScrollText
 InheritedhasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 InheritedhideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable.
Scroller
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
[read-only] The index of the horizontal page, if snapping is enabled.
Scroller
 InheritedhorizontalScrollBarFactory : Function
Creates the horizontal scroll bar.
Scroller
 InheritedhorizontalScrollBarProperties : Object
An object that stores properties for the container's horizontal scroll bar, and the properties will be passed down to the horizontal scroll bar when the container validates.
Scroller
 InheritedhorizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the x-axis) or not.
Scroller
 InheritedhorizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on the x-axis).
Scroller
 InheritedhorizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted by a "step".
Scroller
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedinteractionMode : String
Determines how the user may interact with the scroller.
Scroller
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
FeathersControl
  isHTML : Boolean
Determines if the TextField should display the text as HTML or not.
ScrollText
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxHorizontalPageIndex : int
[read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the right.
Scroller
 InheritedmaxVerticalPageIndex : int
[read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.
Scroller
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmeasureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring the scroller.
Scroller
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHorizontalPageIndex : int
[read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the left.
Scroller
 InheritedminimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.
Scroller
 InheritedminimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.
Scroller
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminVerticalPageIndex : int
[read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.
Scroller
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
 Inheritedpadding : Number
Quickly sets all padding properties to the same value.
Scroller
  paddingBottom : Number
[override] The minimum space, in pixels, between the component's bottom edge and the bottom edge of the text.
ScrollText
  paddingLeft : Number
[override] The minimum space, in pixels, between the component's left edge and the left edge of the text.
ScrollText
  paddingRight : Number
[override] The minimum space, in pixels, between the component's right edge and the right edge of the text.
ScrollText
  paddingTop : Number
[override] The minimum space, in pixels, between the component's top edge and the top edge of the text.
ScrollText
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
 InheritedrevealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars()
Scroller
 InheritedscrollBarDisplayMode : String
Determines how the scroll bars are displayed.
Scroller
  sharpness : Number
The sharpness of the glyph edges in this text field.
ScrollText
 InheritedsnapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole pixels.
Scroller
 InheritedsnapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
  styleSheet : StyleSheet
The StyleSheet object to pass to the TextField.
ScrollText
  text : String
The text to display.
ScrollText
  textFormat : TextFormat
The font and styles used to draw the text.
ScrollText
  thickness : Number
The thickness of the glyph edges in this text field.
ScrollText
 InheritedthrowEase : Object
The easing function used for "throw" animations.
Scroller
 InheritedthrowElasticity : Number
If the scroll position goes outside the minimum or maximum bounds when the scroller's content is "thrown", the scrolling will be constrained using this multiplier.
Scroller
 InheriteduseFixedThrowDuration : Boolean
If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.
Scroller
 InheritedverticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel vertically.
Scroller
 InheritedverticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.
Scroller
 InheritedverticalPageCount : int
[read-only] The number of vertical pages, if snapping is enabled.
Scroller
 InheritedverticalPageIndex : int
[read-only] The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned.
Scroller
 InheritedverticalScrollBarProperties : Object
An object that stores properties for the container's vertical scroll bar, and the properties will be passed down to the vertical scroll bar when the container validates.
Scroller
 InheritedverticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the y-axis) or not.
Scroller
 InheritedverticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on the y-axis).
Scroller
 InheritedverticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step".
Scroller
 InheritedviewPort : IViewPort
The display object displayed and scrolled within the Scroller.
Scroller
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
 InheritedhasPendingHorizontalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhasPendingVerticalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarName : String
DEPRECATED: Replaced by horizontalScrollBarStyleName.
Scroller
 InheritedhorizontalScrollBarStyleName : String = feathers-scroller-horizontal-scroll-bar
The value added to the styleNameList of the horizontal scroll bar.
Scroller
 InheritedpendingHorizontalPageIndex : int
The pending horizontal page index to scroll to after validating.
Scroller
 InheritedpendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating.
Scroller
 InheritedpendingScrollDuration : Number
The duration of the pending scroll action.
Scroller
 InheritedpendingVerticalPageIndex : int
The pending vertical page index to scroll to after validating.
Scroller
 InheritedpendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating.
Scroller
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarName : String
DEPRECATED: Replaced by verticalScrollBarStyleName.
Scroller
 InheritedverticalScrollBarStyleName : String = feathers-scroller-vertical-scroll-bar
The value added to the styleNameList of the vertical scroll bar.
Scroller
Public Methods
 MethodDefined By
  
Constructor.
ScrollText
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
If the scroll bars are floating, briefly show them as a hint to the user.
Scroller
 Inherited
scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific page index.
Scroller
 Inherited
scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a specific location.
Scroller
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
FeathersControl
 Inherited
If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.
Scroller
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
Scroller
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.
Scroller
 Inherited
Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.
Scroller
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
Scrolls to a pending scroll position, if required.
Scroller
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
Positions and sizes children based on the actual width and height values.
Scroller
 Inherited
Choose the appropriate background skin based on the control's current state.
Scroller
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
 Inherited
If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.
Scroller
 Inherited
throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with optional animation.
Scroller
 Inherited
throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with optional animation.
Scroller
Events
 Event Summary Defined By
 InheritedDispatched when the user starts dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user starts interacting with the scroll bar.Scroller
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user stops dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user stops interacting with the scroll bar.Scroller
 InheritedDispatched when the component receives focus.Scroller
 InheritedDispatched when the component loses focus.Scroller
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.Scroller
 InheritedDispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.Scroller
 InheritedDispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.Scroller
  Dispatched when an anchor (<a>) element in the HTML text is triggered when the href attribute begins with "event:".ScrollText
Public Constants
 ConstantDefined By
  DECELERATION_RATE_FAST : Number = 0.99
[static] Decelerates a bit faster per millisecond than the default.
ScrollText
  DECELERATION_RATE_NORMAL : Number = 0.998
[static] The default deceleration rate per millisecond.
ScrollText
 InheritedDEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar
[static] DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR.
Scroller
 InheritedDEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar
[static] DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR.
Scroller
 InheritedDEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar
[static] The default value added to the styleNameList of the horizontal scroll bar.
Scroller
 InheritedDEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar
[static] The default value added to the styleNameList of the vertical scroll bar.
Scroller
  INTERACTION_MODE_MOUSE : String = mouse
[static] The user may only interact with the scroll bars to scroll.
ScrollText
  INTERACTION_MODE_TOUCH : String = touch
[static] The user may touch anywhere on the scroller and drag to scroll.
ScrollText
  INTERACTION_MODE_TOUCH_AND_SCROLL_BARS : String = touchAndScrollBars
[static] The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately.
ScrollText
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
  MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL : String = horizontal
[static] The scroller will scroll horizontally when the mouse wheel is scrolled.
ScrollText
  MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL : String = vertical
[static] The scroller will scroll vertically when the mouse wheel is scrolled.
ScrollText
  SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed
[static] The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.
ScrollText
  SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT : String = fixedFloat
[static] The scroll bars appear above the scroller's view port, overlapping the content, but they do not fade out when not in use.
ScrollText
  SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float
[static] The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.
ScrollText
  SCROLL_BAR_DISPLAY_MODE_NONE : String = none
[static] The scroll bars are never visible.
ScrollText
  SCROLL_POLICY_AUTO : String = auto
[static] The scroller may scroll if the view port is larger than the scroller's bounds.
ScrollText
  SCROLL_POLICY_OFF : String = off
[static] The scroller does not scroll at all.
ScrollText
  SCROLL_POLICY_ON : String = on
[static] The scroller will always scroll.
ScrollText
  VERTICAL_SCROLL_BAR_POSITION_LEFT : String = left
[static] The vertical scroll bar will be positioned on the left.
ScrollText
  VERTICAL_SCROLL_BAR_POSITION_RIGHT : String = right
[static] The vertical scroll bar will be positioned on the right.
ScrollText
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = clipping
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
antiAliasTypeproperty
antiAliasType:String

The type of anti-aliasing used for this text field, defined as constants in the flash.text.AntiAliasType class.

In the following example, the anti-alias type is changed:

         textRenderer.antiAliasType = AntiAliasType.NORMAL;

The default value is flash.text.AntiAliasType.ADVANCED.


Implementation
    public function get antiAliasType():String
    public function set antiAliasType(value:String):void

See also

backgroundproperty 
background:Boolean

Specifies whether the text field has a background fill. Use the backgroundColor property to set the background color of a text field.

In the following example, the background is enabled:

         scrollText.background = true;
         scrollText.backgroundColor = 0xff0000;

The default value is false.


Implementation
    public function get background():Boolean
    public function set background(value:Boolean):void

See also

backgroundColorproperty 
backgroundColor:uint

The color of the text field background that is displayed if the background property is set to true.

In the following example, the background color is changed:

         scrollText.background = true;
         scrollText.backgroundColor = 0xff000ff;

The default value is 0xffffff.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void

See also

borderproperty 
border:Boolean

Specifies whether the text field has a border. Use the borderColor property to set the border color.

In the following example, the border is enabled:

         scrollText.border = true;
         scrollText.borderColor = 0xff0000;

The default value is false.


Implementation
    public function get border():Boolean
    public function set border(value:Boolean):void

See also

borderColorproperty 
borderColor:uint

The color of the text field border that is displayed if the border property is set to true.

In the following example, the border color is changed:

         scrollText.border = true;
         scrollText.borderColor = 0xff00ff;

The default value is 0x000000.


Implementation
    public function get borderColor():uint
    public function set borderColor(value:uint):void

See also

cacheAsBitmapproperty 
cacheAsBitmap:Boolean

If set to true, an internal bitmap representation of the TextField on the classic display list is cached by the runtime. This caching can increase performance.

In the following example, bitmap caching is disabled:

         scrollText.cacheAsBitmap = false;

The default value is true.


Implementation
    public function get cacheAsBitmap():Boolean
    public function set cacheAsBitmap(value:Boolean):void

See also

condenseWhiteproperty 
condenseWhite:Boolean

A boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed.

In the following example, whitespace is condensed:

         scrollText.condenseWhite = true;

The default value is false.


Implementation
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void

See also

disabledTextFormatproperty 
disabledTextFormat:TextFormat

The font and styles used to draw the text when the component is disabled.

In the following example, the disabled text format is changed:

         textRenderer.isEnabled = false;
         textRenderer.disabledTextFormat = new TextFormat( "_sans", 16, 0xcccccc );

The default value is null.


Implementation
    public function get disabledTextFormat():TextFormat
    public function set disabledTextFormat(value:TextFormat):void

See also

displayAsPasswordproperty 
displayAsPassword:Boolean

Specifies whether the text field is a password text field that hides the input characters using asterisks instead of the actual characters.

In the following example, the text is displayed as a password:

         scrollText.displayAsPassword = true;

The default value is false.


Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void

See also

embedFontsproperty 
embedFonts:Boolean

Determines if the TextField should use an embedded font or not. If the specified font is not embedded, the text is not displayed.

In the following example, some text is formatted with an embedded font:

         scrollText.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333;
         scrollText.embedFonts = true;

The default value is false.


Implementation
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all ScrollText components.

The default value is null.

See also

gridFitTypeproperty 
gridFitType:String

Determines whether Flash Player forces strong horizontal and vertical lines to fit to a pixel or subpixel grid, or not at all using the constants defined in the flash.text.GridFitType class. This property applies only if the antiAliasType property of the text field is set to flash.text.AntiAliasType.ADVANCED.

In the following example, the grid fit type is changed:

         scrollText.gridFitType = GridFitType.SUBPIXEL;

The default value is flash.text.GridFitType.PIXEL.


Implementation
    public function get gridFitType():String
    public function set gridFitType(value:String):void

See also

isHTMLproperty 
isHTML:Boolean

Determines if the TextField should display the text as HTML or not.

In the following example, some HTML-formatted text is displayed:

         scrollText.isHTML = true;
         scrollText.text = "<b>Hello</b> <i>World</i>";

The default value is false.


Implementation
    public function get isHTML():Boolean
    public function set isHTML(value:Boolean):void

See also

paddingBottomproperty 
paddingBottom:Number[override]

The minimum space, in pixels, between the component's bottom edge and the bottom edge of the text.

In the following example, the bottom padding is set to 20 pixels:

         scrollText.paddingBottom = 20;


Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
paddingLeft:Number[override]

The minimum space, in pixels, between the component's left edge and the left edge of the text.

In the following example, the left padding is set to 20 pixels:

         scrollText.paddingLeft = 20;


Implementation
    public function get paddingLeft():Number
    public function set paddingLeft(value:Number):void
paddingRightproperty 
paddingRight:Number[override]

The minimum space, in pixels, between the component's right edge and the right edge of the text.

In the following example, the right padding is set to 20 pixels:

         scrollText.paddingRight = 20;


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
paddingTop:Number[override]

The minimum space, in pixels, between the component's top edge and the top edge of the text.

In the following example, the top padding is set to 20 pixels:

         scrollText.paddingTop = 20;

The default value is 0.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
sharpnessproperty 
sharpness:Number

The sharpness of the glyph edges in this text field. This property applies only if the antiAliasType property of the text field is set to flash.text.AntiAliasType.ADVANCED. The range for sharpness is a number from -400 to 400.

In the following example, the sharpness is changed:

         scrollText.sharpness = 200;

The default value is 0.


Implementation
    public function get sharpness():Number
    public function set sharpness(value:Number):void

See also

styleSheetproperty 
styleSheet:StyleSheet

The StyleSheet object to pass to the TextField.

In the following example, a style sheet is applied:

         var style:StyleSheet = new StyleSheet();
         var heading:Object = new Object();
         heading.fontWeight = "bold";
         heading.color = "#FF0000";
                  var body:Object = new Object();
         body.fontStyle = "italic";
                  style.setStyle(".heading", heading);
         style.setStyle("body", body);
                  scrollText.styleSheet = style;
         scrollText.isHTML = true;
         scrollText.text = "<body><span class='heading'>Hello</span> World...</body>";

The default value is null.


Implementation
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void

See also

textproperty 
text:String

The text to display. If isHTML is true, the text will be rendered as HTML with the same capabilities as the htmlText property of flash.text.TextField.

In the following example, some text is displayed:

         scrollText.text = "Hello World";

The default value is "".


Implementation
    public function get text():String
    public function set text(value:String):void

See also

textFormatproperty 
textFormat:TextFormat

The font and styles used to draw the text.

In the following example, the text is formatted:

         scrollText.textFormat = new TextFormat( "_sans", 16, 0x333333 );

The default value is null.


Implementation
    public function get textFormat():TextFormat
    public function set textFormat(value:TextFormat):void

See also

thicknessproperty 
thickness:Number

The thickness of the glyph edges in this text field. This property applies only if the antiAliasType property is set to flash.text.AntiAliasType.ADVANCED. The range for thickness is a number from -200 to 200.

In the following example, the thickness is changed:

         scrollText.thickness = 100;

The default value is 0.


Implementation
    public function get thickness():Number
    public function set thickness(value:Number):void

See also

Constructor Detail
ScrollText()Constructor
public function ScrollText()

Constructor.

Event Detail
triggered Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.TRIGGERED

Dispatched when an anchor (<a>) element in the HTML text is triggered when the href attribute begins with "event:". This event is dispatched when the internal flash.text.TextField dispatches its own TextEvent.LINK.

The data property of the Event object that is dispatched by the ScrollText contains the value of the text property of the TextEvent that is dispatched by the flash.text.TextField.

The following example listens for Event.TRIGGERED on a ScrollText component:

     var scrollText:ScrollText = new ScrollText();
     scrollText.text = "<a href=\"event:hello\">Hello</a> World";
     scrollText.addEventListener( Event.TRIGGERED, scrollText_triggeredHandler );
     this.addChild( scrollText );

The following example shows a listener for Event.TRIGGERED:

     function scrollText_triggeredHandler(event:Event):void
     {
         trace( event.data ); //hello
     }

See also

Constant Detail
DECELERATION_RATE_FASTConstant
public static const DECELERATION_RATE_FAST:Number = 0.99

Decelerates a bit faster per millisecond than the default.

See also

DECELERATION_RATE_NORMALConstant 
public static const DECELERATION_RATE_NORMAL:Number = 0.998

The default deceleration rate per millisecond.

See also

INTERACTION_MODE_MOUSEConstant 
public static const INTERACTION_MODE_MOUSE:String = mouse

The user may only interact with the scroll bars to scroll. The user cannot touch anywhere in the scroller's content and drag like a touch interface.

See also

INTERACTION_MODE_TOUCHConstant 
public static const INTERACTION_MODE_TOUCH:String = touch

The user may touch anywhere on the scroller and drag to scroll. The scroll bars will be visual indicator of position, but they will not be interactive.

See also

INTERACTION_MODE_TOUCH_AND_SCROLL_BARSConstant 
public static const INTERACTION_MODE_TOUCH_AND_SCROLL_BARS:String = touchAndScrollBars

The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately. For most touch interfaces, this is not a common behavior. The scroll bar on touch interfaces is often simply a visual indicator and non-interactive.

One case where this mode might be used is a "scroll bar" that displays a tappable alphabetical index to navigate a GroupedList with alphabetical categories.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL:String = horizontal

The scroller will scroll horizontally when the mouse wheel is scrolled.

See also

MOUSE_WHEEL_SCROLL_DIRECTION_VERTICALConstant 
public static const MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL:String = vertical

The scroller will scroll vertically when the mouse wheel is scrolled.

See also

SCROLL_BAR_DISPLAY_MODE_FIXEDConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixed

The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.

See also

SCROLL_BAR_DISPLAY_MODE_FIXED_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT:String = fixedFloat

The scroll bars appear above the scroller's view port, overlapping the content, but they do not fade out when not in use.

See also

SCROLL_BAR_DISPLAY_MODE_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = float

The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.

See also

SCROLL_BAR_DISPLAY_MODE_NONEConstant 
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none

The scroll bars are never visible.

See also

SCROLL_POLICY_AUTOConstant 
public static const SCROLL_POLICY_AUTO:String = auto

The scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.

See also

SCROLL_POLICY_OFFConstant 
public static const SCROLL_POLICY_OFF:String = off

The scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.

See also

SCROLL_POLICY_ONConstant 
public static const SCROLL_POLICY_ON:String = on

The scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.

See also

VERTICAL_SCROLL_BAR_POSITION_LEFTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_LEFT:String = left

The vertical scroll bar will be positioned on the left.

See also

VERTICAL_SCROLL_BAR_POSITION_RIGHTConstant 
public static const VERTICAL_SCROLL_BAR_POSITION_RIGHT:String = right

The vertical scroll bar will be positioned on the right.

See also