spark.components.supportClasses.ListBase

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
		arrowKeysWrapFocus : Boolean If true, using arrow keys to navigate within the component wraps when it hits either end.	ListBase
		autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed.	SkinnableDataContainer
		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 [override] [read-only] The y-coordinate of the baseline of the first line of text of the component.	SkinnableComponent
		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
		caretIndex : Number [read-only] Item that is currently in focus.	ListBase
		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
		dataProvider : IList The data provider for this DataGroup.	SkinnableDataContainer
		defaultButton : IFlexDisplayObject The Button control designated as the default button for the container.	SkinnableContainerBase
		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
		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
		isFirstRow : Boolean [read-only] Returns if the selectedIndex is equal to the first row.	ListBase
		isLastRow : Boolean [read-only] Returns if the selectedIndex is equal to the last row.	ListBase
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		itemRenderer : IFactory The item renderer to use for data items.	SkinnableDataContainer
		itemRendererFunction : Function Function that returns an item renderer IFactory for a specific item.	SkinnableDataContainer
		labelField : String The name of the field in the data provider items to display as the label.	ListBase
		labelFunction : Function A user-supplied function to run on each item to determine its label.	ListBase
		layout : LayoutBase The layout object for this container.	SkinnableDataContainer
		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
		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
		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
		preventSelection : Boolean If true items will be prevented from being selected.	ListBase
		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
		requireSelection : Boolean If true, a data item must always be selected in the control.	ListBase
		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
		selectedIndex : int The 0-based index of the selected item, or -1 if no item is selected.	ListBase
		selectedItem : * The item that is currently selected.	ListBase
		showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy.	UIComponent
		skin : UIComponent [read-only] The instance of the skin class for this component instance.	SkinnableComponent
		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
		suggestedFocusSkinExclusions : Array [read-only] Lists the skin parts that are excluded from bitmaps captured and used to show focus.	SkinnableComponent
		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
		typicalItem : Object Layouts use the preferred size of the typicalItem when fixed row or column sizes are required, but a specific rowHeight or columnWidth value is not set.	SkinnableDataContainer
		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
		useVirtualLayout : Boolean Sets the value of the useVirtualLayout property of the layout associated with this control.	ListBase
		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
		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
		currentCSSState : String [override] [read-only] The state to be used when matching CSS pseudo-selectors.	SkinnableComponent
		hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.	UIComponent
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ListBase() Constructor.	ListBase
		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
		findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int This will search through a dataprovider checking the given field and for the given value and return the index for the match.	ListBase
		findRowIndices(field:String, values:Array, patternType:String):Array This will search through a dataprovider checking the given field and for the given values and return an array of indices that matched.	ListBase
		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
		invalidateSkinState():void Marks the component so that the new state of the skin is set during a later screen update.	SkinnableComponent
		itemToLabel(item:Object):String [override] Given a data item, return the correct text a renderer should display while taking the labelField and labelFunction properties into account.	ListBase
		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
		moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value.	ListBase
		moveIndexFirstRow():void Changes the selectedIndex to the first row of the dataProvider.	ListBase
		moveIndexLastRow():void Changes the selectedIndex to the last row of the dataProvider.	ListBase
		moveIndexNextRow():void Changes the selectedIndex to the next row of the dataProvider.	ListBase
		moveIndexPreviousRow():void Changes the selectedIndex to the previous row of the dataProvider.	ListBase
		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
		setSelectedIndex(rowIndex:int, dispatchChangeEvent:Boolean = false, changeCaret:Boolean = true):void The rowIndex is the index in the data provider of the item containing the selected cell.	ListBase
		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
		updateRenderer(renderer:IVisualElement, itemIndex:int, data:Object):void Updates an item renderer for use or reuse.	SkinnableDataContainer
		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
		adjustSelection(newIndex:int, add:Boolean = false):void Adjusts the selected index to account for items being added to or removed from this component.	ListBase
		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
		attachSkin():void Create the skin for the component.	SkinnableComponent
		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
		clearSkinParts():void Clear out references to skin parts.	SkinnableComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createChildren():void Create child objects of the component.	UIComponent
		createDynamicPartInstance(partName:String):Object Create an instance of a dynamic skin part.	SkinnableComponent
		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
		detachSkin():void Destroys and removes the skin for this component.	SkinnableComponent
		dispatchPropertyChangeEvent(prop:String, oldValue:, value:):void Helper method for dispatching a PropertyChangeEvent when a property is updated.	UIComponent
		findSkinParts():void Find the skin parts in the skin class and assign them to the properties of the component.	SkinnableComponent
		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
		getCurrentSkinState():String [override] Returns the name of the state to be applied to the skin.	SkinnableContainerBase
		getDynamicPartAt(partName:String, index:int):Object Returns a specific instance of a dynamic part.	SkinnableComponent
		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
		itemAdded(index:int):void Called when an item has been added to this component.	ListBase
		itemRemoved(index:int):void Called when an item has been removed from this component.	ListBase
		itemSelected(index:int, selected:Boolean):void Called when an item is selected or deselected.	ListBase
		itemShowingCaret(index:int, showsCaret:Boolean):void Called when an item is in its caret state or not.	ListBase
		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
		measure():void Calculates the default size, and optionally the default minimum size, of the component.	UIComponent
		numDynamicParts(partName:String):int Returns the number of instances of a dynamic part.	SkinnableComponent
		partAdded(partName:String, instance:Object):void Called when a skin part is added.	SkinnableComponent
		partRemoved(partName:String, instance:Object):void Called when an instance of a skin part is being removed.	SkinnableComponent
		removeDynamicPartInstance(partName:String, instance:Object):void Remove an instance of a dynamic part.	SkinnableComponent
		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
		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
