Packagemx.core
Classpublic class ScrollControlBase
InheritanceScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
SubclassesListBase, TextArea

The ScrollControlBase class is the base class for controls with scroll bars. The user interacts with the scroll bar or the developer accesses methods and properties that alter the viewable area. The ScrollControlBase takes a single child object and positions and masks or sizes that object to display the viewable content. All items to be scrolled must be children of that content object

MXML Syntaxexpanded Hide MXML Syntax

The <ScrollControlBase> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

  <mx:tagname
  Properties
  border="object of border skin style"
  horizontalScrollPolicy="off|on|auto"
  horizontalScrollPosition="0"
  liveScrolling="true|false"
  maxHorizontalScrollPosition="NaN"
  maxVerticalScrollPosition="NaN"
  scrollTipFunction="undefined"
  showScrollTips="false|true"
  verticalScrollPolicy="auto|off|on"
  verticalScrollPosition="0" 
  Styles
  backgroundAlpha="1.0"
  backgroundColor="undefined"
  backgroundImage="undefined"
  backgroundSize="auto"
  borderColor="0xAAB3B3"
  borderSides="left top right bottom"
  borderSkin="ClassReference('mx.skins.halo.HaloBorder')"
  borderStyle="inset"
  borderThickness="1"
  color="0x0B333C"
  cornerRadius="0"
  disabledColor="0xAAB3B3"
  dropShadowColor="0x000000"
  dropShadowEnabled="false"
  fontFamily="Verdana"
  fontSize="10"
  fontStyle="normal|italic"
  fontWeight="normal|bold"
  horizontalScrollBarStyleName=""
  leading="2"
  shadowDirection="center"
  shadowDistance="2"
  textAlign="value; see detail."
  textDecoration="none|underline"
  textIndent="0"
  verticalScrollBarStyleName=""
 
  Events
  scroll="No default"
  />
  


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
  borderMetrics : EdgeMetrics
[read-only] 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
 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
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 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
  horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
  horizontalScrollPosition : Number
The offset into the content from the left edge.
ScrollControlBase
 Inheritedid : String
ID of the component.
UIComponent
 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
  liveScrolling : 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
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
  maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
ScrollControlBase
  maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
ScrollControlBase
 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
 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
  scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
 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
  showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
 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
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 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
  verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
  verticalScrollPosition : Number
The offset into the content from the top edge.
ScrollControlBase
  viewMetrics : EdgeMetrics
[read-only] 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
 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
  border : IFlexDisplayObject
The border object.
ScrollControlBase
  horizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
  maskShape : Shape
The mask.
ScrollControlBase
  scrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 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
  verticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
Public Methods
 MethodDefined by
  
Constructor.
ScrollControlBase
 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
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
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
  
createBorder():void
Creates the border for this component.
ScrollControlBase
  
Creates objects that are children of this ScrollControlBase, which in this case are the border and mask.
ScrollControlBase
 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
  
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
  
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
  
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
  
scrollHandler(event:Event):void
Default event handler for the scroll event.
ScrollControlBase
  
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 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 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 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
   Dispatched when the content is scrolled.ScrollControlBase
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 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
  
backgroundAlpha
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. Valid values range from 0.0 to 1.0. For most controls, the default value is 1.0, but for ToolTip controls, the default value is 0.95 and for Alert controls, the default value is 0.9. The default value is 1.0.
ScrollControlBase
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

ScrollControlBase
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style.
ScrollControlBase
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

ScrollControlBase
  
backgroundSize
Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default for the Application container is 100%. The default value for all other containers is auto, which maintains the original size of the image.
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
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC.
ScrollControlBase
  
borderSides
Type: String   CSS Inheritance: no
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid".
ScrollControlBase
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin class of the component. The mx.skins.halo.HaloBorder class is the default value for all components that do not explicitly set their own default. The Panel container has a default value of mx.skins.halo.PanelSkin. To determine the default value for a component, see the default.css file. The default value is mx.skins.halo.HaloBorder.
ScrollControlBase
  
borderStyle
Type: String   CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none".
ScrollControlBase
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
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
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: no
The color contrast of the component.
UIComponent
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5.
ScrollControlBase
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.
ScrollControlBase
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.
ScrollControlBase
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

ScrollControlBase
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 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
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the font. Set to "normal" to disable the advanced anti-aliasing.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others.

The default value is "advanced".
ScrollControlBase
  
fontFamily
Type: String   CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana".
ScrollControlBase
  
fontGridFitType
Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "pixel".
ScrollControlBase
  
fontSharpness
Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
ScrollControlBase
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
ScrollControlBase
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".
ScrollControlBase
  
fontThickness
Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
ScrollControlBase
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
ScrollControlBase
 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
  
