Packagecom.dwuser.ss4.ui
Classpublic class DynamicScrollableText
InheritanceDynamicScrollableText Inheritance TextArea Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite

The DynamicScrollableText element displays scrollable text which dynamically changes based on the currently selected gallery and image. If the text doesn't fit in the available/allowed area, a scrollbar automatically appears.

The DynamicScrollableText element is identical to the DynamicText element except that, if the text doesn't fit in the available area, the extra text can be scrolled into view on this element whereas it is hidden on the other element.

Two of the special features of the DynamicScrollableText element are its built-in fade transition and auto-hiding support. The built-in fade transition makes for a much more polished transition between different text values. The auto-hiding support allows for the element to automatically hide itself when the parsed dynamic text results in an empty string. You can also listen for the textUpdate event to detect when updates occur which result in auto-hiding. The Caption element uses this feature to hide itself when no caption/description is specified for an image.

The most important property on this element is the text property, which controls the text displayed. The maxHeight property is also important if you don't explicitly specify a height value. If you don't specify a height value, the element will automatically expand until all of the text is visible or the maxHeight value is reached, at which time the scrollbar appears. Note - you can use the htmlText property instead of text if you wish to display HTML text.

By default, the scrolling on the DynamicScrollableText element can be triggered with the keyboard shortcut of '<' (up) or '>' (down). Keyboard shortcuts can be disabled through the useKeyboardShortcuts property on the FlashSlideshowConfigurationParameters object.

Another special property of the DynamicScrollableText element is its support of replacement values in the label and link. These are values which dynamically change based on the current gallery and image.

About Replacement Values:

Replacement values are special string values which are automatically replaced based on the current gallery and image's information. The following gallery-related replacement values are available:

The following image-related replacement values are available:

Note that you can use multiple replacement values in the same string.

Layout XML Syntax Example:

The DynamicScrollableText class inherits all of the tag attributes of its superclass.

   <DynamicScrollableText
      Properties
      text="The displayed text"
  
      Styles
      fadeTime="1500"
      hideWhenEmpty="true"
      verticalScrollBarStyleName="DynamicTextScrollBar"
  
      Events
      textUpdate="No default"
   />
   

Element Pictorial Example:

See also

com.dwuser.ss4.core.FlashSlideshowConfigurationParameters
DynamicLinkButton
DynamicText
FlashSlideshow


Public Properties
 PropertyDefined by
 InheritedactiveEffects : Array
The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationTabularData : Object
An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedbaselinePosition : Number
The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 InheritedcacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
The name of this instance's class, such as "Button".
UIComponent
 InheritedcondenseWhite : Boolean
Specifies whether extra white space (spaces, line breaks, and so on) should be removed in a TextArea control with HTML text.
TextArea
 InheritedcontentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcurrentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
Lets you pass a value to the component when you use it in an item renderer or item editor.
TextArea
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddisplayAsPassword : Boolean
Indicates whether this control is used for entering passwords.
TextArea
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 Inheritededitable : Boolean
Indicates whether the user is allowed to edit the text in this control.
TextArea
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedglobalX : Number
UIComponent
 InheritedglobalY : Number
UIComponent
 Inheritedheight : Number
Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always on (ScrollPolicy.ON), always off (ScrollPolicy.OFF), or turns on when needed (ScrollPolicy.AUTO).
TextArea
 InheritedhorizontalScrollPosition : Number
Pixel position in the content area of the leftmost pixel that is currently displayed.
TextArea
 InheritedhtmlText : String
Specifies the text displayed by the TextArea control, including HTML markup that expresses the styles of that text.
TextArea
 Inheritedid : String
ID of the component.
UIComponent
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
TextArea
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : Boolean
Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 Inheritedlength : int
The number of characters of text displayed in the TextArea.
TextArea
 InheritedlistData : BaseListData
When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the appropriate data from the list control.
TextArea
 InheritedliveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released.
ScrollControlBase
 InheritedmaxChars : int
Maximum number of characters that users can enter in the text field.
TextArea
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmiscHolder : Object
A utility holder for any various properties
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 Inheritedmove_enableProtection : Boolean = false
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
The number of automation children this container has.
UIComponent
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
 Inheritedparent : DisplayObjectContainer
The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedrepeater : IRepeater
A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedrestrict : String
Indicates the set of characters that a user can enter into the control.
TextArea
 InheritedscaleX : Number
Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
Number that specifies the vertical scaling factor.
UIComponent
 Inheritedscreen : Rectangle
Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
 Inheritedselectable : Boolean
Specifies whether the text can be selected.
TextArea
 InheritedselectionBeginIndex : int
The zero-based character index value of the first character in the current selection.
TextArea
 InheritedselectionEndIndex : int
The zero-based index of the position afterthe last character in the current selection (equivalent to the one-based index of the last character).
TextArea
 InheritedsetActualSize_enableProtection : Boolean = false
UIComponent
 InheritedsetVisible_enableProtection : Boolean = true
UIComponent
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 InheritedshowScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
  slideshow : FlashSlideshow
A reference to the main slideshow
DynamicScrollableText
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the styleName property) override inline styles.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleSheet : StyleSheet
A flash.text.StyleSheet object that can perform rendering on the TextArea control's text.
TextArea
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 Inheritedtext : String
Plain text that appears in the control.
TextArea
 InheritedtextHeight : Number
The height of the text.
TextArea
 InheritedtextWidth : Number
The width of the text.
TextArea
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalScrollPolicy : String
Whether the vertical scroll bar is always on (ScrollPolicy.ON), always off (ScrollPolicy.OFF), or turns on when needed (ScrollPolicy.AUTO).
TextArea
 InheritedverticalScrollPosition : Number
