mx.core.ScrollControlBase

Public Properties

	Property		Defined By
		accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.	UIComponent
		activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.	UIComponent
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise.	UIComponent
		automationName : String Name that can be used as an identifier for this object.	UIComponent
		automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes.	UIComponent
		automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes.	UIComponent
		automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.	UIComponent
		automationValue : Array [read-only] 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
		automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise.	UIComponent
		baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		baselinePosition : Number [read-only] 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
		bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object.	UIComponent
		cachePolicy : String Specifies the bitmap caching policy for this object.	UIComponent
		className : String [read-only] The name of this instance's class, such as "Button".	UIComponent
		contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system.	UIComponent
		contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system.	UIComponent
		currentState : String The current view state of the component.	UIComponent
		cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers.	UIComponent
		depth : Number Determines the order in which items inside of containers are rendered.	UIComponent
		descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.	UIComponent
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	UIComponent
		document : Object A reference to the document object associated with this UIComponent.	UIComponent
		doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events.	UIComponent
		enabled : Boolean Whether the component can accept user interaction.	UIComponent
		errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.	UIComponent
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus.	UIComponent
		hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix.	UIComponent
		height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates.	UIComponent
		horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	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
		id : String ID of the component.	UIComponent
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		inheritingStyles : Object The beginning of this component's chain of inheriting styles.	UIComponent
		initialized : 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
		instanceIndex : int [read-only] The index of a repeated component.	UIComponent
		instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document.	UIComponent
		is3D : Boolean [read-only] Contains true when the element is in 3D.	UIComponent
		isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object.	UIComponent
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.	UIComponent
		left : Object For components, this layout constraint property is a facade on top of the similarly-named style.	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
		maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box.	UIComponent
		maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		maxHorizontalScrollPosition : Number The maximum value for the horizontalScrollPosition property.	ScrollControlBase
		maxVerticalScrollPosition : Number The maximum value for the verticalScrollPosition property.	ScrollControlBase
		maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		minHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.	UIComponent
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		MXMLDescriptor : Array [read-only]	UIComponent
		MXMLProperties : Array [read-only]	UIComponent
		nestLevel : int Depth of this object in the containment hierarchy.	UIComponent
		nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles.	UIComponent
		numAutomationChildren : int [read-only] The number of automation children this container has.	UIComponent
		owner : DisplayObjectContainer The owner of this IVisualElement object.	UIComponent
		parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component.	UIComponent
		parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object [read-only] A reference to the parent document object for this UIComponent.	UIComponent
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	UIComponent
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	UIComponent
		postLayoutTransformOffsets : TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	UIComponent
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	UIComponent
		repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent.	UIComponent
		repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.	UIComponent
		repeaterIndices : 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
		repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent.	UIComponent
		right : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		rotation : Number [override]	UIComponent
		rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationZ : Number [override]	UIComponent
		scaleX : Number [override] Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number [override] Number that specifies the vertical scaling factor.	UIComponent
		scaleZ : Number [override] Number that specifies the scaling factor along the z axis.	UIComponent
		screen : Rectangle [read-only] 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
		showInAutomationHierarchy : 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
		states : Array The view states that are defined for this component.	UIComponent
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	UIComponent
		styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component.	UIComponent
		styleName : Object The class style used by this component.	UIComponent
		styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors.	UIComponent
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UIComponent
		tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.	UIComponent
		toolTip : String Text to display in the ToolTip.	UIComponent
		top : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	UIComponent
		transformX : Number Sets the x coordinate for the transform center of the component.	UIComponent
		transformY : Number Sets the y coordinate for the transform center of the component.	UIComponent
		transformZ : Number Sets the z coordinate for the transform center of the component.	UIComponent
		transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.	UIComponent
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UIComponent
		uid : String A unique identifier for the object.	UIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	UIComponent
		validationSubField : String Used by a validator to associate a subfield with this component.	UIComponent
		verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	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
		visible : Boolean [override] Whether or not the display object is visible.	UIComponent
		width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent
		z : Number [override]	UIComponent

	Property	Defined By
		border : IFlexDisplayObject The border object.	ScrollControlBase
		currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors.	UIComponent
		hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.	UIComponent
		horizontalScrollBar : ScrollBar The horizontal scroll bar.	ScrollControlBase
		maskShape : Shape The mask.	ScrollControlBase
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		scrollAreaChanged : Boolean A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.	ScrollControlBase
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number [read-only] 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ScrollControlBase() Constructor.	ScrollControlBase
		addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance.	UIComponent
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates.	UIComponent
		contentToLocal(point:Point):Point Converts a Point object from content to local coordinates.	UIComponent
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container.	UIComponent
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object.	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object.	UIComponent
		determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow.	UIComponent
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		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 Programmatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination.	UIComponent
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array	UIComponent
		generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*	UIComponent
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getAutomationChildren():Array Provides the automation object list .	UIComponent
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	UIComponent
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	UIComponent
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	UIComponent
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	UIComponent
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	UIComponent
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	UIComponent
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	UIComponent
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	UIComponent
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	UIComponent
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	UIComponent
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	UIComponent
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	UIComponent
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	UIComponent
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	UIComponent
		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
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen.	UIComponent
		globalToContent(point:Point):Point Converts a Point object from global to content coordinates.	UIComponent
		hasCSSState():Boolean Returns true if currentCSSState is not null.	UIComponent
		hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent.	UIComponent
		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
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	UIComponent
		invalidateLayering():void Called by a component's items to indicate that their depth property has changed.	UIComponent
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	UIComponent
		invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its measure() method gets called during a later screen update.	UIComponent
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	UIComponent
		matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState.	UIComponent
		matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type.	UIComponent
		measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which can 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
		measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	UIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		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
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance.	UIComponent
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().	UIComponent
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	UIComponent
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	UIComponent
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setMXMLDescriptor(value:Array):void	UIComponent
		setMXMLProperties(value:Array):void	UIComponent
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	UIComponent
		styleChanged(styleProp:String):void Detects changes to style properties.	UIComponent
		stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized.	UIComponent
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexSprite
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	UIComponent
		transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.	UIComponent
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method.	UIComponent
		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
		validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component.	UIComponent
		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

	Method	Defined By
		addMXMLChildren(comps:Array):void	UIComponent
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.	UIComponent
		attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect.	UIComponent
		canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped.	UIComponent
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createBorder():void Creates the border for this component.	ScrollControlBase
		createChildren():void [override] Creates objects that are children of this ScrollControlBase, which in this case are the border and mask.	ScrollControlBase
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		dispatchPropertyChangeEvent(prop:String, oldValue:, value:):void Helper method for dispatching a PropertyChangeEvent when a property is updated.	UIComponent
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		generateMXMLAttributes(data:Array):void	UIComponent
		generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void	UIComponent
		generateMXMLObject(document:Object, data:Array):Object	UIComponent
		initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.	UIComponent
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event.	UIComponent
		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
		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
		resourcesChanged():void 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
		setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction.	UIComponent
		stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component.	UIComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draws the object and/or sizes and positions its children.	UIComponent