caretChange	Dispatched after the focus has changed.	ListBase
change	Dispatched after the selection has changed.	ListBase
changing	Dispatched when the selection is going to change.	ListBase
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
itemRollOut	Dispatched when the user rolls the mouse pointer out of an item in the control.	ListBase
itemRollOver	Dispatched when the user rolls the mouse pointer over an item in the control.	ListBase
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
rendererAdd	Dispatched when a renderer is added to the container.	SkinnableDataContainer
rendererRemove	Dispatched when a renderer is removed from the container.	SkinnableDataContainer
resize	Dispatched when the component is resized.	UIComponent
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
alignmentBaseline	Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline	SkinnableDataContainer
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
baselineShift	Type: Object CSS Inheritance: yes Amount to shift the baseline. See also flashx.textLayout.formats.ITextLayoutFormat.baselineShift	SkinnableDataContainer
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
cffHinting	Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.cffHinting	SkinnableDataContainer
chromeColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component.	SkinnableComponent
color	Type: uint Format: Color CSS Inheritance: yes Color of the text. See also flashx.textLayout.formats.ITextLayoutFormat.color spark.components.supportClasses.StyleableTextField.color spark.components.supportClasses.StyleableStageText.color	SkinnableDataContainer
digitCase	Type: String CSS Inheritance: yes The type of digit case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitCase	SkinnableDataContainer
digitWidth	Type: String CSS Inheritance: yes Type of digit width used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitWidth	SkinnableDataContainer
direction	Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also flashx.textLayout.formats.ITextLayoutFormat.direction	SkinnableDataContainer
dominantBaseline	Type: String CSS Inheritance: yes Specifies which element baseline snaps to the `alignmentBaseline` to determine the vertical position of the element on the line. See also flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline	SkinnableDataContainer
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
errorSkin	Type: Class Name of the skin class to use for this component when a validation error occurs.	SkinnableComponent
focusAlpha	Type: Number CSS Inheritance: no Theme: spark, mobile The alpha of the focus ring for this component.	SkinnableDataContainer
focusColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus.	SkinnableDataContainer
focusSkin	Type: Class CSS Inheritance: no Skin used to draw the focus rectangle.	UIComponent
fontFamily	Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also flashx.textLayout.formats.ITextLayoutFormat.fontFamily spark.components.supportClasses.StyleableStageText.fontFamily spark.components.supportClasses.StyleableTextField.fontFamily	SkinnableDataContainer
fontLookup	Type: String CSS Inheritance: yes Font lookup to use. See also flashx.textLayout.formats.ITextLayoutFormat.fontLookup	SkinnableDataContainer
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also flashx.textLayout.formats.ITextLayoutFormat.fontSize spark.components.supportClasses.StyleableStageText.fontSize spark.components.supportClasses.StyleableTextField.fontSize	SkinnableDataContainer
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font. See also flashx.textLayout.formats.ITextLayoutFormat.fontStyle spark.components.supportClasses.StyleableStageText.fontStyle spark.components.supportClasses.StyleableTextField.fontStyle	SkinnableDataContainer
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface. See also flashx.textLayout.formats.ITextLayoutFormat.fontWeight spark.components.supportClasses.StyleableStageText.fontWeight spark.components.supportClasses.StyleableTextField.fontWeight	SkinnableDataContainer
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
interactionMode	Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH	UIComponent
justificationRule	Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationRule	SkinnableDataContainer
justificationStyle	Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationStyle	SkinnableDataContainer
kerning	Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.kerning	SkinnableDataContainer
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 Theme: mobile Additional vertical space between lines of text. See also spark.components.supportClasses.StyleableTextField.leading lineHeight	SkinnableDataContainer
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 Theme: mobile The number of additional pixels to appear between each character. See also spark.components.supportClasses.StyleableTextField.letterSpacing trackingLeft trackingRight	SkinnableDataContainer
ligatureLevel	Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel	SkinnableDataContainer
lineHeight	Type: Object CSS Inheritance: yes Leading controls for the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineHeight leading	SkinnableDataContainer
lineThrough	Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineThrough	SkinnableDataContainer
locale	Type: String CSS Inheritance: yes The locale of the text. See also http://www.unicode.org/reports/tr35/	SkinnableDataContainer
renderingMode	Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also flashx.textLayout.formats.ITextLayoutFormat.renderingMode	SkinnableDataContainer
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
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
skinClass	Type: Class Name of the skin class to use for this component.	SkinnableComponent
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container. See also flashx.textLayout.formats.ITextLayoutFormat.textAlign spark.components.supportClasses.StyleableStageText.textAlign spark.components.supportClasses.StyleableTextField.textAlign	SkinnableDataContainer
textAlignLast	Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlignLast	SkinnableDataContainer
textAlpha	Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlpha	SkinnableDataContainer
textDecoration	Type: String CSS Inheritance: yes Determines whether the text is underlined. See also flashx.textLayout.formats.ITextLayoutFormat.textDecoration spark.components.supportClasses.StyleableTextField.textDecoration	SkinnableDataContainer
textJustify	Type: String CSS Inheritance: yes Specifies options for justifying text. See also flashx.textLayout.formats.ITextLayoutFormat.textJustify	SkinnableDataContainer
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
trackingLeft	Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingLeft	SkinnableDataContainer
trackingRight	Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingRight	SkinnableDataContainer
typographicCase	Type: String CSS Inheritance: yes The type of typographic case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.typographicCase	SkinnableDataContainer
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

	Skin Part	Description	Defined By
		dataGroup:DataGroup	Required: false Part Type: Static An optional skin part that defines the DataGroup in the skin class where data items get pushed into, rendered, and laid out.	SkinnableDataContainer

	Skin State	Description	Defined By
		disabled	Disabled State	SkinnableContainerBase
		normal	Normal State	SkinnableContainerBase

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
		NO_SELECTION : int = -1 [static] Static constant representing the value "no selection".	ListBase