horizontalScrollBarStyleName
Type: String   CSS Inheritance: no
Style name for horizontal scrollbar. This allows more control over the appearance of the scrollbar. The default value is undefined.
ScrollControlBase
 Inherited
hue
Type: Number   CSS Inheritance: no
The color hue of the component.
UIComponent
  
kerning
Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.
ScrollControlBase
  
leading
Type: Number   Format: Length   CSS Inheritance: yes
Additional vertical space between lines of text.

The default value is 2.

The default value for the ComboBox control is 0.

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
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.
ScrollControlBase
 Inherited Type: Number   CSS Inheritance: no
The opacity of the component.
UIComponent
 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
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
ScrollControlBase
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.
ScrollControlBase
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

ScrollControlBase
  
textDecoration
Type: String   CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".
ScrollControlBase
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.
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   CSS Inheritance: no
Style name for vertical scrollbar. This allows more control over the appearance of the scrollbar. The default value is undefined.
ScrollControlBase
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
borderproperty
protected var border:IFlexDisplayObject

The border object.

borderMetricsproperty 
borderMetrics:EdgeMetrics  [read-only]

Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. The value of each property is equal to the thickness of one side of the border, expressed in pixels.

Implementation
    public function get borderMetrics():EdgeMetrics
horizontalScrollBarproperty 
protected var horizontalScrollBar:ScrollBar

The horizontal scroll bar. This property is null if no horizontal scroll bar is currently displayed. In general you do not access this property directly. Manipulation of the horizontalScrollPolicy and horizontalScrollPosition properties should provide sufficient control over the scroll bar.

horizontalScrollPolicyproperty 
horizontalScrollPolicy:String  [read-write]

A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method. Allowed values are ScrollPolicy.ON, ScrollPolicy.OFF, and ScrollPolicy.AUTO. MXML values can be "on", "off", and "auto".

Setting this property to ScrollPolicy.OFF for ListBase subclasses does not affect the horizontalScrollPosition property; you can still scroll the contents programmatically.

Note that the policy can affect the measured size of the component If the policy is ScrollPolicy.AUTO the scrollbar is not factored in the measured size. This is done to keep the layout from recalculating when the scrollbar appears. If you know that you will have enough data for scrollbars you should set the policy to ScrollPolicy.ON. If you don't know, you may need to set an explicit width or height on the component to allow for scrollbars to appear later.

The default value is ScrollPolicy.OFF.

This property can be used as the source for data binding.

Implementation
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void
horizontalScrollPositionproperty 
horizontalScrollPosition:Number  [read-write]

The offset into the content from the left edge. This can be a pixel offset in some subclasses or some other metric like the number of columns in a DataGrid or number of items in a HorizontalList or TileList.

The default value is 0.

This property can be used as the source for data binding.

Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
liveScrollingproperty 
public var liveScrolling: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. The default value is true.

maskShapeproperty 
protected var maskShape:Shape

The mask. This property may be undefined if no scroll bars are currently displayed or in some subclasses which have a different masking mechanism. A mask defined the viewable area of a displayable object. Thus this mask is used to hide the portions of the content that are not currently viewable. In general you do not access this property directly. Manipulation of the horizontalScrollPolicy, verticalScrollPolicy, horizontalScrollPosition, and verticalScrollPosition properties should provide sufficient control over the mask.

maxHorizontalScrollPositionproperty 
maxHorizontalScrollPosition:Number  [read-write]

The maximum value for the horizontalScrollPosition property. Note that this is not the width of the content because the maxHorizontalScrollPosition property contains the width of the content minus the width of the displayable area.

In most components, the value of the maxHorizontalScrollPosition property is computed from the data and size of component, and must not be set by the application code.

This property can be used as the source for data binding.

Implementation
    public function get maxHorizontalScrollPosition():Number
    public function set maxHorizontalScrollPosition(value:Number):void
maxVerticalScrollPositionproperty 
maxVerticalScrollPosition:Number  [read-write]

The maximum value for the verticalScrollPosition property. Note that this is not the height of the content because the maxVerticalScrollPosition property contains the height of the content minus the height of the displayable area.

The value of the maxVerticalScrollPosition property is computed from the data and size of component, and must not be set by the application code.

This property can be used as the source for data binding.

Implementation
    public function get maxVerticalScrollPosition():Number
    public function set maxVerticalScrollPosition(value:Number):void
scrollAreaChangedproperty 
protected var scrollAreaChanged:Boolean

A flag that the scrolling area changed due to the appearance or disappearance of scrollbars. Used by most layout methods to re-adjust the scrolling properties again.

scrollTipFunctionproperty 
scrollTipFunction:Function  [read-write]

A function that computes the string to be displayed as the ScrollTip. This function is called if the showScrollTips property is set to true and the scroll thumb is being dragged. The function should return a String that used as a ScrollTip. The function is passed two parameters. The first is the direction of the scroll bar. The second is its scrollPosition, as the following example shows:

      function scrollTipFunction(direction:String, position:Number):String 
      {
        if (direction == "vertical") return myToolTips[position];
        else return "";
      }

