Package | mx.core |
Class | public class UIComponent |
Inheritance | UIComponent FlexSprite flash.display.Sprite |
Implements | IAutomationObject, IChildList, IConstraintClient, IDeferredInstantiationUIComponent, IFlexDisplayObject, IFlexModule, IInvalidating, ILayoutManagerClient, IPropertyChangeNotifier, IRepeaterClient, ISimpleStyleClient, IStateClient, IStyleClient, IToolTipManagerClient, IUIComponent, IValidatorListener |
Subclasses | AudioLoadBar, AudioScrubBar, AutoplayProgressDisplay, BorderBox, BoxDivider, Button, Container, DataLooper, FlexVideoPlayer, HRule, Label, ListItemDragProxy, ListItemRenderer, NoteBox, PagingControlScrollbar, ProgressBar, ScrollBar, ScrollControlBase, Spacer, Spinner, SuperImage, SWFLoader, TextInput, TileListItemRenderer, ToolTip, TreeItemRenderer, UILoader, VRule |
An interactive component can participate in tabbing and other kinds of keyboard focus manipulation, accept low-level events like keyboard and mouse input, and be disabled so that it does not receive keyboard and mouse input. This is in contrast to noninteractive components, like Label and ProgressBar, which simply display contents and are not manipulated by the user.
The UIComponent class is not used as an MXML tag, but is used as a base class for other classes.
MXML Syntax Hide MXML SyntaxAll user interface components in Flex extend the UIComponent class. Flex components inherit the following properties from the UIComponent class:
<mx:tagname Properties automationName="null" cachePolicy="auto|on|off" currentState="null" doubleClickEnabled="false|true" enabled="true|false" explicitHeight="NaN" explicitMaxHeight="NaN" explicitMaxWidth="NaN" explicitMinHeight="NaN" explicitMinWidth="NaN" explicitWidth="NaN" focusEnabled="true|false" height="0" id="" includeInLayout="true|false" maxHeight="10000" maxWidth="10000" measuredHeight= measuredMinHeight= measuredMinWidth= measuredWidth= minHeight="0" minWidth="0" mouseFocusEnabled="true|false" percentHeight="NaN" percentWidth="NaN" scaleX="1.0" scaleY="1.0" states="null" styleName="undefined" toolTip="null" transitions="" validationSubField width="0" x="0" y="0" Styles bottom="undefined" errorColor="0xFF0000" focusBlendMode="normal" focusSkin="HaloFocusRect"" focusThickness="2" horizontalCenter="undefined" left="undefined" right="undefined" themeColor="haloGreen" top="undefined" verticalCenter="undefined" Special Styles (Color Modifiers) saturation="0" contrast="0" brightness="0" hue="0" opacity="1" Effects addedEffect="No default" creationCompleteEffect="No default" focusInEffect="No default" focusOutEffect="No default" hideEffect="No default" mouseDownEffect="No default" mouseUpEffect="No default" moveEffect="No default" removedEffect="No default" resizeEffect="No default" rollOutEffect="No default" rollOverEffect="No default" showEffect="No default" Events add="No default" creationComplete="No default" currentStateChange="No default" currentStateChanging="No default" dragComplete="No default" dragDrop="No default" dragEnter="No default" dragExit="No default" dragOver="No default" effectEnd="No default" effectStart="No default" enterState="No default" exitState="No default" hide="No default" initialize="No default" invalid="No default" mouseDownOutside="No default" mouseWheelOutside="No default" move="No default" preinitialize="No default" record="No default" remove="No default" resize="No default" show="No default" toolTipCreate="No default" toolTipEnd="No default" toolTipHide="No default" toolTipShow="No default" toolTipShown="No default" toolTipStart="No default" updateComplete="No default" valid="No default" valueCommit="No default" >
See also
Property | Defined by | ||
---|---|---|---|
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 | ||
automationName : String
Name that can be used as an identifier for this object.
| 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 | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| 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 | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| 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 | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| 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 | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| 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 | ||
isDocument : Boolean [read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| 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
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| UIComponent | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | ||
move_enableProtection : Boolean = false | 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 UIComponent.
| UIComponent | ||
parent : DisplayObjectContainer [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
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| 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 | ||
scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | ||
scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | ||
screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
toolTip : String
Text to display in the ToolTip.
| 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 | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean [read-only]
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Property | Defined by | ||
---|---|---|---|
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 |
Method | Defined by | ||
---|---|---|---|
Constructor.
| 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 | ||
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 | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | ||
dispatchEvent(event:Event):Boolean
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, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically 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 the data bindings into this UIComponent object.
| UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| 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 | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
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 | ||
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
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | 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 | ||
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 | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b> ,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| 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 | ||
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 | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| 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 | ||
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 | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| 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
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
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 | ||
---|---|---|---|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | ||
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | ||
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | ||
commitProperties():void
Processes the properties set on the component.
| UIComponent | ||
createChildren():void
Create child objects of the component.
| UIComponent | ||
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 | ||
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 | ||
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code.
| 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 | ||
measure():void
Calculates the default size, and optionally the default minimum size,
of the component.
| UIComponent | ||
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 | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
| UIComponent |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | |||
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | |||
Dispatched after the view state has changed. | UIComponent | |||
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | |||
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 | |||
Dispatched by the drop target when the user releases the mouse over it. | UIComponent | |||
Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | |||
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | |||
Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | |||
Dispatched by the drag initiator when starting a drag operation. | UIComponent | |||
Dispatched after an effect ends. | UIComponent | |||
Dispatched just before an effect starts. | UIComponent | |||
Dispatched after the component has returned to the root view state. | UIComponent | |||
Dispatched before the component exits from the root view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | |||
Dispatched when the object has moved. | UIComponent | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched by the component when it is time to create a ToolTip. | UIComponent | |||
Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be shown. | UIComponent | |||
Dispatched by the component when its ToolTip has been shown. | UIComponent | |||
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | |||
Dispatched when an object has had its commitProperties() ,
measure() , and
updateDisplayList() methods called (if needed). | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | |||
Dispatched when values are changed programmatically or by user interaction. | UIComponent |
Effect | 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 |
activeEffects | property |
activeEffects:Array
[read-only]The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
Implementation public function get activeEffects():Array
automationDelegate | property |
automationDelegate:Object
[read-write]The delegate object that handles the automation-related functionality.
Implementation public function get automationDelegate():Object
public function set automationDelegate(value:Object):void
automationName | property |
automationName:String
[read-write]Name that can be used as an identifier for this object.
Implementation public function get automationName():String
public function set automationName(value:String):void
automationTabularData | property |
automationTabularData:Object
[read-only]
An implementation of the IAutomationTabularData
interface, which
can be used to retrieve the data.
public function get automationTabularData():Object
automationValue | property |
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.
Implementation public function get automationValue():Array
baselinePosition | property |
baselinePosition:Number
[read-only]The y-coordinate of the baseline of the first line of text of the component.
This property is used to implement
the baseline
constraint style.
It is also used to align the label of a FormItem
with the controls in the FormItem.
Each component should override this property.
Implementation public function get baselinePosition():Number
cacheHeuristic | property |
cacheHeuristic:Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
If cachePolicy
is UIComponentCachePolicy.AUTO
,
then cacheHeuristic
is used to control the object's cacheAsBitmap
property.
public function set cacheHeuristic(value:Boolean):void
cachePolicy | property |
cachePolicy:String
[read-write]
Specifies the bitmap caching policy for this object.
Possible values in MXML are "on"
,
"off"
and
"auto"
(default).
Possible values in ActionScript are UIComponentCachePolicy.ON
,
UIComponentCachePolicy.OFF
and
UIComponentCachePolicy.AUTO
(default).
UIComponentCachePolicy.ON
means that
the object is always cached as a bitmap.UIComponentCachePolicy.OFF
means that
the object is never cached as a bitmap.UIComponentCachePolicy.AUTO
means that
the framework uses heuristics to decide whether the object should
be cached as a bitmap.The default value is UIComponentCachePolicy.AUTO
.
public function get cachePolicy():String
public function set cachePolicy(value:String):void
className | property |
className:String
[read-only]
The name of this instance's class, such as "Button"
.
This string does not include the package name.
If you need the package name as well, call the
getQualifiedClassName()
method in the flash.utils package.
It will return a string such as "mx.controls::Button"
.
public function get className():String
contentMouseX | property |
contentMouseX:Number
[read-only]Returns the x position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.
Implementation public function get contentMouseX():Number
contentMouseY | property |
contentMouseY:Number
[read-only]Returns the y position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.
Implementation public function get contentMouseY():Number
currentLooperData | property |
public var currentLooperData:Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
This value comes from the dataProvider
on the DataLooper.
See also
currentState | property |
currentState:String
[read-write]
The current view state of the component.
Set to ""
or null
to reset
the component back to its base state.
When you use this property to set a component's state,
Flex applies any transition you have defined.
You can also use the setCurrentState()
method to set the
current state; this method can optionally change states without
applying a transition.
This property can be used as the source for data binding.
Implementation public function get currentState():String
public function set currentState(value:String):void
See also
cursorManager | property |
cursorManager:ICursorManager
[read-only]Gets the CursorManager that controls the cursor for this component and its peers. Each top-level window has its own instance of a CursorManager; To make sure you're talking to the right one, use this method.
Implementation public function get cursorManager():ICursorManager
descriptor | property |
descriptor:UIComponentDescriptor
[read-write]
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor()
method to create this
UIComponent instance. If this UIComponent instance
was not created from a descriptor, this property is null.
public function get descriptor():UIComponentDescriptor
public function set descriptor(value:UIComponentDescriptor):void
See also
document | property |
document:Object
[read-write]A reference to the document object associated with this UIComponent. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or AS component.
Implementation public function get document():Object
public function set document(value:Object):void
doubleClickEnabled | property |
doubleClickEnabled:Boolean
[read-write]
Specifies whether the UIComponent object receives doubleClick
events.
The default value is false
, which means that the UIComponent object
does not receive doubleClick
events.
The mouseEnabled
property must also be set to true
,
its default value, for the object to receive doubleClick
events.
The default value is false
.
public function get doubleClickEnabled():Boolean
public function set doubleClickEnabled(value:Boolean):void
enabled | property |
enabled:Boolean
[read-write]
Whether the component can accept user interaction. After setting the enabled
property to false
, some components still respond to mouse interactions such
as mouseOver. As a result, to fully disable UIComponents,
you should also set the value of the mouseEnabled
property to false
.
If you set the enabled
property to false
for a container, Flex dims the color of the container and of all
of its children, and blocks user input to the container
and to all of its children.
This property can be used as the source for data binding.
Implementation public function get enabled():Boolean
public function set enabled(value:Boolean):void
errorString | property |
errorString:String
[read-write]The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
You can use the errorString
property to show a
validation error for a component, without actually using a validator class.
When you write a String value to the errorString
property,
Flex draws a red border around the component to indicate the validation error,
and the String appears in a tooltip as the validation error message when you move
the mouse over the component, just as if a validator detected a validation error.
To clear the validation error, write an empty String, "",
to the errorString
property.
Note that writing a value to the errorString
property
does not trigger the valid or invalid events; it only changes the border
color and displays the validation error message.
This property can be used as the source for data binding.
Implementation public function get errorString():String
public function set errorString(value:String):void
explicitHeight | property |
explicitHeight:Number
[read-write]Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitHeight
with respect to its parent
is affected by the scaleY
property.
Setting the height
property also sets this property to
the specified height value.
This property can be used as the source for data binding.
Implementation public function get explicitHeight():Number
public function set explicitHeight(value:Number):void
explicitMaxHeight | property |
explicitMaxHeight:Number
[read-write]Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxHeight
with respect to its parent
is affected by the scaleY
property.
Some components have no theoretical limit to their height.
In those cases their maxHeight
will be set to
UIComponent.DEFAULT_MAX_HEIGHT
.
The default value is NaN
.
This property can be used as the source for data binding.
Implementation public function get explicitMaxHeight():Number
public function set explicitMaxHeight(value:Number):void
explicitMaxWidth | property |
explicitMaxWidth:Number
[read-write]Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxWidth
with respect to its parent
is affected by the scaleX
property.
Some components have no theoretical limit to their width.
In those cases their maxWidth
will be set to
UIComponent.DEFAULT_MAX_WIDTH
.
The default value is NaN
.
This property can be used as the source for data binding.
Implementation public function get explicitMaxWidth():Number
public function set explicitMaxWidth(value:Number):void
explicitMinHeight | property |
explicitMinHeight:Number
[read-write]Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight
with respect to its parent
is affected by the scaleY
property.
The default value is NaN
.
This property can be used as the source for data binding.
Implementation public function get explicitMinHeight():Number
public function set explicitMinHeight(value:Number):void
explicitMinWidth | property |
explicitMinWidth:Number
[read-write]Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth
with respect to its parent
is affected by the scaleX
property.
The default value is NaN
.
This property can be used as the source for data binding.
Implementation public function get explicitMinWidth():Number
public function set explicitMinWidth(value:Number):void
explicitWidth | property |
explicitWidth:Number
[read-write]Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitWidth
with respect to its parent
is affected by the scaleX
property.
Setting the width
property also sets this property to
the specified width value.
This property can be used as the source for data binding.
Implementation public function get explicitWidth():Number
public function set explicitWidth(value:Number):void
flexContextMenu | property |
flexContextMenu:IFlexContextMenu
[read-write]The context menu for this UIComponent.
The default value is null
.
public function get flexContextMenu():IFlexContextMenu
public function set flexContextMenu(value:IFlexContextMenu):void
focusEnabled | property |
focusEnabled:Boolean
[read-write]
Indicates whether the component can receive focus when tabbed to.
You can set focusEnabled
to false
when a UIComponent is used as a subcomponent of another component
so that the outer component becomes the focusable entity.
If this property is false
, focus will be transferred to
the first parent that has focusEnable
set to true
.
The default value is true
.
public function get focusEnabled():Boolean
public function set focusEnabled(value:Boolean):void
focusManager | property |
focusManager:IFocusManager
[read-write]Gets the FocusManager that controls focus for this component and its peers. Each popup has its own focus loop and therefore its own instance of a FocusManager. To make sure you're talking to the right one, use this method.
Implementation public function get focusManager():IFocusManager
public function set focusManager(value:IFocusManager):void
focusPane | property |
focusPane:Sprite
[read-write]The focus pane associated with this object. An object has a focus pane when one of its children has focus.
Implementation public function get focusPane():Sprite
public function set focusPane(value:Sprite):void
globalX | property |
globalX:Number
[read-write]Implementation
public function get globalX():Number
public function set globalX(value:Number):void
globalY | property |
globalY:Number
[read-write]Implementation
public function get globalY():Number
public function set globalY(value:Number):void
height | property |
height:Number
[read-write]Number that specifies the height of the component, in pixels, in the parent's coordinates. The default value is 0, but this property will contain the actual component height after Flex completes sizing the components in your application.
Note: You can specify a percentage value in the MXML
height
attribute, such as height="100%"
,
but you cannot use a percentage value for the height
property in ActionScript;
use the percentHeight
property instead.
Setting this property causes a resize
event to be dispatched.
See the resize
event for details on when
this event is dispatched.
If the component's scaleY
property is not 100,
the height of the component from its internal coordinates
will not match.
Thus a 100 pixel high component with a scaleY
of 200 will take 100 pixels in the parent, but will
internally think it is 50 pixels high.
This property can be used as the source for data binding.
Implementation public function get height():Number
public function set height(value:Number):void
id | property |
id:String
[read-write]ID of the component. This value becomes the instance name of the object and should not contain any white space or special characters. Each component throughout an application should have a unique id.
If your application is going to be tested by third party tools, give each component a meaningful id. Testing tools use ids to represent the control in their scripts and having a meaningful name can make scripts more readable. For example, set the value of a button to submit_button rather than b1 or button1.
Implementation public function get id():String
public function set id(value:String):void
includeInLayout | property |
includeInLayout:Boolean
[read-write]
Specifies whether this component is included in the layout of the
parent container.
If true
, the object is included in its parent container's
layout. If false
, the object is positioned by its parent
container as per its layout rules, but it is ignored for the purpose of
computing the position of the next child.
The default value is true
.
This property can be used as the source for data binding.
Implementation public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void
inheritingStyles | property |
inheritingStyles:Object
[read-write]
The beginning of this component's chain of inheriting styles.
The getStyle()
method simply accesses
inheritingStyles[styleName]
to search the entire
prototype-linked chain.
This object is set up by initProtoChain()
.
Developers typically never need to access this property directly.
public function get inheritingStyles():Object
public function set inheritingStyles(value:Object):void
initialized | property |
initialized:Boolean
[read-write]A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
Implementation public function get initialized():Boolean
public function set initialized(value:Boolean):void
instanceIndex | property |
instanceIndex:int
[read-only]The index of a repeated component. If the component is not within a Repeater, the value is -1.
Implementation public function get instanceIndex():int
instanceIndices | property |
instanceIndices:Array
[read-write]An Array containing the indices required to reference this UIComponent object from its parent document. The Array is empty unless this UIComponent object is within one or more Repeaters. The first element corresponds to the outermost Repeater. For example, if the id is "b" and instanceIndices is [2,4], you would reference it on the parent document as b[2][4].
Implementation public function get instanceIndices():Array
public function set instanceIndices(value:Array):void
isDocument | property |
isDocument:Boolean
[read-only]Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
Implementation public function get isDocument():Boolean
isPopUp | property |
isPopUp:Boolean
[read-write]
Set to true
by the PopUpManager to indicate
that component has been popped up.
public function get isPopUp():Boolean
public function set isPopUp(value:Boolean):void
maxHeight | property |
maxHeight:Number
[read-write]Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxHeight
with respect to its parent
is affected by the scaleY
property.
Some components have no theoretical limit to their height.
In those cases their maxHeight
will be set to
UIComponent.DEFAULT_MAX_HEIGHT
.
The default value is 10000
.
This property can be used as the source for data binding.
Implementation public function get maxHeight():Number
public function set maxHeight(value:Number):void
maxWidth | property |
maxWidth:Number
[read-write]Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxWidth
with respect to its parent
is affected by the scaleX
property.
Some components have no theoretical limit to their width.
In those cases their maxWidth
will be set to
UIComponent.DEFAULT_MAX_WIDTH
.
The default value is 10000
.
This property can be used as the source for data binding.
Implementation public function get maxWidth():Number
public function set maxWidth(value:Number):void
measuredHeight | property |
measuredHeight:Number
[read-write]
The default height of the component, in pixels.
This value is set by the measure()
method.
public function get measuredHeight():Number
public function set measuredHeight(value:Number):void
measuredMinHeight | property |
measuredMinHeight:Number
[read-write]
The default minimum height of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinHeight():Number
public function set measuredMinHeight(value:Number):void
measuredMinWidth | property |
measuredMinWidth:Number
[read-write]
The default minimum width of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinWidth():Number
public function set measuredMinWidth(value:Number):void
measuredWidth | property |
measuredWidth:Number
[read-write]
The default width of the component, in pixels.
This value is set by the measure()
method.
public function get measuredWidth():Number
public function set measuredWidth(value:Number):void
minHeight | property |
minHeight:Number
[read-write]Number that specifies the minimum height of the component, in pixels, in the component's coordinates. The default value depends on the component implementation.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight
with respect to its parent
is affected by the scaleY
property.
This property can be used as the source for data binding.
Implementation public function get minHeight():Number
public function set minHeight(value:Number):void
minWidth | property |
minWidth:Number
[read-write]Number that specifies the minimum width of the component, in pixels, in the component's coordinates. The default value depends on the component implementation.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth
with respect to its parent
is affected by the scaleX
property.
This property can be used as the source for data binding.
Implementation public function get minWidth():Number
public function set minWidth(value:Number):void
miscHolder | property |
public var miscHolder:Object
A utility holder for any various properties
moduleFactory | property |
moduleFactory:IFlexModuleFactory
[read-write]The moduleFactory that is used to create TextFields in the correct SWF context. This is necessary so that embedded fonts will work.
Implementation public function get moduleFactory():IFlexModuleFactory
public function set moduleFactory(value:IFlexModuleFactory):void
mouseFocusEnabled | property |
mouseFocusEnabled:Boolean
[read-write]
Whether you can receive focus when clicked on.
If false
, focus will be transferred to
the first parent that is mouseFocusEnable
set to true
.
For example, you can set this property to false
on a Button control so that you can use the Tab key to move focus
to the control, but not have the control get focus when you click on it.
The default value is true
.
public function get mouseFocusEnabled():Boolean
public function set mouseFocusEnabled(value:Boolean):void
move_enableProtection | property |
public var move_enableProtection:Boolean = false
nestLevel | property |
nestLevel:int
[read-write]Depth of this object in the containment hierarchy. This number is used by the measurement and layout code. The value is 0 if this component is not on the DisplayList.
Implementation public function get nestLevel():int
public function set nestLevel(value:int):void
nonInheritingStyles | property |
nonInheritingStyles:Object
[read-write]
The beginning of this component's chain of non-inheriting styles.
The getStyle()
method simply accesses
nonInheritingStyles[styleName]
to search the entire
prototype-linked chain.
This object is set up by initProtoChain()
.
Developers typically never need to access this property directly.
public function get nonInheritingStyles():Object
public function set nonInheritingStyles(value:Object):void
numAutomationChildren | property |
numAutomationChildren:int
[read-only]The number of automation children this container has. This sum should not include any composite children, though it does include those children not significant within the automation hierarchy.
Implementation public function get numAutomationChildren():int
owner | property |
owner:DisplayObjectContainer
[read-write]The owner of this UIComponent. By default, it is the parent of this UIComponent. However, if this UIComponent object is a child component that is popped up by its parent, such as the dropdown list of a ComboBox control, the owner is the component that popped up this UIComponent object.
This property is not managed by Flex, but by each component.
Therefore, if you use the PopUpManger.createPopUp()
or
PopUpManger.addPopUp()
method to pop up a child component,
you should set the owner
property of the child component
to the component that popped it up.
The default value is the value of the parent
property.
public function get owner():DisplayObjectContainer
public function set owner(value:DisplayObjectContainer):void
parent | property |
parent:DisplayObjectContainer
[read-only]
The parent container or component for this component.
Only UIComponent objects should have a parent property.
Non-UIComponent objects should use another property to reference
the object to which they belong.
By convention, non-UIComponent objects use an owner
property to reference the object to which they belong.
public function get parent():DisplayObjectContainer
parentApplication | property |
parentApplication:Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
This Application object might exist in a SWFLoader control in another
Application, and so on, creating a chain of Application objects that
can be walked using parentApplication.
The parentApplication
property of an Application is never itself;
it is either the Application into which it was loaded or null
(for the top-level Application).
Walking the application chain using the parentApplication
property is similar to walking the document chain using the
parentDocument
property.
You can access the top-level application using the
application
property of the Application class.
This property can be used as the source for data binding.
Implementation public function get parentApplication():Object
parentDocument | property |
parentDocument:Object
[read-only]
A reference to the parent document object for this UIComponent.
A document object is a UIComponent at the top of the hierarchy
of a Flex application, MXML component, or AS component.
For the Application object, the parentDocument
property is null.
This property is useful in MXML scripts to go up a level
in the chain of document objects.
It can be used to walk this chain using
parentDocument.parentDocument
, and so on.
It is typed as Object so that authors can access properties
and methods on ancestor document objects without casting.
This property can be used as the source for data binding.
Implementation public function get parentDocument():Object
percentHeight | property |
percentHeight:Number
[read-write]
Number that specifies the height of a component as a percentage
of its parent's size. Allowed values are 0-100. The default value is NaN.
Setting the height
or explicitHeight
properties
resets this property to NaN.
This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.
This property is always set to NaN for the UITextField control.
This property can be used as the source for data binding.
Implementation public function get percentHeight():Number
public function set percentHeight(value:Number):void
percentWidth | property |
percentWidth:Number
[read-write]
Number that specifies the width of a component as a percentage
of its parent's size. Allowed values are 0-100. The default value is NaN.
Setting the width
or explicitWidth
properties
resets this property to NaN.
This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.
This property is always set to NaN for the UITextField control.
This property can be used as the source for data binding.
Implementation public function get percentWidth():Number
public function set percentWidth(value:Number):void
processedDescriptors | property |
processedDescriptors:Boolean
[read-write]
Set to true
after immediate or deferred child creation,
depending on which one happens. For a Container object, it is set
to true
at the end of
the createComponentsFromDescriptors()
method,
meaning after the Container object creates its children from its child descriptors.
For example, if an Accordion container uses deferred instantiation,
the processedDescriptors
property for the second pane of
the Accordion container does not become true
until after
the user navigates to that pane and the pane creates its children.
But, if the Accordion had set the creationPolicy
property
to "all"
, the processedDescriptors
property
for its second pane is set to true
during application startup.
For classes that are not containers, which do not have descriptors,
it is set to true
after the createChildren()
method creates any internal component children.
public function get processedDescriptors():Boolean
public function set processedDescriptors(value:Boolean):void
repeater | property |
repeater:IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
Use this property, rather than the repeaters
property,
when the UIComponent is created by a single Repeater object.
Use the repeaters
property when this UIComponent is created
by nested Repeater objects.
The property is set to null
when this UIComponent
is not created by a Repeater.
public function get repeater():IRepeater
repeaterIndex | property |
repeaterIndex:int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
Use this property, rather than the repeaterIndices
property,
when the UIComponent is created by a single Repeater object.
Use the repeaterIndices
property when this UIComponent is created
by nested Repeater objects.
This property is set to -1 when this UIComponent is not created by a Repeater.
Implementation public function get repeaterIndex():int
repeaterIndices | property |
repeaterIndices:Array
[read-write]An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. The Array is empty unless this UIComponent is within one or more Repeaters.
The first element in the Array corresponds to the outermost Repeater.
For example, if repeaterIndices
is [2,4] it means that the
outer repeater used item dataProvider[2]
and the inner repeater
used item dataProvider[4]
.
Note that this property differs from the instanceIndices
property
if the startingIndex
property of any of the Repeaters is not 0.
For example, even if a Repeater starts at dataProvider[4]
,
the document reference of the first repeated object is b[0], not b[4].
public function get repeaterIndices():Array
public function set repeaterIndices(value:Array):void
repeaters | property |
repeaters:Array
[read-write]An Array containing references to the Repeater objects in the parent document that produced this UIComponent. The Array is empty unless this UIComponent is within one or more Repeaters. The first element corresponds to the outermost Repeater object.
Implementation public function get repeaters():Array
public function set repeaters(value:Array):void
scaleX | property |
scaleX:Number
[read-write]Number that specifies the horizontal scaling factor.
The default value is 1.0, which means that the object
is not scaled.
A scaleX
of 2.0 means the object has been
magnified by a factor of 2, and a scaleX
of 0.5
means the object has been reduced by a factor of 2.
A value of 0.0 is an invalid value.
Rather than setting it to 0.0, set it to a small value, or set
the visible
property to false
to hide the component.
The default value is 1.0
.
This property can be used as the source for data binding.
Implementation public function get scaleX():Number
public function set scaleX(value:Number):void
scaleY | property |
scaleY:Number
[read-write]Number that specifies the vertical scaling factor.
The default value is 1.0, which means that the object
is not scaled.
A scaleY
of 2.0 means the object has been
magnified by a factor of 2, and a scaleY
of 0.5
means the object has been reduced by a factor of 2.
A value of 0.0 is an invalid value.
Rather than setting it to 0.0, set it to a small value, or set
the visible
property to false
to hide the component.
The default value is 1.0
.
This property can be used as the source for data binding.
Implementation public function get scaleY():Number
public function set scaleY(value:Number):void
screen | property |
screen:Rectangle
[read-only]Returns an object that contains the size and position of the base drawing surface for this object.
Implementation public function get screen():Rectangle
setActualSize_enableProtection | property |
public var setActualSize_enableProtection:Boolean = false
setVisible_enableProtection | property |
public var setVisible_enableProtection:Boolean = true
showInAutomationHierarchy | property |
showInAutomationHierarchy:Boolean
[read-write]A flag that determines if an automation object shows in the automation hierarchy. Children of containers that are not visible in the hierarchy appear as children of the next highest visible parent. Typically containers used for layout, such as boxes and Canvas, do not appear in the hierarchy.
Some controls force their children to appear
in the hierarchy when appropriate.
For example a List will always force item renderers,
including boxes, to appear in the hierarchy.
Implementers must support setting this property
to true
.
public function get showInAutomationHierarchy():Boolean
public function set showInAutomationHierarchy(value:Boolean):void
states | property |
public var states:Array
The view states that are defined for this component.
You can specify the states
property only on the root
of the application or on the root tag of an MXML component.
The compiler generates an error if you specify it on any other control.
styleClassOverridesInline | property |
public var styleClassOverridesInline:Boolean = true
Specifies if class-specific styles (as defined by the styleName
property) override inline styles.
The default value is true
.
styleDeclaration | property |
styleDeclaration:CSSStyleDeclaration
[read-write]
Storage for the inline inheriting styles on this object.
This CSSStyleDeclaration is created the first time that
the setStyle()
method
is called on this component to set an inheriting style.
Developers typically never need to access this property directly.
public function get styleDeclaration():CSSStyleDeclaration
public function set styleDeclaration(value:CSSStyleDeclaration):void
styleName | property |
styleName:Object
[read-write]The class style used by this component. This can be a String, CSSStyleDeclaration or an IStyleClient.
If this is a String, it is the name of a class declaration
in an mx:Style
tag or CSS file. You do not include the period in
the styleName
. For example, if you have a class style named ".bigText"
,
set the styleName
property to "bigText"
(no period).
If this is an IStyleClient (typically a UIComponent), all styles in the
styleName
object are used by this component.
The default value is null
.
public function get styleName():Object
public function set styleName(value:Object):void
systemManager | property |
systemManager:ISystemManager
[read-write]Returns the SystemManager object used by this component.
Implementation public function get systemManager():ISystemManager
public function set systemManager(value:ISystemManager):void
toolTip | property |
toolTip:String
[read-write]Text to display in the ToolTip.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get toolTip():String
public function set toolTip(value:String):void
transitions | property |
public var transitions:Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
See also
tweeningProperties | property |
tweeningProperties:Array
[read-write]Array of properties that are currently being tweened on this object.
Used to alert the EffectManager that certain properties of this object are being tweened, so that the EffectManger doesn't attempt to animate the same properties.
Implementation public function get tweeningProperties():Array
public function set tweeningProperties(value:Array):void
uid | property |
uid:String
[read-write]A unique identifier for the object. Flex data-driven controls, including all controls that are subclasses of List class, use a UID to track data provider items.
Flex can automatically create and manage UIDs.
However, there are circumstances when you must supply your own
uid
property by implementing the IUID interface,
or when supplying your own uid
property improves processing efficiency.
UIDs do not need to be universally unique for most uses in Flex.
One exception is for messages sent by data services.
public function get uid():String
public function set uid(value:String):void
See also
unscaledHeight | property |
unscaledHeight:Number
[read-only]
A convenience method for determining the unscaled height
of the component.
All of a component's drawing and child layout should be done
within a bounding rectangle of this height, which is also passed
as an argument to updateDisplayList()
.
protected function get unscaledHeight():Number
unscaledWidth | property |
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()
.
protected function get unscaledWidth():Number
updateCompletePendingFlag | property |
updateCompletePendingFlag:Boolean
[read-write]A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
Implementation public function get updateCompletePendingFlag():Boolean
public function set updateCompletePendingFlag(value:Boolean):void
validationSubField | property |
validationSubField:String
[read-write]Used by a validator to associate a subfield with this component.
Implementation public function get validationSubField():String
public function set validationSubField(value:String):void
visible | property |
visible:Boolean
[read-write]
Controls the visibility of this UIComponent. If true
,
the object is visible.
When setting to true
, the object will dispatch
a show
event.
When setting to false
, the object will dispatch
a hide
event.
In either case the children of the object will not emit a
show
or hide
event unless the object
has specifically written an implementation to do so.
The default value is true
.
This property can be used as the source for data binding.
Implementation public function get visible():Boolean
public function set visible(value:Boolean):void
visible_unprotected | property |
visible_unprotected:Boolean
[read-only]If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
Implementation public function get visible_unprotected():Boolean
width | property |
width:Number
[read-write]Number that specifies the width of the component, in pixels, in the parent's coordinates. The default value is 0, but this property will contain the actual component width after Flex completes sizing the components in your application.
Note: You can specify a percentage value in the MXML
width
attribute, such as width="100%"
,
but you cannot use a percentage value in the width
property in ActionScript.
Use the percentWidth
property instead.
Setting this property causes a resize
event to
be dispatched.
See the resize
event for details on when
this event is dispatched.
If the component's scaleX
property is not 1.0,
the width of the component from its internal coordinates
will not match.
Thus a 100 pixel wide component with a scaleX
of 2 will take 100 pixels in the parent, but will
internally think it is 50 pixels wide.
This property can be used as the source for data binding.
Implementation public function get width():Number
public function set width(value:Number):void
x | property |
x:Number
[read-write]Number that specifies the component's horizontal position, in pixels, within its parent container.
Setting this property directly or calling move()
will have no effect -- or only a temporary effect -- if the
component is parented by a layout container such as HBox, Grid,
or Form, because the layout calculations of those containers
set the x
position to the results of the calculation.
However, the x
property must almost always be set
when the parent is a Canvas or other absolute-positioning
container because the default value is 0.
The default value is 0
.
This property can be used as the source for data binding.
Implementation public function get x():Number
public function set x(value:Number):void
xmlDescriptor | property |
public var xmlDescriptor:XML
For certain dynamically created elements, this represents the XML node used to create that element.
y | property |
y:Number
[read-write]Number that specifies the component's vertical position, in pixels, within its parent container.
Setting this property directly or calling move()
will have no effect -- or only a temporary effect -- if the
component is parented by a layout container such as HBox, Grid,
or Form, because the layout calculations of those containers
set the x
position to the results of the calculation.
However, the x
property must almost always be set
when the parent is a Canvas or other absolute-positioning
container because the default value is 0.
The default value is 0
.
This property can be used as the source for data binding.
Implementation public function get y():Number
public function set y(value:Number):void
UIComponent | () | constructor |
public function UIComponent()
Constructor.
adjustFocusRect | () | method |
protected function adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
Parametersobj:DisplayObject (default = null ) — component whose focus rectangle to modify.
If omitted, the default value is this UIComponent object.
|
attachOverlay | () | method |
protected function attachOverlay():void
This is an internal method used by the Flex framework to support the Dissolve effect. You should not need to call it or override it.
callLater | () | method |
public function callLater(method:Function, args:Array = null):void
Queues a function to be called later.
Before each update of the screen, Flash Player or AIR calls the set of functions that are scheduled for the update. Sometimes, a function should be called in the next update to allow the rest of the code scheduled for the current update to be executed. Some features, like effects, can cause queued functions to be delayed until the feature completes.
Parametersmethod:Function — Reference to a method to be executed later.
|
|
args:Array (default = null ) — Array of Objects that represent the arguments to pass to the method.
|
childrenCreated | () | method |
protected function childrenCreated():void
Performs any final processing after child objects are created. This is an advanced method that you might override when creating a subclass of UIComponent.
clearStyle | () | method |
public function clearStyle(styleProp:String):void
Deletes a style property from this component instance.
This does not necessarily cause the getStyle()
method
to return undefined
.
styleProp:String — The name of the style property.
|
commitProperties | () | method |
protected function commitProperties():void
Processes the properties set on the component. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly.
Flex calls the commitProperties()
method when you
use the addChild()
method to add a component to a container,
or when you call the invalidateProperties()
method of the component.
Calls to the commitProperties()
method occur before calls to the
measure()
method. This lets you set property values that might
be used by the measure()
method.
Some components have properties that affect the number or kinds
of child objects that they need to create, or have properties that
interact with each other, such as the horizontalScrollPolicy
and horizontalScrollPosition
properties.
It is often best at startup time to process all of these
properties at one time to avoid duplicating work.
contentToGlobal | () | method |
public function contentToGlobal(point:Point):Point
Converts a Point
object from content coordinates to global coordinates.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Global coordinates specify a pixel position relative to the upper-left corner
of the stage, that is, the outermost edge of the application.
point:Point — A Point object that
specifies the x and y coordinates in the content coordinate system
as properties.
|
Point — A Point object with coordinates relative to the Stage.
|
See also
contentToLocal | () | method |
public function contentToLocal(point:Point):Point
Converts a Point
object from content to local coordinates.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Local coordinates specify a pixel position relative to the
upper left corner of the component.
point:Point — A Point object that specifies the x and y
coordinates in the content coordinate system as properties.
|
Point — Point A Point object with coordinates relative to the
local coordinate system.
|
See also
createAutomationIDPart | () | method |
public function createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.
Parameterschild:IAutomationObject — Child for which to provide the id.
|
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
createChildren | () | method |
protected function createChildren():void
Create child objects of the component. This is an advanced method that you might override when creating a subclass of UIComponent.
A component that creates other components or objects within it is called a composite component.
For example, the Flex ComboBox control is actually made up of a TextInput control
to define the text area of the ComboBox, and a Button control to define the ComboBox arrow.
Components implement the createChildren()
method to create child
objects (such as other components) within the component.
From within an override of the createChildren()
method,
you call the addChild()
method to add each child object.
You do not call this method directly. Flex calls the
createChildren()
method in response to the call to
the addChild()
method to add the component to its parent.
createInFontContext | () | method |
protected function createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
This method is used to solve a problem with access to fonts embedded in an application SWF when the framework is loaded as an RSL (the RSL has its own SWF context). Embedded fonts may only be accessed from the SWF file context in which they were created. By using the context of the application SWF, the RSL can create objects in the application SWF context that will have access to the application's embedded fonts.
Call this method only after the font styles for this object are set.
ParametersclassObj:Class — The class to create.
|
Object — The instance of the class created in the context
of the SWF owning the embedded font.
If this object is not using an embedded font,
the class is created in the context of this object.
|
createInModuleContext | () | method |
protected function createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. If the moduleFactory is null or the object cannot be created using the module factory, then fall back to creating the object using a systemManager.
ParametersmoduleFactory:IFlexModuleFactory — The moduleFactory to create the class in;
may be null.
|
|
className:String — The name of the class to create.
|
Object — The object created in the context of the moduleFactory.
|
createReferenceOnParentDocument | () | method |
public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id
reference to this IUIComponent object
on its parent document object.
This function can create multidimensional references
such as b[2][4] for objects inside one or more repeaters.
If the indices are null, it creates a simple non-Array reference.
parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.
|
deleteReferenceOnParentDocument | () | method |
public function deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id
reference to this IUIComponent object
on its parent document object.
This function can delete from multidimensional references
such as b[2][4] for objects inside one or more Repeaters.
If the indices are null, it deletes the simple non-Array reference.
parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.
|
determineTextFormatFromStyles | () | method |
public function determineTextFormatFromStyles():UITextFormat
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
ReturnsUITextFormat —
UITextFormat object corresponding to the text styles
for this UIComponent.
|
dispatchEvent | () | method |
public override function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
The event target is the EventDispatcher object upon which
the dispatchEvent()
method is called.
event:Event — The Event object that is dispatched into the event flow.
If the event is being redispatched, a clone of the event is created automatically.
After an event is dispatched, its target property cannot be changed,
so you must create a new copy of the event for redispatching to work.
|
Boolean — A value of true if the event was successfully dispatched.
A value of false indicates failure or that
the preventDefault() method was called on the event.
|
drawFocus | () | method |
public function drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent implements this by creating an instance of the class
specified by the focusSkin
style and positioning it
appropriately.
isFocused:Boolean — Determines if the focus indicator should be displayed. Set to
true to display the focus indicator. Set to false to hide it.
|
drawRoundRect | () | method |
public function drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
The rectangle can have rounded corners. Its edges are stroked with the current line style of the Graphics object. It can have a solid color fill, a gradient fill, or no fill. A solid fill can have an alpha transparency. A gradient fill can be linear or radial. You can specify up to 15 colors and alpha values at specified points along the gradient, and you can specify a rotation angle or transformation matrix for the gradient. Finally, the rectangle can have a rounded rectangular hole carved out of it.
This versatile rectangle-drawing routine is used by many skins.
It calls the drawRect()
or
drawRoundRect()
methods (in the flash.display.Graphics class) to draw into this
skin's Graphics object.
x:Number — Horizontal position of upper-left corner
of rectangle within this skin.
|
|
y:Number — Vertical position of upper-left corner
of rectangle within this skin.
|
|
width:Number — Width of rectangle, in pixels.
|
|
height:Number — Height of rectangle, in pixels.
|
|
cornerRadius:Object (default = null ) — Corner radius/radii of rectangle.
Can be null , a Number, or an Object.
If it is null , it specifies that the corners should be square
rather than rounded.
If it is a Number, it specifies the same radius, in pixels,
for all four corners.
If it is an Object, it should have properties named
tl , tr , bl , and
br , whose values are Numbers specifying
the radius, in pixels, for the top left, top right,
bottom left, and bottom right corners.
For example, you can pass a plain Object such as
{ tl: 5, tr: 5, bl: 0, br: 0 } .
The default value is null (square corners).
|
|
color:Object (default = null ) — The RGB color(s) for the fill.
Can be null , a uint, or an Array.
If it is null , the rectangle not filled.
If it is a uint, it specifies an RGB fill color.
For example, pass 0xFF0000 to fill with red.
If it is an Array, it should contain uints
specifying the gradient colors.
For example, pass [ 0xFF0000, 0xFFFF00, 0x0000FF ]
to fill with a red-to-yellow-to-blue gradient.
You can specify up to 15 colors in the gradient.
The default value is null (no fill).
|
|
alpha:Object (default = null ) — Alpha value(s) for the fill.
Can be null, a Number, or an Array.
This argument is ignored if color is null.
If color is a uint specifying an RGB fill color,
then alpha should be a Number specifying
the transparency of the fill, where 0.0 is completely transparent
and 1.0 is completely opaque.
You can also pass null instead of 1.0 in this case
to specify complete opaqueness.
If color is an Array specifying gradient colors,
then alpha should be an Array of Numbers, of the
same length, that specifies the corresponding alpha values
for the gradient.
In this case, the default value is null (completely opaque).
|
|
gradientMatrix:Matrix (default = null ) — Matrix object used for the gradient fill.
The utility methods horizontalGradientMatrix() ,
verticalGradientMatrix() , and
rotatedGradientMatrix() can be used to create the value for
this parameter.
|
|
gradientType:String (default = "linear ") — Type of gradient fill. The possible values are
GradientType.LINEAR or GradientType.RADIAL .
(The GradientType class is in the package flash.display.)
|
|
gradientRatios:Array (default = null ) — (optional default [0,255])
Specifies the distribution of colors. The number of entries must match
the number of colors defined in the color parameter.
Each value defines the percentage of the width where the color is
sampled at 100%. The value 0 represents the left-hand position in
the gradient box, and 255 represents the right-hand position in the
gradient box.
|
|
hole:Object (default = null ) — (optional) A rounded rectangular hole
that should be carved out of the middle
of the otherwise solid rounded rectangle
{ x: #, y: #, w: #, h: #, r: # or { br: #, bl: #, tl: #, tr: # } }
|
effectFinished | () | method |
public function effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
You can use this method to restore a modification to the component made
by the effectStarted()
method when the effect started,
or perform some other action when the effect ends.
effectInst:IEffectInstance — The effect instance object playing on the component.
|
effectStarted | () | method |
public function effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
You can use this method to perform a modification to the component as part
of an effect. You can use the effectFinished()
method
to restore the modification when the effect ends.
effectInst:IEffectInstance — The effect instance object playing on the component.
|
endEffectsStarted | () | method |
public function endEffectsStarted():void
Ends all currently playing effects on the component.
executeBindings | () | method |
public function executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object. Workaround for MXML container/bindings problem (177074): override Container.executeBindings() to prefer descriptor.document over parentDocument in the call to BindingManager.executeBindings(). This should always provide the correct behavior for instances created by descriptor, and will provide the original behavior for procedurally-created instances. (The bug may or may not appear in the latter case.) A more complete fix, guaranteeing correct behavior in both non-DI and reparented-component scenarios, is anticipated for updater 1.
Parametersrecurse:Boolean (default = false ) — Recursively execute bindings for children of this component.
|
finishPrint | () | method |
public function finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. For the UIComponent class, the method performs no action. Flex containers override the method to restore the container after printing.
This method is normally not used by application developers.
Parametersobj:Object — Contains the properties of the component that
restore it to its state before printing.
|
|
target:IFlexDisplayObject — The component that just finished printing.
It may be the current component or one of its children.
|
See also
focusInHandler | () | method |
protected function focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. If you override this method, make sure to call the base class version.
Parametersevent:FocusEvent — The event object.
|
focusOutHandler | () | method |
protected function focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. If you override this method, make sure to call the base class version.
Parametersevent:FocusEvent — The event object.
|
getAutomationChildAt | () | method |
public function getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. This list should not include any children that are composites.
Parametersindex:int — The index of the child to return
|
IAutomationObject —
The child at the specified index.
|
getClassStyleDeclarations | () | method |
public function getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. The algorithm walks up the superclass chain. For example, suppose that class MyButton extends Button. A MyButton instance will first look for a MyButton type selector then, it will look for a Button type selector. then, it will look for a UIComponent type selector. (The superclass chain is considered to stop at UIComponent, not Object.)
ReturnsArray — An Array of type selectors for this UIComponent instance.
|
getConstraintValue | () | method |
public function getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
ParametersconstraintName:String |
* |
getDescendantByName | () | method |
public function getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
Parametersname:String |
DisplayObject |
getDescendantsByName | () | method |
public function getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
Parametersname:String |
Array |
getExplicitOrMeasuredHeight | () | method |
public function getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the explicit or measured height
ReturnsNumber — A Number which is explicitHeight if defined
or measuredHeight if not.
|
getExplicitOrMeasuredWidth | () | method |
public function getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the explicit or measured width
ReturnsNumber — A Number which is explicitWidth if defined
or measuredWidth if not.
|
getFocus | () | method |
public function getFocus():InteractiveObject
Gets the object that currently has focus.
It might not be this object.
Note that this method does not necessarily return the component
that has focus.
It may return the internal subcomponent of the component
that has focus.
To get the component that has focus, use the
focusManager.focus
property.
InteractiveObject — Object that has focus.
|
getRepeaterItem | () | method |
public function 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.
The argument whichRepeater
is 0 for the outermost
Repeater, 1 for the next inner Repeater, and so on.
If whichRepeater
is not specified,
the innermost Repeater is used.
whichRepeater:int (default = -1 ) — Number of the Repeater,
counting from the outermost one, starting at 0.
|
Object — The requested repeater item.
|
getStyle | () | method |
public function getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
This same method is used to get any kind of style property, so the value returned may be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.
If you are getting a particular style property, you will know its type and will often want to store the result in a variable of that type. No casting from * to that type is necessary.
var backgroundColor:uint = getStyle("backgroundColor");
If the style property has not been set anywhere in the
style lookup chain, the value returned by getStyle()
will be undefined
.
Note that undefined
is a special value that is
not the same as false
, ""
,
NaN
, 0
, or null
.
No valid style value is ever undefined
.
You can use the static method
StyleManager.isValidStyleValue()
to test whether the value was set.
styleProp:String — Name of the style property.
|
* — Style value.
|
getVisibleRect | () | method |
public function getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
ParameterstargetParent:DisplayObject (default = null )
|
Rectangle |
globalToContent | () | method |
public function globalToContent(point:Point):Point
Converts a Point
object from global to content coordinates.
Global coordinates specify a pixel position relative to the upper-left corner
of the stage, that is, the outermost edge of the application.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
point:Point — A Point object that
specifies the x and y coordinates in the global (Stage)
coordinate system as properties.
|
Point — Point A Point object with coordinates relative to the component.
|
See also
horizontalGradientMatrix | () | method |
public function 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.
For performance reasons, the Matrix is stored in a static variable
which is reused by all calls to horizontalGradientMatrix()
and verticalGradientMatrix()
.
Therefore, you should pass the resulting Matrix
to drawRoundRect()
before calling
horizontalGradientMatrix()
or verticalGradientMatrix()
again.
x:Number — The left coordinate of the gradient, in pixels.
|
|
y:Number — The top coordinate of the gradient, in pixels.
|
|
width:Number — The width of the gradient, in pixels.
|
|
height:Number — The height of the gradient, in pixels.
|
Matrix — The Matrix for the horizontal gradient.
|
initializationComplete | () | method |
protected function initializationComplete():void
Finalizes the initialization of this component.
This method is the last code that executes when you add a component
to a parent for the first time using addChild()
or addChildAt()
.
It handles some housekeeping related to dispatching
the initialize
event.
If you are writing a component, you should not need
to override this method.
initialize | () | method |
public function initialize():void
Initializes the internal structure of this component.
Initializing a UIComponent is the fourth step in the creation
of a visual component instance, and happens automatically
the first time that the instance is added to a parent.
Therefore, you do not generally need to call
initialize()
; the Flex framework calls it for you
from UIComponent's override of the addChild()
and addChildAt()
methods.
The first step in the creation of a visual component instance
is construction, with the new
operator:
var okButton:Button = new Button();
After construction, the new Button instance is a solitary DisplayObject; it does not yet have a UITextField as a child to display its label, and it doesn't have a parent.
The second step is configuring the newly-constructed instance with the appropriate properties, styles, and event handlers:
okButton.label = "OK"; okButton.setStyle("cornerRadius", 0); okButton.addEventListener(MouseEvent.CLICK, clickHandler);
The third step is adding the instance to a parent:
someContainer.addChild(okButton);
A side effect of calling addChild()
or addChildAt()
, when adding a component to a parent
for the first time, is that initialize
gets
automatically called.
This method first dispatches a preinitialize
event,
giving developers using this component a chance to affect it
before its internal structure has been created.
Next it calls the createChildren()
method
to create the component's internal structure; for a Button,
this method creates and adds the UITextField for the label.
Then it dispatches an initialize
event,
giving developers a chance to affect the component
after its internal structure has been created.
Note that it is the act of attaching a component to a parent for the first time that triggers the creation of its internal structure. If its internal structure includes other UIComponents, then this is a recursive process in which the tree of DisplayObjects grows by one leaf node at a time.
If you are writing a component, you should not need to override this method.
initializeAccessibility | () | method |
protected function initializeAccessibility():void
Initializes this component's accessibility code.
This method is called by the initialize()
method to hook in the
component's accessibility code, which resides in a separate class
in the mx.accessibility package.
Each subclass that supports accessibility must override this method
because the hook-in process uses a different static variable
in each subclass.
initializeRepeaterArrays | () | method |
public function initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances of this component.
An MXML <mx:Repeater/>
tag can cause repeated instances
of a component to be created, one instance for each item in the
Repeater's data provider.
The instanceIndices
, repeaters
,
and repeaterIndices
properties of UIComponent
keep track of which instance came from which data item
and which Repeater.
This method is an internal method which is automatically called by the Flex framework. You should not have to call it or override it.
Parametersparent:IRepeaterClient — The parent object containing the Repeater that created
this component.
|
invalidateDisplayList | () | method |
public function invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the width and height, it would be wasteful to update the component immediately after you change the width and then update again with the new height. It is more efficient to change both properties and then render the component with its new size once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
invalidateProperties | () | method |
public function invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text color and size, it would be wasteful to update the color immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size and color once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
invalidateSize | () | method |
public function invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text and font size, it would be wasteful to update the text immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
isOurFocus | () | method |
protected function isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
Parameterstarget:DisplayObject — A UIComponent object containing a UITextField object
that can receive focus.
|
Boolean — Returns true if the UITextField object has focus.
|
keyDownHandler | () | method |
protected function keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown
event.
If you override this method, make sure to call the base class version.
event:KeyboardEvent — The event object.
|
keyUpHandler | () | method |
protected function keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp
event.
If you override this method, make sure to call the base class version.
event:KeyboardEvent — The event object.
|
localToContent | () | method |
public function localToContent(point:Point):Point
Converts a Point
object from local to content coordinates.
Local coordinates specify a pixel position relative to the
upper left corner of the component.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
point:Point — A Point object that specifies the x and y
coordinates in the local coordinate system as properties.
|
Point — Point A Point object with coordinates relative to the
content coordinate system.
|
See also
measure | () | method |
protected function measure():void
Calculates the default size, and optionally the default minimum size, of the component. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
measure()
method when the component is added to a container
using the addChild()
method, and when the component's
invalidateSize()
method is called.
When you set a specific height and width of a component,
Flex does not call the measure()
method,
even if you explicitly call the invalidateSize()
method.
That is, Flex only calls the measure()
method if
the explicitWidth
property or the explicitHeight
property of the component is NaN.
In your override of this method, you must set the
measuredWidth
and measuredHeight
properties
to define the default size.
You may optionally set the measuredMinWidth
and
measuredMinHeight
properties to define the default
minimum size.
Most components calculate these values based on the content they are displaying, and from the properties that affect content display. A few components simply have hard-coded default values.
The conceptual point of measure()
is for the component to provide
its own natural or intrinsic size as a default. Therefore, the
measuredWidth
and measuredHeight
properties
should be determined by factors such as:
fontSize
, for that text.In some cases, there is no intrinsic way to determine default values.
For example, a simple GreenCircle component might simply set
measuredWidth = 100 and measuredHeight = 100 in its measure()
method to
provide a reasonable default size. In other cases, such as a TextArea,
an appropriate computation (such as finding the right width and height
that would just display all the text and have the aspect ratio of a Golden Rectangle)
might be too time-consuming to be worthwhile.
The default implementation of measure()
sets measuredWidth
, measuredHeight
,
measuredMinWidth
, and measuredMinHeight
to 0
.
measureHTMLText | () | method |
public function measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as <font>
and <b>
,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
htmlText:String — A String specifying the HTML text to measure.
|
TextLineMetrics — A TextLineMetrics object containing the text measurements.
|
measureText | () | method |
public function measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
Parameterstext:String — A String specifying the text to measure.
|
TextLineMetrics — A TextLineMetrics object containing the text measurements.
|
move | () | method |
public function move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
Calling this method is exactly the same as
setting the component's x
and y
properties.
If you are overriding the updateDisplayList()
method
in a custom component, you should call the move()
method
rather than setting the x
and y
properties.
The difference is that the move()
method changes the location
of the component and then dispatches a move
event when you
call the method, while setting the x
and y
properties changes the location of the component and dispatches
the event on the next screen refresh.
x:Number — Left position of the component within its parent.
|
|
y:Number — Top position of the component within its parent.
|
move_unprotected | () | method |
public function move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
Parametersx:Number |
|
y:Number |
notifyStyleChangeInChildren | () | method |
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. You typically never need to call this method.
ParametersstyleProp:String — String specifying the name of the style property.
|
|
recursive:Boolean — Recursivly notify all children of this component.
|
owns | () | method |
public function owns(child:DisplayObject):Boolean
Returns true
if the chain of owner
properties
points from child
to this UIComponent.
child:DisplayObject — A UIComponent.
|
Boolean — true if the child is parented or owned by this UIComponent.
|
parentChanged | () | method |
public function parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. Developers typically never need to call this method.
Parametersp:DisplayObjectContainer — The parent of this UIComponent object.
|
prepareToPrint | () | method |
public function prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. For the UIComponent class, the method performs no action. Flex containers override the method to prepare for printing; for example, by removing scroll bars from the printed output.
This method is normally not used by application developers.
Parameterstarget:IFlexDisplayObject — The component to be printed.
It may be the current component or one of its children.
|
Object — Object containing the properties of the current component
required by the finishPrint() method
to restore it to its previous state.
|
See also
regenerateStyleCache | () | method |
public function 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.
The Flex framework calls this method in the following situations:
addChild()
or addChildAt()
methods.styleName
property
of a UIComponent.setStyle()
method of CSSStyleDeclaration.Building the style cache is a computation-intensive operation,
so you should avoid changing styleName
or
setting selector styles unnecessarily.
This method is not called when you set an instance style
by calling the setStyle()
method of UIComponent.
Setting an instance style is a relatively fast operation
compared with setting a selector style.
You should not need to call or override this method.
Parametersrecursive:Boolean — Recursivly regenerates the style cache for
all children of this component.
|
registerEffects | () | method |
public function registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners. You typically never need to call this method.
Parameterseffects:Array — The names of the effect events.
|
replayAutomatableEvent | () | method |
public function replayAutomatableEvent(event:Event):Boolean
Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.
Parametersevent:Event — The event to replay.
|
Boolean — true if a replay was successful.
|
resolveAutomationIDPart | () | method |
public function resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. The id is a set
of properties as provided by the createAutomationIDPart()
method.
criteria:Object — Set of properties describing the child.
The criteria can contain regular expression values
resulting in multiple children being matched.
|
Array — Array of children that matched the criteria
or null if no children could not be resolved.
|
resourcesChanged | () | method |
protected function 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.
This event will be dispatched when you set the ResourceManager's
localeChain
property, when a resource module
has finished loading, and when you call the ResourceManager's
update()
method.
Subclasses should override this method and, after calling
super.resourcesChanged()
, do whatever is appropriate
in response to having new resource values.
resumeBackgroundProcessing | () | method |
public static function resumeBackgroundProcessing():void
Resumes the background processing of methods
queued by callLater()
, after a call to
suspendBackgroundProcessing()
.
Refer to the description of
suspendBackgroundProcessing()
for more information.
setActualSize | () | method |
public function setActualSize(w:Number, h:Number):void
Sizes the object.
Unlike directly setting the width
and height
properties, calling the setActualSize()
method
does not set the explictWidth
and
explicitHeight
properties, so a future layout
calculation may result in the object returning to its previous size.
This method is used primarily by component developers implementing
the updateDisplayList()
method, by Effects,
and by the LayoutManager.
w:Number — Width of the object.
|
|
h:Number — Height of the object.
|
setActualSize_unprotected | () | method |
public function setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
Parametersw:Number |
|
h:Number |
setConstraintValue | () | method |
public function setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
ParametersconstraintName:String |
|
value:* |
setCurrentState | () | method |
public function setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
ParametersstateName:String — The name of the new view state.
|
|
playTransition:Boolean (default = true ) — If true , play
the appropriate transition when the view state changes.
|
See also
setFocus | () | method |
public function setFocus():void
Sets the focus to this component. The component may in turn pass focus to a subcomponent.
Note: Only the TextInput and TextArea controls show a highlight when this method sets the focus. All controls show a highlight when the user tabs to the control.
setStyle | () | method |
public function setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
This may override a style that was set globally.
Calling the setStyle()
method can result in decreased performance.
Use it only when necessary.
styleProp:String — Name of the style property.
|
|
newValue:* — New value for the style.
|
setVisible | () | method |
public function setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible
property changes.
You should set the visible
property to show or hide
a component instead of calling this method directly.
value:Boolean — The new value of the visible property.
Specify true to show the component, and false to hide it.
|
|
noEvent:Boolean (default = false ) — If true , do not dispatch an event.
If false , dispatch a show event when
the component becomes visible, and a hide event when
the component becomes invisible.
|
setVisible_unprotected | () | method |
public function setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
Parametersvalue:Boolean |
|
noEvent:Boolean (default = false )
|
styleChanged | () | method |
public function styleChanged(styleProp:String):void
Detects changes to style properties. When any style property is set,
Flex calls the styleChanged()
method,
passing to it the name of the style being set.
This is an advanced method that you might override
when creating a subclass of UIComponent. When you create a custom component,
you can override the styleChanged()
method
to check the style name passed to it, and handle the change accordingly.
This lets you override the default behavior of an existing style,
or add your own custom style properties.
If you handle the style property, your override of
the styleChanged()
method should call the
invalidateDisplayList()
method to cause Flex to execute
the component's updateDisplayList()
method at the next screen update.
styleProp:String — The name of the style property, or null if all styles for this
component have changed.
|
stylesInitialized | () | method |
public function stylesInitialized():void
Flex calls the stylesInitialized()
method when
the styles for a component are first initialized.
This is an advanced method that you might override
when creating a subclass of UIComponent. Flex guarantees that
your component's styles will be fully initialized before
the first time your component's measure
and
updateDisplayList
methods are called. For most
components, that is sufficient. But if you need early access to
your style values, you can override the stylesInitialized() function
to access style properties as soon as they are initialized the first time.
suspendBackgroundProcessing | () | method |
public static function suspendBackgroundProcessing():void
Blocks the background processing of methods
queued by callLater()
,
until resumeBackgroundProcessing()
is called.
These methods can be useful when you have time-critical code
which needs to execute without interruption.
For example, when you set the suspendBackgroundProcessing
property of an Effect to true
,
suspendBackgroundProcessing()
is automatically called
when it starts playing, and resumeBackgroundProcessing
is called when it stops, in order to ensure that the animation
is smooth.
Since the LayoutManager uses callLater()
,
this means that commitProperties()
,
measure()
, and updateDisplayList()
will not get called in between calls to
suspendBackgroundProcessing()
and
resumeBackgroundProcessing()
.
It is safe for both an outer method and an inner method
(i.e., one that the outer methods calls) to call
suspendBackgroundProcessing()
and resumeBackgroundProcessing()
, because these
methods actually increment and decrement a counter
which determines whether background processing occurs.
updateDisplayList | () | method |
protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
updateDisplayList()
method when the component is added to a container
using the addChild()
method, and when the component's
invalidateDisplayList()
method is called.
If the component has no children, this method
is where you would do programmatic drawing
using methods on the component's Graphics object
such as graphics.drawRect()
.
If the component has children, this method is where
you would call the move()
and setActualSize()
methods on its children.
Components may do programmatic drawing even if
they have children. In doing either, you should use the
component's unscaledWidth
and unscaledHeight
as its bounds.
It is important to use unscaledWidth
and
unscaledHeight
instead of the width
and height
properties.
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.
|
validateDisplayList | () | method |
public function validateDisplayList():void
Validates the position and size of children and draws other
visuals.
If the LayoutManager.invalidateDisplayList()
method is called with
this ILayoutManagerClient, then the validateDisplayList()
method
is called when it's time to update the display list.
validateNow | () | method |
public function validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
Processing properties that require substantial computation are normally
not processed until the script finishes executing.
For example setting the width
property is delayed, because it may
require recalculating the widths of the objects children or its parent.
Delaying the processing prevents it from being repeated
multiple times if the script sets the width
property more than once.
This method lets you manually override this behavior.
validateProperties | () | method |
public function validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties()
method.
In general, subclassers should
override the commitProperties()
method and not this method.
validateSize | () | method |
public function 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.
recursive:Boolean (default = false ) — If true , call this method
on the objects children.
|
validationResultHandler | () | method |
public function validationResultHandler(event:ValidationResultEvent):void
Handles both the valid
and invalid
events from a
validator assigned to this component.
You typically handle the valid
and invalid
events
dispatched by a validator by assigning event listeners to the validators.
If you want to handle validation events directly in the component that is being validated,
you can override this method to handle the valid
and invalid
events. You typically call
super.validationResultHandler(event)
in your override.
event:ValidationResultEvent — The event object for the validation.
|
See also
verticalGradientMatrix | () | method |
public function 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.
For performance reasons, the Matrix is stored in a static variable
which is reused by all calls to horizontalGradientMatrix()
and verticalGradientMatrix()
.
Therefore, you should pass the resulting Matrix
to drawRoundRect()
before calling
horizontalGradientMatrix()
or verticalGradientMatrix()
again.
x:Number — The left coordinate of the gradient, in pixels.
|
|
y:Number — The top coordinate of the gradient, in pixels.
|
|
width:Number — The width of the gradient, in pixels.
|
|
height:Number — The height of the gradient, in pixels.
|
Matrix — The Matrix for the vertical gradient.
|
add | event |
mx.events.FlexEvent
mx.events.FlexEvent.ADD
Dispatched when the component is added to a container as a content child
by using the addChild()
or addChildAt()
method.
If the component is added to the container as a noncontent child by
using the rawChildren.addChild()
or
rawChildren.addChildAt()
method, the event is not dispatched.
The FlexEvent.ADD
constant defines the value of the
type
property of the event object for an add
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 . |
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. |
creationComplete | event |
mx.events.FlexEvent
mx.events.FlexEvent.CREATION_COMPLETE
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.
At this point, depending on its visible
property,
the component may not be visible even though it has been drawn.
The FlexEvent.CREATION_COMPLETE
constant defines the value of the
type
property of the event object for a creationComplete
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 . |
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. |
currentStateChange | event |
mx.events.StateChangeEvent
mx.events.StateChangeEvent.CURRENT_STATE_CHANGE
Dispatched after the view state has changed.
The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the
value of the type
property of the event that is dispatched
when the view state has changed.
The value of this constant is "currentStateChange".
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 . |
newState | The name of the view state that was entered. |
oldState | The name of the view state that was exited. |
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 | StateChangeEvent.CURRENT_STATE_CHANGE |
currentStateChanging | event |
mx.events.StateChangeEvent
mx.events.StateChangeEvent.CURRENT_STATE_CHANGING
Dispatched after the currentState
property changes,
but before the view state changes.
The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the
value of the type
property of the event that is dispatched
when the view state is about to change.
The value of this constant is "currentStateChanging".
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 . |
newState | The name of the view state that is being entered. |
oldState | The name of the view state that is being exited. |
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 | StateChangeEvent.CURRENT_STATE_CHANGING |
dragComplete | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_COMPLETE
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.
You can use this event to perform any final cleanup of the drag-and-drop operation. For example, if you drag a List control item from one list to another, you can delete the List control item from the source if you no longer need it.
If you call Event.preventDefault()
in the event handler
for the dragComplete
event for
a Tree control when dragging data from one Tree control to another,
it prevents the drop.
The DragEvent.DRAG_COMPLETE
constant defines the value of the
type
property of the event object for a dragComplete
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
dragDrop | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_DROP
Dispatched by the drop target when the user releases the mouse over it.
You use this event handler to add the drag data to the drop target.
If you call Event.preventDefault()
in the event handler
for the dragDrop
event for
a Tree control when dragging data from one Tree control to another,
it prevents the drop.
The DragEvent.DRAG_DROP
constant defines the value of the
type
property of the event object for a dragDrop
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
dragEnter | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_ENTER
Dispatched by a component when the user moves the mouse over the component during a drag operation. In an application running in Flash Player, the event is dispatched many times when you move the mouse over any component. In an application running in AIR, the event is dispatched only once.
In order to be a valid drop target, you must define a handler for this event. In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.
If you want to accept the drag, you must call the
DragManager.acceptDragDrop()
method. If you don't
call acceptDragDrop()
, you will not get any of the
other drag events.
In Flash Player, the value of the action
property is always
DragManager.MOVE
, even if you are doing a copy.
This is because the dragEnter
event occurs before
the control recognizes that the Control key is pressed to signal a copy.
The action
property of the event object for the
dragOver
event does contain a value that signifies the type of
drag operation. You may change the type of drag action by calling the
DragManager.showFeedback()
method.
In AIR, the default value of the action
property is
DragManager.COPY
.
Because of the way data to a Tree control is structured,
the Tree control handles drag and drop differently from the other list-based controls.
For the Tree control, the event handler for the dragDrop
event
only performs an action when you move or copy data in the same Tree control,
or copy data to another Tree control.
If you drag data from one Tree control and drop it onto another Tree control
to move the data, the event handler for the dragComplete
event
actually performs the work to add the data to the destination Tree control,
rather than the event handler for the dragDrop event,
and also removes the data from the source Tree control.
This is necessary because to reparent the data being moved,
Flex must remove it first from the source Tree control.
The DragEvent.DRAG_ENTER
constant defines the value of the
type
property of the event object for a dragEnter
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event, which is always
DragManager.MOVE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
See also
dragExit | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_EXIT
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.
You use this event to restore the drop target to its normal appearance
if you modified its appearance as part of handling the
dragEnter
or dragOver
event.
The DragEvent.DRAG_EXIT
constant defines the value of the
type
property of the event object for a dragExit
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
dragOver | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_OVER
Dispatched by a component when the user moves the mouse while over the component during a drag operation. In Flash Player, the event is dispatched when you drag an item over a valid drop target. In AIR, the event is dispatched when you drag an item over any component, even if the component is not a valid drop target.
In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.
You should handle this event to perform additional logic before allowing the drop, such as dropping data to various locations in the drop target, reading keyboard input to determine if the drag-and-drop action is a move or copy of the drag data, or providing different types of visual feedback based on the type of drag-and-drop action.
You may also change the type of drag action by changing the
DragManager.showFeedback()
method.
The default value of the action
property is
DragManager.MOVE
.
The DragEvent.DRAG_OVER
constant defines the value of the
type
property of the event object for a dragOver
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
See also
dragStart | event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_START
Dispatched by the drag initiator when starting a drag operation.
This event is used internally by the list-based controls;
you do not handle it when implementing drag and drop.
If you want to control the start of a drag-and-drop operation,
use the mouseDown
or mouseMove
event.
The DragEvent.DRAG_START constant defines the value of the
type
property of the event object for a dragStart
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
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 . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
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. |
effectEnd | event |
mx.events.EffectEvent
mx.events.EffectEvent.EFFECT_END
Dispatched after an effect ends.
The effect will have made the last set of visual changes
before this event is fired, but those changes will not have
been rendered on the screen.
Thus, you might have to use the callLater()
method
to delay any other changes that you want to make until after the
changes have been rendered onscreen.
The EffectEvent.EFFECT_END
constant defines the value of the
type
property of the event object for an
effectEnd
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 . |
effectInstance | The effect instance object for the event. |
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. |
effectStart | event |
mx.events.EffectEvent
mx.events.EffectEvent.EFFECT_START
Dispatched just before an effect starts.
The effect does not start changing any visuals until after this event is fired.
The EffectEvent.EFFECT_START
constant defines the value of the
type
property of the event object for an
effectStart
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 . |
effectInstance | The effect instance object for the event. |
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. |
enterState | event |
mx.events.FlexEvent
mx.events.FlexEvent.ENTER_STATE
Dispatched after the component has returned to the root view state.
The FlexEvent.ENTER_STATE
constant defines the value of the
type
property of the event object for a enterState
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 . |
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. |
exitState | event |
mx.events.FlexEvent
mx.events.FlexEvent.EXIT_STATE
Dispatched before the component exits from the root view state.
The FlexEvent.EXIT_STATE
constant defines the value of the
type
property of the event object for a exitState
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 . |
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. |
hide | event |
mx.events.FlexEvent
mx.events.FlexEvent.HIDE
Dispatched when an object's state changes from visible to invisible.
The FlexEvent.HIDE
constant defines the value of the
type
property of the event object for a hide
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 . |
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. |
initialize | event |
mx.events.FlexEvent
mx.events.FlexEvent.INITIALIZE
Dispatched when the component has finished its construction and has all initialization properties set.
After the initialization phase, properties are processed, the component
is measured, laid out, and drawn, after which the
creationComplete
event is dispatched.
The FlexEvent.INITIALIZE
constant defines the value of the
type
property of the event object for a initialize
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 . |
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. |
invalid | event |
mx.events.FlexEvent
mx.events.FlexEvent.INVALID
Dispatched when a component is monitored by a Validator and the validation failed.
The FlexEvent.INVALID
constant defines the value of the
type
property of the event object for a invalid
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 . |
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. |
mouseDownOutside | event |
mx.events.FlexMouseEvent
mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE
Dispatched from a component opened using the PopUpManager when the user clicks outside it.
The FlexMouseEvent.MOUSE_DOWN_OUTSIDE
constant defines the value of the
type
property of the event object for a mouseDownOutside
event.
The properties of the event object have the following values:
Property | Value |
---|---|
altKey |
Indicates whether the Alt key is down
(true ) or not (false ). |
bubbles | false |
buttonDown |
Indicates whether the main mouse button is down
(true ) or not (false ). |
cancelable | false |
ctrlKey |
Indicates whether the Control key is down
(true ) or not (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 .
For PopUpManager events, the object is the pop-up window. |
delta |
Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0. |
localX |
The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
localY |
The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
relatedObject |
A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located. |
shiftKey |
Indicates whether the Shift key is down
(true ) or not (false ). |
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.
For PopUpManager events, the object is the pop-up window. |
mouseWheelOutside | event |
mx.events.FlexMouseEvent
mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.
The FlexMouseEvent.MOUSE_WHEEL_OUTSIDE
constant defines the value of the
type
property of the event object for a mouseWheelOutside
event.
The properties of the event object have the following values:
Property | Value |
---|---|
altKey |
Indicates whether the Alt key is down
(true ) or not (false ). |
bubbles | false |
buttonDown |
Indicates whether the main mouse button is down
(true ) or not (false ). |
cancelable | false |
ctrlKey |
Indicates whether the Control key is down
(true ) or not (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 .
For PopUpManager events, the object is the pop-up window. |
delta |
Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0. |
localX |
The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
localY |
The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
relatedObject |
A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located. |
shiftKey |
Indicates whether the Shift key is down
(true ) or not (false ). |
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.
For PopUpManager events, the object is the pop-up window. |
move | event |
mx.events.MoveEvent
mx.events.MoveEvent.MOVE
Dispatched when the object has moved.
You can move the component by setting the x
or y
properties, by calling the move()
method, by setting one
of the following properties either on the component or on other
components such that the LayoutManager needs to change the
x
or y
properties of the component:
minWidth
minHeight
maxWidth
maxHeight
explicitWidth
explicitHeight
When you call the move()
method, the move
event is dispatched before the method returns.
In all other situations, the move
event is not dispatched
until after the property changes.
The MoveEvent.MOVE
constant defines the value of the
type
property of the event object for a move
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 . |
oldX | The previous x coordinate of the object, in pixels. |
oldY | The previous y coordinate of the object, in pixels. |
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. |
preinitialize | event |
mx.events.FlexEvent
mx.events.FlexEvent.PREINITIALIZE
Dispatched at the beginning of the component initialization sequence.
The component is in a very raw state when this event is dispatched.
Many components, such as the Button control, create internal child
components to implement functionality; for example, the Button control
creates an internal UITextField component to represent its label text.
When Flex dispatches the preinitialize
event,
the children, including the internal children, of a component
have not yet been created.
The FlexEvent.PREINITIALIZE
constant defines the value of the
type
property of the event object for a preinitialize
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 . |
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. |
protection_hide | event |
mx.events.DynamicEvent
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.
protection_move | event |
mx.events.DynamicEvent
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.
Includes properties newX
and newY
which can be used to perform
the movement by some other means.
protection_show | event |
mx.events.DynamicEvent
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.
protection_size | event |
mx.events.DynamicEvent
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.
Includes properties newW
and newW
which can be used to perform
the resize by some other means.
remove | event |
mx.events.FlexEvent
mx.events.FlexEvent.REMOVE
Dispatched when the component is removed from a container as a content child
by using the removeChild()
or removeChildAt()
method.
If the component is removed from the container as a noncontent child by
using the rawChildren.removeChild()
or
rawChildren.removeChildAt()
method, the event is not dispatched.
The FlexEvent.REMOVE
constant defines the value of the
type
property of the event object for an remove
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 . |
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. |
resize | event |
mx.events.ResizeEvent
mx.events.ResizeEvent.RESIZE
Dispatched when the component is resized.
You can resize the component by setting the width
or
height
property, by calling the setActualSize()
method, or by setting one of
the following properties either on the component or on other components
such that the LayoutManager needs to change the width
or
height
properties of the component:
minWidth
minHeight
maxWidth
maxHeight
explicitWidth
explicitHeight
The resize
event is not
dispatched until after the property changes.
The ResizeEvent.RESIZE
constant defines the value of the
type
property of the event object for a resize
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 . |
oldHeight | The previous height of the object, in pixels. |
oldWidth | The previous width of the object, in pixels. |
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. |
show | event |
mx.events.FlexEvent
mx.events.FlexEvent.SHOW
Dispatched when an object's state changes from invisible to visible.
The FlexEvent.SHOW
constant defines the value of the
type
property of the event object for a show
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 . |
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. |
toolTipCreate | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_CREATE
Dispatched by the component when it is time to create a ToolTip.
If you create your own IToolTip object and place a reference
to it in the toolTip
property of the event object
that is passed to your toolTipCreate
handler,
the ToolTipManager displays your custom ToolTip.
Otherwise, the ToolTipManager creates an instance of
ToolTipManager.toolTipClass
to display.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_CREATE
constant defines the value of the
type
property of the event object for a toolTipCreate
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
toolTipEnd | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_END
Dispatched by the component when its ToolTip has been hidden and will be discarded soon.
If you specify an effect using the
ToolTipManager.hideEffect
property,
this event is dispatched after the effect stops playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_END
constant defines the value of the
type
property of the event object for a toolTipEnd
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
toolTipHide | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_HIDE
Dispatched by the component when its ToolTip is about to be hidden.
If you specify an effect using the
ToolTipManager.hideEffect
property,
this event is dispatched before the effect starts playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_HIDE
constant defines the value of the
type
property of the event object for a toolTipHide
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
toolTipShow | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_SHOW
Dispatched by the component when its ToolTip is about to be shown.
If you specify an effect using the
ToolTipManager.showEffect
property,
this event is dispatched before the effect starts playing.
You can use this event to modify the ToolTip before it appears.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_SHOW
constant defines the value of the
type
property of the event object for a toolTipShow
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
toolTipShown | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_SHOWN
Dispatched by the component when its ToolTip has been shown.
If you specify an effect using the
ToolTipManager.showEffect
property,
this event is dispatched after the effect stops playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_SHOWN
constant defines the value of the
type
property of the event object for a toolTipShown
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
toolTipStart | event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_START
Dispatched by a component whose toolTip
property is set,
as soon as the user moves the mouse over it.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
The ToolTipEvent.TOOL_TIP_START
constant defines the value of the
type
property of the event object for a toolTipStart
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 . |
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. |
tooltip | The ToolTip object to which this event applies. |
updateComplete | event |
mx.events.FlexEvent
mx.events.FlexEvent.UPDATE_COMPLETE
Dispatched when an object has had its commitProperties()
,
measure()
, and
updateDisplayList()
methods called (if needed).
This is the last opportunity to alter the component before it is displayed. All properties have been committed and the component has been measured and layed out.
The FlexEvent.UPDATE_COMPLETE
constant defines the value of the
type
property of the event object for a updateComplete
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 . |
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. |
valid | event |
mx.events.FlexEvent
mx.events.FlexEvent.VALID
Dispatched when a component is monitored by a Validator and the validation succeeded.
The FlexEvent.VALID
constant defines the value of the
type
property of the event object for a valid
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 . |
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. |
valueCommit | event |
mx.events.FlexEvent
mx.events.FlexEvent.VALUE_COMMIT
Dispatched when values are changed programmatically or by user interaction.
Because a programmatic change triggers this event, make sure
that any valueCommit
event handler does not change
a value that causes another valueCommit
event.
For example, do not change a control's dataProvider
property in a valueCommit
event handler.
The FlexEvent.VALUE_COMMIT
constant defines the value of the
type
property of the event object for a valueCommit
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 . |
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. |
DEFAULT_MAX_HEIGHT | constant |
public static const DEFAULT_MAX_HEIGHT:Number = 10000
The default value for the maxHeight
property.
The default value is 10000
.
DEFAULT_MAX_WIDTH | constant |
public static const DEFAULT_MAX_WIDTH:Number = 10000
The default value for the maxWidth
property.
The default value is 10000
.
DEFAULT_MEASURED_HEIGHT | constant |
public static const DEFAULT_MEASURED_HEIGHT:Number = 22
The default value for the measuredHeight
property.
Most components calculate a measuredHeight but some are flow-based and
have to pick a number that looks reasonable.
The default value is 22
.
DEFAULT_MEASURED_MIN_HEIGHT | constant |
public static const DEFAULT_MEASURED_MIN_HEIGHT:Number = 22
The default value for the measuredMinHeight
property.
Most components calculate a measuredMinHeight but some are flow-based and
have to pick a number that looks reasonable.
The default value is 22
.
DEFAULT_MEASURED_MIN_WIDTH | constant |
public static const DEFAULT_MEASURED_MIN_WIDTH:Number = 40
The default value for the measuredMinWidth
property.
Most components calculate a measuredMinWidth but some are flow-based and
have to pick a number that looks reasonable.
The default value is 40
.
DEFAULT_MEASURED_WIDTH | constant |
public static const DEFAULT_MEASURED_WIDTH:Number = 160
The default value for the measuredWidth
property.
Most components calculate a measuredWidth but some are flow-based and
have to pick a number that looks reasonable.
The default value is 160
.