Package | feathers.controls |
Class | public class ScrollText |
Inheritance | ScrollText ![]() ![]() ![]() |
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
Property | Defined By | ||
---|---|---|---|
antiAliasType : String
The type of anti-aliasing used for this text field, defined as
constants in the flash.text.AntiAliasType class. | ScrollText | ||
![]() | autoHideBackground : 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 | ||
![]() | backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled. | Scroller | |
![]() | backgroundSkin : 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 | ||
![]() | clipContent : 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 | ||
![]() | customHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName. | Scroller | |
![]() | customHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar
sub-component. | Scroller | |
![]() | customVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName. | Scroller | |
![]() | customVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar
sub-component. | Scroller | |
![]() | decelerationRate : Number
This value is used to decelerate the scroller when "thrown". | Scroller | |
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : 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 | ||
![]() | elasticity : 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 | |
![]() | elasticSnapDuration : 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 | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : 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 | ||
![]() | hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport. | Scroller | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades
out. | Scroller | |
![]() | hideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable. | Scroller | |
![]() | horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
![]() | horizontalPageIndex : int [read-only]
The index of the horizontal page, if snapping is enabled. | Scroller | |
![]() | horizontalScrollBarFactory : Function
Creates the horizontal scroll bar. | Scroller | |
![]() | horizontalScrollBarProperties : 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 | |
![]() | horizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the
x-axis) or not. | Scroller | |
![]() | horizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on
the x-axis). | Scroller | |
![]() | horizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted
by a "step". | Scroller | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | interactionMode : String
Determines how the user may interact with the scroller. | Scroller | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
isHTML : Boolean
Determines if the TextField should display the text as HTML or not. | ScrollText | ||
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxHorizontalPageIndex : int [read-only]
The maximum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
right. | Scroller | |
![]() | maxVerticalPageIndex : int [read-only]
The maximum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the bottom edge. | Scroller | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | measureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring
the scroller. | Scroller | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHorizontalPageIndex : int [read-only]
The minimum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
left. | Scroller | |
![]() | minimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move
before the scroller starts scrolling. | Scroller | |
![]() | minimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch
must move before the scroller will "throw" to the next page. | Scroller | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minVerticalPageIndex : int [read-only]
The minimum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the top edge. | Scroller | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | mouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel
initiates a scroll action. | Scroller | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | padding : 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 | ||
![]() | pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
![]() | pageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is
thrown to a page. | Scroller | |
![]() | pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | revealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when
calling revealScrollBars()
| Scroller | |
![]() | scrollBarDisplayMode : String
Determines how the scroll bars are displayed. | Scroller | |
sharpness : Number
The sharpness of the glyph edges in this text field. | ScrollText | ||
![]() | snapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole
pixels. | Scroller | |
![]() | snapToPages : Boolean
Determines if scrolling will snap to the nearest page. | Scroller | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : 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 | ||
![]() | throwEase : Object
The easing function used for "throw" animations. | Scroller | |
![]() | throwElasticity : 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 | |
![]() | useFixedThrowDuration : Boolean
If true, the duration of a "throw" animation will be the
same no matter the value of the throw's initial velocity. | Scroller | |
![]() | verticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel
vertically. | Scroller | |
![]() | verticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by
a "step" when using the mouse wheel. | Scroller | |
![]() | verticalPageCount : int [read-only]
The number of vertical pages, if snapping is enabled. | Scroller | |
![]() | verticalPageIndex : int [read-only]
The index of the vertical page, if snapping is enabled. | Scroller | |
![]() | verticalScrollBarFactory : Function
Creates the vertical scroll bar. | Scroller | |
![]() | verticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned. | Scroller | |
![]() | verticalScrollBarProperties : 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 | |
![]() | verticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the
y-axis) or not. | Scroller | |
![]() | verticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on
the y-axis). | Scroller | |
![]() | verticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted
by a "step". | Scroller | |
![]() | viewPort : IViewPort
The display object displayed and scrolled within the Scroller. | Scroller | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | ScrollText | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | revealScrollBars():void
If the scroll bars are floating, briefly show them as a hint to the
user. | Scroller | |
![]() | scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific
page index. | Scroller | |
![]() | scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a
specific location. | Scroller | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | stopScrolling():void
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 | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when the user starts dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user starts interacting with the scroll bar. | Scroller | ||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched when the user stops dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user stops interacting with the scroll bar. | Scroller | ||
![]() | Dispatched when the component receives focus. | Scroller | ||
![]() | Dispatched when the component loses focus. | Scroller | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed. | Scroller | ||
![]() | Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation. | Scroller | ||
![]() | Dispatched 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 |
Constant | Defined 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 | ||
![]() | DEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR. | Scroller | |
![]() | DEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR. | Scroller | |
![]() | DEFAULT_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 | |
![]() | DEFAULT_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 | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_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 |
antiAliasType | property |
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
.
public function get antiAliasType():String
public function set antiAliasType(value:String):void
See also
background | property |
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
.
public function get background():Boolean
public function set background(value:Boolean):void
See also
backgroundColor | property |
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
.
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
See also
border | property |
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
.
public function get border():Boolean
public function set border(value:Boolean):void
See also
borderColor | property |
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
.
public function get borderColor():uint
public function set borderColor(value:uint):void
See also
cacheAsBitmap | property |
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
.
public function get cacheAsBitmap():Boolean
public function set cacheAsBitmap(value:Boolean):void
See also
condenseWhite | property |
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
.
public function get condenseWhite():Boolean
public function set condenseWhite(value:Boolean):void
See also
disabledTextFormat | property |
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
.
public function get disabledTextFormat():TextFormat
public function set disabledTextFormat(value:TextFormat):void
See also
displayAsPassword | property |
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
.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
See also
embedFonts | property |
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
.
public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all ScrollText
components.
The default value is null
.
See also
gridFitType | property |
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
.
public function get gridFitType():String
public function set gridFitType(value:String):void
See also
isHTML | property |
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
.
public function get isHTML():Boolean
public function set isHTML(value:Boolean):void
See also
paddingBottom | property |
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;
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
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;
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
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;
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
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
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
sharpness | property |
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
.
public function get sharpness():Number
public function set sharpness(value:Number):void
See also
styleSheet | property |
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
.
public function get styleSheet():StyleSheet
public function set styleSheet(value:StyleSheet):void
See also
text | property |
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 ""
.
public function get text():String
public function set text(value:String):void
See also
textFormat | property |
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
.
public function get textFormat():TextFormat
public function set textFormat(value:TextFormat):void
See also
thickness | property |
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
.
public function get thickness():Number
public function set thickness(value:Number):void
See also
ScrollText | () | Constructor |
public function ScrollText()
Constructor.
triggered | Event |
starling.events.Event
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
DECELERATION_RATE_FAST | Constant |
public static const DECELERATION_RATE_FAST:Number = 0.99
Decelerates a bit faster per millisecond than the default.
See also
DECELERATION_RATE_NORMAL | Constant |
public static const DECELERATION_RATE_NORMAL:Number = 0.998
The default deceleration rate per millisecond.
See also
INTERACTION_MODE_MOUSE | Constant |
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_TOUCH | Constant |
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_BARS | Constant |
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_HORIZONTAL | Constant |
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_VERTICAL | Constant |
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_FIXED | Constant |
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_FLOAT | Constant |
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_FLOAT | Constant |
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_NONE | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none
The scroll bars are never visible.
See also
SCROLL_POLICY_AUTO | Constant |
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_OFF | Constant |
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_ON | Constant |
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_LEFT | Constant |
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_RIGHT | Constant |
public static const VERTICAL_SCROLL_BAR_POSITION_RIGHT:String = right
The vertical scroll bar will be positioned on the right.
See also