Property Detail

arrowKeysWrapFocus

property

public var arrowKeysWrapFocus:Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

If true, using arrow keys to navigate within the component wraps when it hits either end.

The default value is false.

caretIndex

property

caretIndex:Number [read-only]

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Item that is currently in focus.

The default value is -1.

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

Implementation
public function get caretIndex():Number

isFirstRow

property

isFirstRow:Boolean [read-only]

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the first row.

Implementation
public function get isFirstRow():Boolean

isLastRow

property

isLastRow:Boolean [read-only]

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the last row.

Implementation
public function get isLastRow():Boolean

labelField

property

labelField:String

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The name of the field in the data provider items to display as the label. If labelField is set to an empty string (""), no field will be considered on the data provider to represent label. The labelFunction property overrides this property.

The default value is "label".

Implementation
public function get labelField():String
public function set labelField(value:String):void

labelFunction

property

labelFunction:Function

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

A user-supplied function to run on each item to determine its label. The labelFunction property overrides the labelField property.

You can supply a labelFunction that finds the appropriate fields and returns a displayable string. The labelFunction is also good for handling formatting and localization.

The label function takes a single argument which is the item in the data provider and returns a String.

      myLabelFunction(item:Object):String

The default value is null.

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

preventSelection

property

preventSelection:Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

