| Package | feathers.controls |
| Class | public class ScrollText |
| Inheritance | ScrollText  Scroller FeathersControl starling.display.Sprite |
| Implements | INativeFocusOwner |
| Product Version : | Feathers 1.0.0 |
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 | ||
|---|---|---|---|
 | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| bottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port
when dragging up. | Scroller | |
| bottomPullViewDisplayMode : String
Indicates whether the bottom pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | 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 | |
| effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
| explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
| explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
| explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
| explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
| explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
| explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
| focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
| focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
| focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
| focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
| globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ScrollText
components. | ScrollText | ||
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
| horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
| horizontalPageIndex : int
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 | |
| isBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated. | 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
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | 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 | |
| isLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated. | Scroller | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isRightPullViewActive : Boolean
Indicates if the rightPullView has been activated. | Scroller | |
| isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
| isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
| isTopPullViewActive : Boolean
Indicates if the topPullView has been activated. | Scroller | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| leftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port
when dragging to the right. | Scroller | |
| leftPullViewDisplayMode : String
Indicates whether the left pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | Scroller | |
| maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | 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 | |
| moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
| nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
| nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
| pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
| previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
| resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
| rightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port
when dragging to the left. | Scroller | |
| rightPullViewDisplayMode : String
Indicates whether the right pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | Scroller | |
| showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| 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 | |
| text : String
The text to display. | ScrollText | ||
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
| topPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when
dragging down. | Scroller | |
| topPullViewDisplayMode : String
Indicates whether the top pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | 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
The index of the vertical page, if snapping is enabled. | Scroller | |
| verticalScrollBarFactory : Function
Creates the vertical scroll bar. | 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 | ||
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
| hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| initializeNow():void
If the component has not yet initialized, initializes immediately. | 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 | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
| resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
| resumeEffects():void
Indicates that effects should be re-activated after being suspended. | 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
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| 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 | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
| 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 ScrollInteractionMode.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 ScrollInteractionMode.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 | |||
| Dispatched when a pull view is activated. | Scroller | ||
| Style | 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 | ||
| customHorizontalScrollBarStyleName : String A style name to add to the container's horizontal scroll bar sub-component. | 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 | |
disabledFontStyles : TextFormat The font styles used to display the label's text when the label is disabled. | ScrollText | ||
disabledTextFormat : TextFormat Advanced font formatting used to draw the text when the component is disabled if disabledFontStyles cannot be used. | 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 If advanced flash.text.TextFormat styles are specified, determines if the component 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 | |
| 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 | |
fontStyles : TextFormat The font styles used to display the label's text. | 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 | |
| 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 | |
| horizontalScrollBarPosition : String Determines where the horizontal scroll bar will be positioned. | Scroller | |
| interactionMode : String Determines how the user may interact with the scroller. | Scroller | |
| mouseWheelScrollDuration : Number The duration, in seconds, of the animation when the mouse wheel initiates a scroll action. | Scroller | |
outerPadding : Number Quickly sets all outer padding properties to the same value. | ScrollText | ||
outerPaddingBottom : Number The minimum space, in pixels, between the view port's bottom edge and the bottom edge of the component. | ScrollText | ||
outerPaddingLeft : Number The minimum space, in pixels, between the view port's left edge and the left edge of the component. | ScrollText | ||
outerPaddingRight : Number The minimum space, in pixels, between the view port's right edge and the right edge of the component. | ScrollText | ||
outerPaddingTop : Number The minimum space, in pixels, between the view port's top edge and the top edge of the component. | ScrollText | ||
| padding : Number Quickly sets all padding properties to the same value. | Scroller | |
| paddingBottom : Number The minimum space, in pixels, between the container's bottom edge and the container's content. | Scroller | |
| paddingLeft : Number The minimum space, in pixels, between the container's left edge and the container's content. | Scroller | |
| paddingRight : Number The minimum space, in pixels, between the container's right edge and the container's content. | Scroller | |
| paddingTop : Number The minimum space, in pixels, between the container's top edge and the container's content. | Scroller | |
| pageThrowDuration : Number The duration, in seconds, of the animation when the scroller is thrown to a page. | Scroller | |
| 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 the nearest pixel on the physical screen. | Scroller | |
| snapToPages : Boolean Determines if scrolling will snap to the nearest page. | Scroller | |
styleSheet : StyleSheet The StyleSheet object to pass to the TextField. | ScrollText | ||
textFormat : TextFormat Advanced font formatting used to draw the text if fontStyles cannot be used. | 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 | |
| verticalScrollBarPosition : String Determines where the vertical scroll bar will be positioned. | Scroller | |
| globalStyleProvider | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic static var globalStyleProvider:IStyleProvider
The default IStyleProvider for all ScrollText
components.
The default value is null.
See also
| isHTML | property |
isHTML:BooleanDetermines 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):voidSee 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):voidSee also
| ScrollText | () | Constructor |
public function ScrollText()Constructor.
| triggered | Event |
starling.events.Eventstarling.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
| thickness | style |
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.
See also
| textFormat | style |
textFormat:TextFormat
Advanced font formatting used to draw the text if
fontStyles cannot be used.
If this property is not null, the
fontStyles property will be ignored.
Note: It is considered best practice to use the
fontStyles property and
starling.text.TextFormat for font formatting. The
textFormat property is available for advanced uses where
features of flash.text.TextField that are not exposed by
Starling's TextFormat need to be customized. In most
cases, these advanced features are not required.
In the following example, the text is formatted:
scrollText.textFormat = new TextFormat( "_sans", 16, 0x333333 );
The default value is null.
See also
| styleSheet | style |
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.
See also
| sharpness | style |
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.
See also
| outerPaddingLeft | style |
outerPaddingLeft:NumberThe minimum space, in pixels, between the view port's left edge and the left edge of the component.
Note: The paddingLeft property applies to padding inside
the view port, and may not be visible on all sides if the text may be
scroll. Use outerPaddingLeft if you want to always display
padding on the left side of the component. outerPaddingLeft
and paddingLeft may be used simultaneously to define
padding around the outer edges of the container and additional padding
around the text.
In the following example, the left outer padding is set to 20 pixels:
scrollText.outerPaddingLeft = 20;
The default value is 0.
See also
| outerPaddingBottom | style |
outerPaddingBottom:NumberThe minimum space, in pixels, between the view port's bottom edge and the bottom edge of the component.
Note: The paddingBottom property applies to padding inside
the view port, and may not be visible on all sides if the text may be
scroll. Use outerPaddingBottom if you want to always display
padding on the bottom edge of the component. outerPaddingBottom
and paddingBottom may be used simultaneously to define
padding around the outer edges of the container and additional padding
around the text.
In the following example, the bottom outer padding is set to 20 pixels:
panel.outerPaddingBottom = 20;
The default value is 0.
See also
| outerPaddingRight | style |
outerPaddingRight:NumberThe minimum space, in pixels, between the view port's right edge and the right edge of the component.
Note: The paddingRight property applies to padding inside
the view port, and may not be visible on all sides if the text may be
scroll. Use outerPaddingRight if you want to always display
padding on the right side of the component. outerPaddingRight
and paddingRight may be used simultaneously to define
padding around the outer edges of the container and additional padding
around the text.
In the following example, the right outer padding is set to 20 pixels:
panel.outerPaddingRight = 20;
The default value is 0.
See also
| outerPaddingTop | style |
outerPaddingTop:NumberThe minimum space, in pixels, between the view port's top edge and the top edge of the component.
Note: The paddingTop property applies to padding inside
the view port, and may not be visible on all sides if the text may be
scroll. Use outerPaddingTop if you want to always display
padding on the top side of the component. outerPaddingTop
and paddingTop may be used simultaneously to define
padding around the outer edges of the container and additional padding
around the text.
In the following example, the top padding is set to 20 pixels:
panel.outerPaddingTop = 20;
The default value is 0.
See also
| outerPadding | style |
outerPadding:Number
Quickly sets all outer padding properties to the same value. The
outerPadding getter always returns the value of
outerPaddingTop, but the other padding values may be
different.
In the following example, the outer padding is set to 20 pixels:
panel.outerPadding = 20;
The default value is 0.
See also
| gridFitType | style |
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.
See also
| fontStyles | style |
fontStyles:TextFormatThe font styles used to display the label's text.
In the following example, the font styles are customized:
label.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );
Note: The starling.text.TextFormat class defines a
number of common font styles, but ScrollText supports
a larger number of ways to be customized. Use the
textFormat property to set more advanced styles
on the text renderer. If the textFormat property is not
null, the fontStyles property will be
ignored.
The default value is null.
See also
| embedFonts | style |
embedFonts:Boolean
If advanced flash.text.TextFormat styles are specified,
determines if the component should use an embedded font or not. If
the specified font is not actually embedded, the text may not be
displayed at all.
If the font styles are passed in using
starling.text.TextFormat, the component will automatically
detect if a font is embedded or not, and the embedFonts
property will be ignored if it is set to false. Setting it
to true will force the component to always try to use
embedded fonts.
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.
See also
| displayAsPassword | style |
displayAsPassword:BooleanSpecifies 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.
See also
| disabledTextFormat | style |
disabledTextFormat:TextFormat
Advanced font formatting used to draw the text when the component is
disabled if disabledFontStyles cannot be used.
If this property is not null, the
disabledFontStyles property will be ignored.
Note: It is considered best practice to use the
fontStyles and disabledFontStyles
properties with starling.text.TextFormat for font
formatting. The textFormat property is available for
advanced uses where features of flash.text.TextField
that are not exposed by Starling's TextFormat need to be
customized. In most cases, these advanced features are not required.
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.
See also
| disabledFontStyles | style |
disabledFontStyles:TextFormatThe font styles used to display the label's text when the label is disabled.
If the textFormat property or the
disabledTextFormat property is not null,
the disabledFontStyles property will be ignored.
In the following example, the disabled font styles are customized:
label.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );
Note: The starling.text.TextFormat class defines a
number of common font styles, but ScrollText supports
a larger number of ways to be customized. Use the
disabledTextFormat property to set more advanced styles
on the text renderer. If the disabledTextFormat property
is not null, the disabledFontStyles
property will be ignored.
The default value is null.
See also
| condenseWhite | style |
condenseWhite:BooleanA 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.
See also
| cacheAsBitmap | style |
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 may affect performance.
In the following example, bitmap caching is disabled:
scrollText.cacheAsBitmap = false;
The default value is true.
See also
| borderColor | style |
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.
See also
| border | style |
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.
See also
| backgroundColor | style |
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.
See also
| background | style |
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.
See also
| antiAliasType | style |
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.
See also