Line number of the top row of characters that is currently displayed.
TextArea
 InheritedviewMetrics : EdgeMetrics
An EdgeMetrics object taking into account the scroll bars, if visible.
ScrollControlBase
 Inheritedvisible : Boolean
Controls the visibility of this UIComponent.
UIComponent
 Inheritedvisible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
UIComponent
 Inheritedwidth : Number
Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedwordWrap : Boolean
Indicates whether the text automatically wraps at the end of a line.
TextArea
 Inheritedx : Number
Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 InheritedxmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
UIComponent
 Inheritedy : Number
Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
Protected Properties
 PropertyDefined by
 Inheritedborder : IFlexDisplayObject
The border object.
ScrollControlBase
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedscrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 InheritedtextField : IUITextField
The internal UITextField that renders the text of this TextArea.
TextArea
 InheritedunscaledHeight : Number
A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
 InheritedverticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
Public Methods
 MethodDefined by
  
DynamicScrollableText
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
UIComponent
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
UIComponent
 Inherited
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
getLineMetrics(lineIndex:int):TextLineMetrics
Returns a TextLineMetrics object with information about the text position and measurements for a line of text in the control.
TextArea
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setSelection(beginIndex:int, endIndex:int):void
Selects the text in the range specified by the parameters.
TextArea
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
UIComponent
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined by
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
createBorder():void
Creates the border for this component.
ScrollControlBase
  
DynamicScrollableText
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of this control's borders.
ScrollControlBase
 Inherited
measure():void
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
mouseWheelHandler(event:MouseEvent):void
Event handler for the mouse wheel scroll event.
ScrollControlBase
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
 Inherited
scrollHandler(event:Event):void
Default event handler for the scroll event.
ScrollControlBase
 Inherited
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in.
ScrollControlBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 EventSummaryDefined by
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIComponent
 Inherited Dispatched when text in the TextArea control changes through user input.TextArea
 Inherited Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited Dispatched after the view state has changed.UIComponent
 Inherited Dispatched after the currentState property changes, but before the view state changes.UIComponent
 Inherited Dispatched when the data property changes.TextArea
 Inherited Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 Inherited Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited Dispatched after an effect ends.UIComponent
 Inherited Dispatched just before an effect starts.UIComponent
 Inherited Dispatched after the component has returned to the root view state.UIComponent
 Inherited Dispatched before the component exits from the root view state.UIComponent
 Inherited Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 Inherited Dispatched when a user clicks a hyperlink in text defined by the htmlText property, where the URL begins with "event:".TextArea
 Inherited Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited Dispatched when the object has moved.UIComponent
 Inherited Dispatched at the beginning of the component initialization sequence.UIComponent
 Inherited Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIComponent
 Inherited Dispatched when the component is resized.UIComponent
 Inherited Dispatched when the content is scrolled.ScrollControlBase
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited Dispatched when the user types, deletes, or pastes text into the control.TextArea
   Dispatched when the text is changed dynamically.DynamicScrollableText
 Inherited Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 StyleDescriptionDefined by
 Inherited Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Background color of a component.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled.
ScrollControlBase
 Inherited Type: Object   Format: File   CSS Inheritance: no
Background image of a component.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Color of the border.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Bounding box sides.
ScrollControlBase
 Inherited Type: Class   CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
Bounding box style.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color brightness of the component.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: no
The color contrast of the component.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component if it is disabled.
TextArea
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow.
ScrollControlBase
 Inherited Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
  
fadeTime
Type: Number   Format: Time   CSS Inheritance: no
Specifies the duration, in milliseconds, of the fade transition between old and new text values when a text update occurs. To effectively disable the fade, set this parameter to a very small value, such as 1. The default value is 1500.
DynamicScrollableText
 Inherited Type: Number   CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
TextArea
 Inherited Type: String   CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
TextArea
 Inherited Type: Class   CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 Inherited Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
  
hideWhenEmpty
Type: Boolean   CSS Inheritance: no
Specifies whether the DynamicScrollableText element should automatically hide itself when the dynamic text evaluates to an empty string. The default value is true.
DynamicScrollableText
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
 Inherited
hue
Type: Number   CSS Inheritance: no
The color hue of the component.
UIComponent
 Inherited Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
 Inherited Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: no
The opacity of the component.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's bottom border and the bottom edge of its content area.
TextArea
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
TextArea
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
TextArea
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's top border and the top edge of its content area.
TextArea
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color saturation of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Direction of the drop shadow.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Theme color of a component.
UIComponent
 Inherited
top
Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
verticalScrollBarStyleName
Type: String   Format: StyleName   CSS Inheritance: no
Specifies the style name (style class declaration) to use for the vertical scrollbar which is displayed on the element.

The custom default value used here is DynamicTextScrollBar. This can be used to declare custom scrollbar styles in a custom node in the <styles> section of your XML configuration file. For example, you could specify a custom skin to use. To learn more about the supported values, see the mx.controls.VScrollBar class reference.

The default value is "DynamicTextScrollBar".
DynamicScrollableText
Effects
 EffectDescriptionDefined by
 Inherited Triggering event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering event: move
Played when the component is moved.
UIComponent
 Inherited Triggering event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined by
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property detail
slideshowproperty
public var slideshow:FlashSlideshow

A reference to the main slideshow

Constructor detail
DynamicScrollableText()constructor
public function DynamicScrollableText()
Method detail
createChildren()method
protected override function createChildren():void
Event detail
textUpdateevent 
Event object type: flash.events.Event

Dispatched when the text is changed dynamically.

Handlers for this event can read the text or htmlText properties to determine what the new dynamic text value is.