If true items will be prevented from being selected. The selectedIndex value should always be -1. When this is set to true, it will set the requireSelection to false. Click events will continue to be called.

The default value is false.

Implementation
public function get preventSelection():Boolean
public function set preventSelection(value:Boolean):void

requireSelection

property

requireSelection:Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

If true, a data item must always be selected in the control. If the value is true, the selectedIndex property is always set to a value between 0 and (dataProvider.length - 1).

The default value is false for most subclasses, except TabBar. In that case, the default is true.

The default value is false.

Implementation
public function get requireSelection():Boolean
public function set requireSelection(value:Boolean):void

selectedIndex

property

selectedIndex:int

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The 0-based index of the selected item, or -1 if no item is selected. Setting the selectedIndex property deselects the currently selected item and selects the data item at the specified index.

The value is always between -1 and (dataProvider.length - 1). If items at a lower index than selectedIndex are removed from the component, the selected index is adjusted downward accordingly.

If the selected item is removed, the selected index is set to:

-1 if requireSelection = false or there are no remaining items.
0 if requireSelection = true and there is at least one item.

When the user changes the selectedIndex property by interacting with the control, the control dispatches the change and changing events. When you change the value of the selectedIndex property programmatically, it dispatches the valueCommit event.

The default value is -1.

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

Implementation
public function get selectedIndex():int
public function set selectedIndex(value:int):void

selectedItem

property

selectedItem:*

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The item that is currently selected. Setting this property deselects the currently selected item and selects the newly specified item.

Setting selectedItem to an item that is not in this component results in no selection, and selectedItem being set to undefined.

If the selected item is removed, the selected item is set to:

undefined if requireSelection = false or there are no remaining items.
The first item if requireSelection = true and there is at least one item.

When the user changes the selectedItem property by interacting with the control, the control dispatches the change and changing events. When you change the value of the selectedItem property programmatically, it dispatches the valueCommit event.

The default value is undefined.

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

Implementation
public function get selectedItem():*
public function set selectedItem(value:any):void

useVirtualLayout

property

useVirtualLayout:Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Sets the value of the useVirtualLayout property of the layout associated with this control. If the layout is subsequently replaced and the value of this property is true, then the new layout's useVirtualLayout property is set to true.

The default value is false.

Implementation
public function get useVirtualLayout():Boolean
public function set useVirtualLayout(value:Boolean):void

Constructor Detail

ListBase

()

Constructor

public function ListBase()

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Constructor.

Method Detail

adjustSelection

()

method