This property can be used as the source for data binding.

Implementation
    public function get scrollTipFunction():Function
    public function set scrollTipFunction(value:Function):void
showScrollTipsproperty 
public var showScrollTips:Boolean = false

A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged. The default value is false to disable the tooltip.

verticalScrollBarproperty 
protected var verticalScrollBar:ScrollBar

The vertical scroll bar. This property is null if no vertical scroll bar is currently displayed. In general you do not access this property directly. Manipulation of the verticalScrollPolicy and verticalScrollPosition properties should provide sufficient control over the scroll bar.

verticalScrollPolicyproperty 
verticalScrollPolicy:String  [read-write]

A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method. Allowed values are ScrollPolicy.ON, ScrollPolicy.OFF, and ScrollPolicy.AUTO. MXML values can be "on", "off", and "auto".

Setting this property to ScrollPolicy.OFF for ListBase subclasses does not affect the verticalScrollPosition property; you can still scroll the contents programmatically.

Note that the policy can affect the measured size of the component If the policy is ScrollPolicy.AUTO the scrollbar is not factored in the measured size. This is done to keep the layout from recalculating when the scrollbar appears. If you know that you will have enough data for scrollbars you should set the policy to ScrollPolicy.ON. If you don't know, you may need to set an explicit width or height on the component to allow for scrollbars to appear later.

The default value is ScrollPolicy.AUTO.

This property can be used as the source for data binding.

Implementation
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void
verticalScrollPositionproperty 
verticalScrollPosition:Number  [read-write]

The offset into the content from the top edge. This can be a pixel offset in some subclasses or some other metric like number of lines in a List or number of tiles in a TileList.

The default value is 0.

This property can be used as the source for data binding.

Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
viewMetricsproperty 
viewMetrics:EdgeMetrics  [read-only]

An EdgeMetrics object taking into account the scroll bars, if visible.

Implementation
    public function get viewMetrics():EdgeMetrics
Constructor detail
ScrollControlBase()constructor
public function ScrollControlBase()

Constructor.

Method detail
createBorder()method
protected function createBorder():void

Creates the border for this component. Normally the border is determined by the borderStyle and borderSkin styles. It must set the border property to the instance of the border.

createChildren()method 
protected override function createChildren():void

Creates objects that are children of this ScrollControlBase, which in this case are the border and mask. Flex calls this method when the ScrollControlBase is first created. If a subclass overrides this method, the subclass should call the super.createChildren() method so that the logic in the ScrollControlBase.createChildren() method is executed.

layoutChrome()method 
protected function layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void

Responds to size changes by setting the positions and sizes of this control's borders.

The ScrollControlBase.layoutChrome() method sets the position and size of the ScrollControlBase's border. In every subclass of ScrollControlBase, the subclass's layoutChrome() method should call the super.layoutChrome() method, so that the border is positioned properly.

Parameters
unscaledWidth:Number — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the scaleX property of the component.
 
unscaledHeight:Number — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the scaleY property of the component.
mouseWheelHandler()method 
protected function mouseWheelHandler(event:MouseEvent):void

Event handler for the mouse wheel scroll event.

Parameters
event:MouseEvent — The event object.
roomForScrollBar()method 
protected function roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean

Determines if there is enough space in this component to display a given scrollbar.

Parameters
bar:ScrollBar — The scrollbar
 
unscaledWidth:Number — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the scaleX property of the component.
 
unscaledHeight:Number — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the scaleY property of the component.

Returns
Boolean — Returns true if there is enough space for a scrollbar.
scrollHandler()method 
protected function scrollHandler(event:Event):void

Default event handler for the scroll event.

Parameters
event:Event — The event object.
setScrollBarProperties()method 
protected function setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void

Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in. If a TextArea can only show 100 pixels across and 5 lines of text, but the actual text to display is 200 pixels wide and 30 lines of text, then the setScrollBarProperties() method is called as setScrollBarProperties(200, 100, 30, 5).

Parameters
totalColumns:int — The number of horizontal units that need to be displayed.
 
visibleColumns:int — The number of horizontal units that can be displayed at one time.
 
totalRows:int — The number of vertical units that need to be displayed.
 
visibleRows:int — The number of vertical units that can be displayed at one time
Event detail
scrollevent 
Event object type: mx.events.ScrollEvent
ScrollEvent.type property = mx.events.ScrollEvent.SCROLL

Dispatched when the content is scrolled.

The ScrollEvent.SCROLL constant defines the value of the type property of the event object for a scroll event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the change in scroll position, expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left.
directionContains the scroll direction, either ScrollEventDirection.HORIZONTAL or ScrollEventDirection.VERTICAL.
positionContains the new scroll position.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.