Summary	Defined By
add	Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.	UIComponent
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
dragComplete	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
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
effectStop	Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.	UIComponent
enterState	Dispatched after the component has entered a view state.	UIComponent
exitState	Dispatched just before the component exits a view state.	UIComponent
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.	UIComponent
resize	Dispatched when the component is resized.	UIComponent
scroll	Dispatched when the content is scrolled.	ScrollControlBase
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
stateChangeComplete	Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.	UIComponent
stateChangeInterrupted	Dispatched when a component interrupts a transition to its current state in order to switch to a new state.	UIComponent
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
touchInteractionEnd	A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.	UIComponent
touchInteractionStart	A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.	UIComponent
touchInteractionStarting	A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.	UIComponent
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
accentColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. The default button skin uses this color to tint the background. Slider track highlighting uses this color. The default value is `#0099FF`.	ScrollControlBase
backgroundAlpha	Type: Number CSS Inheritance: no Theme: halo 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 Theme: halo 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 Theme: halo 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 Theme: halo Background image of a component. This can be an absolute or relative URL or class. You can set either the `backgroundColor` or the `backgroundImage`. 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 Theme: halo 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
baseline	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
borderAlpha	Type: Number CSS Inheritance: no Theme: spark Alpha of the border. The default value is `1`.	ScrollControlBase
borderColor	Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. The default value depends on the component class; if not overridden for the class, the default value is `0xB7BABC` for the Halo theme and `0x696969` for the Spark theme.	ScrollControlBase
borderSides	Type: String CSS Inheritance: no Theme: halo 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 default value in all components that do not explicitly set their own default for the Halo theme is `mx.skins.halo.HaloBorder` and for the Spark theme is `mx.skins.spark.BorderSkin`. The Panel container has a default value of `mx.skins.halo.PanelSkin` for the Halo theme and `mx.skins.spark.BorderSkin` for the Spark theme. To determine the default value for a component, see the default.css file.	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"`. The `"inset"` and `"outset"` values are only valid with the halo theme.	ScrollControlBase
borderThickness	Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. Only used when `borderStyle` is set to `"solid"`. The default value is `1`.	ScrollControlBase
borderVisible	Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. The default value is `true`.	ScrollControlBase
bottom	Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.	UIComponent
chromeColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component.	ScrollControlBase
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value for the Halo theme is `0x0B333C`. The default value for the Spark theme is `0x000000`.	ScrollControlBase
contentBackgroundAlpha	Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component.	ScrollControlBase
contentBackgroundColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. The default value is `0xFFFFFF`.	ScrollControlBase
cornerRadius	Type: Number Format: Length CSS Inheritance: no Theme: halo Radius of component corners. The default value is `0`.	ScrollControlBase
direction	Type: String CSS Inheritance: yes The directionality of the text displayed by the component. The allowed values are `"ltr"` for left-to-right text, as in Latin-style scripts, and `"rtl"` for right-to-left text, as in Arabic and Hebrew. FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order. Note: This style only applies when an MX component specifies UIFTETextField as its `textFieldClass`. The `direction` also affects the alignment of the text within the bounds of the TLFTextField. It does not, however, affect the the placement of the TLFTextField within the component. The default value is `"ltr"`.	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 Theme: halo Color of the drop shadow. The default value is `0x000000`.	ScrollControlBase
dropShadowEnabled	Type: Boolean CSS Inheritance: no Theme: halo 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
dropShadowVisible	Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. The default value is `false`. Note: For drop shadows to appear on containers, set `contentBackgroundColor` property. Otherwise, the shadow appears behind the container because the default background of a container is transparent.	ScrollControlBase
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
focusAlpha	Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value for the Halo theme is `0.4`. The default value for the Spark theme is `0.55`.	ScrollControlBase
focusBlendMode	Type: String CSS Inheritance: no Blend mode used by the focus rectangle.	UIComponent
focusColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus The default value is `0x70B2EE`.	ScrollControlBase
focusRoundedCorners	Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. This value is a space-separated String that can contain any combination of `"tl"`, `"tr"`, `"bl"` and `"br"`. For example, to specify that the right side corners should be rounded, but the left side corners should be square, use `"tr br"`. The `cornerRadius` style property specifies the radius of the rounded corners. The default value depends on the component class; if not overridden for the class, default value is `"tl tr bl br"`.	ScrollControlBase
focusSkin	Type: Class CSS Inheritance: no Skin used to draw the focus rectangle.	UIComponent
focusThickness	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"`. See also flash.text.TextField flash.text.AntiAliasType	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 font for the Halo theme is `"Verdana"`. The default font for the Spark theme is `"Arial"`.	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"`. See also flash.text.TextField flash.text.GridFitType	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`. See also flash.text.TextField	ScrollControlBase
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed 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`. See also flash.text.TextField	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
horizontalCenter	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
interactionMode	Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH	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
layoutDirection	Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection	UIComponent
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
left	Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.	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
locale	Type: String CSS Inheritance: yes The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts. Note: This style only applies when an MX component specifies UIFTETextField as its `textFieldClass`. The default value is `"en"`.	ScrollControlBase
right	Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.	UIComponent
shadowDirection	Type: String CSS Inheritance: no Theme: halo 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 Theme: halo 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
showErrorSkin	Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid.	UIComponent
showErrorTip	Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it.	UIComponent
symbolColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a ScrollBar button. The default value is `0x000000`.	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
textFieldClass	Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). The default value is `mx.core.UITextField`.	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
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component.	UIComponent
top	Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.	UIComponent
verticalCenter	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

Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
focusInEffect	Triggering Event: focusIn Played when the component gains keyboard focus.	UIComponent
focusOutEffect	Triggering Event: focusOut Played when the component loses keyboard focus.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

	Constant	Defined By
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property.	UIComponent

Property Detail

border

property

protected var border:IFlexDisplayObject

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

The border object.

borderMetrics

property

borderMetrics:EdgeMetrics [read-only]

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

horizontalScrollBar

property

protected var horizontalScrollBar:ScrollBar

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

horizontalScrollPolicy

property

horizontalScrollPolicy:String

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

horizontalScrollPosition

property

horizontalScrollPosition:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

liveScrolling

property

public var liveScrolling:Boolean = true

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

maskShape

property

protected var maskShape:Shape

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

maxHorizontalScrollPosition

property

maxHorizontalScrollPosition:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

maxVerticalScrollPosition

property

maxVerticalScrollPosition:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

scrollAreaChanged

property

protected var scrollAreaChanged:Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

scrollTipFunction

property

scrollTipFunction:Function

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

showScrollTips

property

public var showScrollTips:Boolean = false

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

verticalScrollBar

property

protected var verticalScrollBar:ScrollBar

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

verticalScrollPolicy

property

verticalScrollPolicy:String

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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.

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

verticalScrollPosition

property

verticalScrollPosition:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

viewMetrics

property

viewMetrics:EdgeMetrics [read-only]

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Implementation
public function get viewMetrics():EdgeMetrics

Constructor Detail

ScrollControlBase

()

Constructor

public function ScrollControlBase()

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Constructor.

Method Detail

createBorder

()

method

protected function createBorder():void

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

override protected function createChildren():void

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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

scroll

Event

Event Object Type: mx.events.ScrollEvent
ScrollEvent.type property = mx.events.ScrollEvent.SCROLL

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`delta`	Contains 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.
`direction`	Contains the scroll direction, either `ScrollEventDirection.HORIZONTAL` or `ScrollEventDirection.VERTICAL`.
`position`	Contains the new scroll position.
`target`	The 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.

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ScrollControlBase	Properties \| Methods \| Events \| Styles \| Effects \| Constants

Package	mx.core
Class	public class ScrollControlBase
Inheritance	ScrollControlBase UIComponent FlexSprite flash.display.Sprite
Subclasses	AdvancedListBase, HTML, ListBase, TextArea