protected function adjustSelection(newIndex:int, add:Boolean = false):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Adjusts the selected index to account for items being added to or removed from this component. This method adjusts the selected index value and dispatches a valueCommit event. It does not dispatch a change event because the change did not occur as a direct result of user-interaction. Moreover, it does not dispatch a changing event or allow the cancellation of the selection. It also does not call the itemSelected() method, since the same item is selected; the only thing that has changed is the index of the item.

A valueCommit event is dispatched in the next call to the commitProperties() method.

The change and changing events are not sent when the selectedIndex is adjusted.

Parameters

	`newIndex:int` — The new index.

	`add:Boolean` (default = `false`) — `true` if an item was added to the component, and `false` if an item was removed.

findRowIndex

()

method

public function findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given value and return the index for the match. It can start the find from a given startingIndex;

Parameters

	`field:String`

	`value:String`

	`startingIndex:int` (default = `0`)

	`patternType:String` (default = `NaN`)

Returns

int

findRowIndices

()

method

public function findRowIndices(field:String, values:Array, patternType:String):Array

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given values and return an array of indices that matched.

Parameters

	`field:String`

	`values:Array`

	`patternType:String` (default = `NaN`)

Returns

Array

itemAdded

()

method

protected function itemAdded(index:int):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Called when an item has been added to this component. Selection and caret related properties are adjusted accordingly.

Parameters

index:int — The index of the item being added.

itemRemoved

()

method

protected function itemRemoved(index:int):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Called when an item has been removed from this component. Selection and caret related properties are adjusted accordingly.

Parameters

index:int — The index of the item being removed.

itemSelected

()

method

protected function itemSelected(index:int, selected:Boolean):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Called when an item is selected or deselected. Subclasses must override this method to display the selection.

Parameters

	`index:int` — The item index that was selected.

	`selected:Boolean` — `true` if the item is selected, and `false` if it is deselected.

itemShowingCaret

()

method

protected function itemShowingCaret(index:int, showsCaret:Boolean):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Called when an item is in its caret state or not. Subclasses must override this method to display the caret.

Parameters

	`index:int` — The item index that was put into caret state.

	`showsCaret:Boolean` — `true` if the item is in the caret state, and `false` if it is not.

itemToLabel

()

method

override public function itemToLabel(item:Object):String

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Given a data item, return the correct text a renderer should display while taking the labelField and labelFunction properties into account.

Parameters

item:Object — A data item

Returns

String — String representing the text to display for the data item in the renderer.

moveIndexFindRow

()

method

public function moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value. It can start the search from the startingIndex;

Parameters

	`field:String`

	`value:String`

	`startingIndex:int` (default = `0`)

	`patternType:String` (default = `NaN`)

Returns

Boolean

moveIndexFirstRow

()

method

public function moveIndexFirstRow():void

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the first row of the dataProvider.

moveIndexLastRow

()

method

public function moveIndexLastRow():void

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the last row of the dataProvider.

moveIndexNextRow

()

method

public function moveIndexNextRow():void

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the next row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the first row, it does not wrap around. However the isFirstRow property returns true.

moveIndexPreviousRow

()

method

public function moveIndexPreviousRow():void

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the previous row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the last row, it does not wrap around. However the isLastRow property returns true.

setSelectedIndex

()

method

public function setSelectedIndex(rowIndex:int, dispatchChangeEvent:Boolean = false, changeCaret:Boolean = true):void

Language Version :

ActionScript 3.0

Product Version :

Flex 4.10

Runtime Versions :

Flash Player 11.1, AIR 3.4

The rowIndex is the index in the data provider of the item containing the selected cell.

Parameters

	`rowIndex:int` — The 0-based row index of the cell.

	`dispatchChangeEvent:Boolean` (default = `false`) — if true, the component will dispatch a "change" event if the rowIndex has changed. Otherwise, it will dispatch a "valueCommit" event.

	`changeCaret:Boolean` (default = `true`) — if true, the caret will be set to the selectedIndex as a side-effect of calling this method. If false, caretIndex won't change.

Event Detail

caretChange

Event

Event Object Type: spark.events.IndexChangeEvent
IndexChangeEvent.type property = spark.events.IndexChangeEvent.CARET_CHANGE

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Dispatched after the focus has changed.

The IndexChangeEvent.CARET_CHANGE constant defines the value of the type property of the event object for a caretChange event, which indicates that the current item in focus is about to change.

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`.
`newIndex`	The zero-based index of the selected item after the change.
`oldIndex`	The zero-based index of the selected item before the change.
`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.
`Type`	IndexChangeEvent.CARET_CHANGE

change

Event

Event Object Type: spark.events.IndexChangeEvent
IndexChangeEvent.type property = spark.events.IndexChangeEvent.CHANGE

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Dispatched after the selection has changed. This event is dispatched when the user interacts with the control.

When you change the value of the selectedIndex or selectedItem properties programmatically, the control does not dispatch the change event. It dispatches the valueCommit event instead.

The IndexChangeEvent.CHANGE constant defines the value of the type property of the event object for a change event, which indicates that an index has changed, such as when a List-based control changes its selection.

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`.
`newIndex`	The zero-based index after the change.
`oldIndex`	The zero-based index before the change.
`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.
`Type`	IndexChangeEvent.CHANGE

changing

Event

Event Object Type: spark.events.IndexChangeEvent
IndexChangeEvent.type property = spark.events.IndexChangeEvent.CHANGING

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Dispatched when the selection is going to change. Calling the preventDefault() method on the event prevents the selection from changing.

This event is dispatched when the user interacts with the control. When you change the value of the selectedIndex or selectedItem properties programmatically, the control does not dispatch the changing event. It dispatches the valueCommit event instead.

The IndexChangeEvent.CHANGING constant defines the value of the type property of the event object for a changing event, which indicates that the current selection is about to change.

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`.
`newIndex`	The zero-based index of the selected item after the change.
`oldIndex`	The zero-based index of the selected item before the change.
`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.
`Type`	IndexChangeEvent.CHANGING

itemRollOut

Event

Event Object Type: spark.events.ListEvent
ListEvent.type property = spark.events.ListEvent.ITEM_ROLL_OUT

Language Version :

ActionScript 3.0

Product Version :

Flex 4.5

Runtime Versions :

Flash Player 10.2, AIR 2.5

Dispatched when the user rolls the mouse pointer out of an item in the control.

The ListEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.

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`.
`itemIndex`	The data provider index of the item displayed by the item renderer where the event occurred.
`item`	The data provider item for the item renderer.
`itemRenderer`	The The item renderer that displayed this item.
`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.
`Type`	ListEvent.ITEM_ROLL_OUT

itemRollOver

Event

Event Object Type: spark.events.ListEvent
ListEvent.type property = spark.events.ListEvent.ITEM_ROLL_OVER

Language Version :

ActionScript 3.0

Product Version :

Flex 4.5

Runtime Versions :

Flash Player 10.2, AIR 2.5

Dispatched when the user rolls the mouse pointer over an item in the control.

The ListEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.

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`.
`itemIndex`	The data provider index of the item displayed by the item renderer where the event occurred.
`item`	The data provider item for the item renderer.
`itemRenderer`	The The item renderer that displayed this item.
`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.
`Type`	ListEvent.ITEM_ROLL_OVER

Constant Detail

NO_SELECTION

Constant

public static const NO_SELECTION:int = -1

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

Static constant representing the value "no selection".

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

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ListBase	Properties \| Methods \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants

Package	spark.components.supportClasses
Class	public class ListBase
Inheritance	ListBase SkinnableDataContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite flash.display.Sprite
Implements	IDataProviderEnhance
Subclasses	ButtonBarBase, List, SpinnerList