| Package | mx.controls |
| Class | public class PopUpButton |
| Inheritance | PopUpButton Button UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | PopUpMenuButton |
A PopUpButton control can have a text label, an icon,
or both on its face.
When a user clicks the main part of the PopUpButton
control, it dispatches a click event.
One common use for the PopUpButton control is to have the pop-up button open a List control or a Menu control that changes the function and label of the main button.
MXML Syntax
Hide MXML Syntax
The <mx:PopUpButton> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<mx:PopUpButton
Properties openAlways="false|true popUp="No default" Styles arrowButtonWidth="16" closeDuration="250" closeEasingFunction="No default" openDuration="250" openEasingFunction="No default" popUpDownSkin="popUpDownSkin" popUpGap="0" popUpIcon="PopUpIcon" popUpOverSkin="popUpOverSkin" Events close="No default" open="No default" />
See also
| Property | Defined by | ||
|---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
![]() | alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
![]() | autoRepeat : Boolean
Specifies whether to dispatch repeated
buttonDown
events if the user holds down the mouse button. | Button | |
![]() | baselinePosition : Number
Determines the baseline y-coordinate
of the first line of text of the component.
| UIComponent | |
![]() | blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
![]() | buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
![]() | cacheAsBitmap : Boolean
If set to
true, Flash Player caches an internal bitmap representation of the
display object. | DisplayObject | |
![]() | cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
![]() | cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
![]() | className : String
The name of this instance's class, such as
"Button". | UIComponent | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contextMenu : ContextMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
![]() | currentState : String
The current view state of the component.
| UIComponent | |
![]() | data : Object
The
data property lets you pass a value
to the component when you use it as an item renderer or item editor. | Button | |
![]() | 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 | |
![]() | dropTarget : DisplayObject
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
![]() | emphasized : Boolean
Draws a thick border around the Button control
when the control is in its up state if
emphasized
is set to true. | Button | |
![]() | 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 | |
![]() | filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
![]() | focusEnabled : Boolean
Indicates whether the component can receive focus when clicked on.
| 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 | |
![]() | focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
![]() | graphics : Graphics
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
![]() | height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
![]() | hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
![]() | 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
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
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 | |
![]() | label : String
Text to appear on the Button control.
| Button | |
![]() | labelPlacement : String
Orientation of the label in relation to a specified icon.
| Button | |
![]() | listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the
listData property
of the component with the appropriate data from the list control. | Button | |
![]() | loaderInfo : LoaderInfo
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
![]() | mask : DisplayObject
The calling display object is masked by the specified
mask object. | DisplayObject | |
![]() | 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 | |
![]() | mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
![]() | mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
![]() | mouseX : Number
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | mouseY : Number
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
![]() | 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 | |
![]() | numChildren : int
Returns the number of children of this object.
| DisplayObjectContainer | |
![]() | opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| openAlways : Boolean
If
true, specifies to pop up the
popUp when you click the main button. | PopUpButton | ||
![]() | owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
![]() | parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
![]() | parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
![]() | parentDocument : Object
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 | |
| popUp : IUIComponent
Specifies the UIComponent object, or object defined by a subclass
of UIComponent, to pop up.
| PopUpButton | ||
![]() | processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
![]() | repeaterIndex : int
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 | |
![]() | root : DisplayObject
For a display object in a loaded SWF file, the
root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
![]() | scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
![]() | scaleY : Number
Number that specifies the vertical scaling percentage.
| UIComponent | |
![]() | screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
![]() | scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
![]() | selected : Boolean
Indicates whether a toggle button is toggled
on (
true) or off (false). | Button | |
![]() | selectedField : String = "null"
The name of the field in the
data property which specifies
the value of the Button control's selected property. | Button | |
![]() | soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
![]() | stage : Stage
The Stage of the display object.
| DisplayObject | |
![]() | states : Array
The view states that are defined for this component.
| UIComponent | |
![]() | stickyHighlighting : Boolean = false
If
false, the Button displays its down skin
when the user presses it but changes to its over skin when
the user drags the mouse off of it. | Button | |
![]() | 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 | |
![]() | tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
![]() | tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
![]() | textSnapshot : TextSnapshot
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() | toolTip : String
Text to display in the ToolTip.
| UIComponent | |
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
![]() | 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 | |
![]() | useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the
buttonMode property is set to true. | Sprite | |
![]() | validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
![]() | visible : Boolean
Controls the visibility of this UIComponent.
| 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 | |
![]() | y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| PopUpButton | ||
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
![]() |
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
![]() |
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the
DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
![]() |
Queues a function to be called later.
| UIComponent | |
![]() |
Deletes a style property from this component instance.
| UIComponent | |
|
Closes the UIComponent object opened by the PopUpButton control.
| PopUpButton | ||
![]() |
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
![]() |
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
![]() |
Converts a
Point object from content to local coordinates. | UIComponent | |
![]() |
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
![]() |
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 | |
![]() |
Dispatches an event into the event flow.
| EventDispatcher | |
![]() |
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 | |
![]() |
Called by the effect instance when it stops playing on the component.
| UIComponent | |
![]() |
Called by the effect instance when it starts playing on the component.
| UIComponent | |
![]() |
Ends all currently playing effects on the component.
| UIComponent | |
![]() |
Executes the data bindings into this UIComponent object.
| UIComponent | |
![]() |
Called after printing is complete.
| UIComponent | |
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
![]() |
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
![]() |
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
![]() |
Returns the index position of a
child DisplayObject instance. | DisplayObjectContainer | |
![]() |
Finds the type selectors for this UIComponent instance.
| UIComponent | |
![]() |
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
![]() |
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
![]() |
Gets the object that currently has focus.
| UIComponent | |
![]() |
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the
targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
![]() |
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 | |
![]() |
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
![]() |
Converts a
Point object from global to content coordinates. | UIComponent | |
![]() |
Converts the
point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
obj display object. | DisplayObject | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
point specified by the
x and y parameters. | DisplayObject | |
![]() |
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
![]() |
Initializes the internal structure of this component.
| UIComponent | |
![]() |
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
![]() |
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
![]() |
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
![]() |
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Converts a
Point object from local to content coordinates. | UIComponent | |
![]() |
Converts the
point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
![]() |
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 | |
![]() |
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 | |
![]() |
Moves the component to a specified position within its parent.
| UIComponent | |
![]() |
Propagate style changes to the children.
| UIComponent | |
|
Opens the UIComponent object specified by the
popUp property. | PopUpButton | ||
![]() |
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
![]() |
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
![]() |
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
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 | |
![]() |
For each effect event, register the EffectManager
as one of the event listeners.
| UIComponent | |
![]() |
Removes the specified
child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
![]() |
Removes a child DisplayObject from the specified
index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
![]() |
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
![]() |
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
![]() |
Sizes the object.
| UIComponent | |
![]() |
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
![]() |
Set the current state.
| UIComponent | |
![]() |
Sets the focus to this component.
| UIComponent | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Sets a style property on this component instance.
| UIComponent | |
![]() |
Called when the
visible property changes. | UIComponent | |
![]() |
Lets the user drag the specified sprite.
| Sprite | |
![]() |
Ends the
startDrag() method. | Sprite | |
![]() |
Detects changes to style properties.
| UIComponent | |
![]() |
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
![]() |
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
![]() |
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
![]() |
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
![]() |
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
![]() |
Validates the position and size of children and draws other
visuals.
| UIComponent | |
![]() |
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
![]() |
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
![]() |
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 | |
![]() |
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
![]() |
Returns the primitive value of the specified object.
| Object | |
![]() |
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
![]() | Dispatched when Flash Player gains operating system focus and becomes active. | DisplayObject | ||
![]() |
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
![]() | Dispatched when a display object is added to the display list. | DisplayObject | ||
![]() | Dispatched when the user presses the Button control. | Button | ||
![]() |
Dispatched when the selected property
changes for a toggle Button control. | Button | ||
![]() | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when the specified UIComponent closes. | PopUpButton | |||
![]() | 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 when the data property changes. | Button | ||
![]() | Dispatched when Flash Player loses operating system focus and is becoming inactive. | DisplayObject | ||
![]() |
Dispatched when a user presses and releases the main button of a pointing device twice in
rapid succession over the same InteractiveObject when that object's
doubleClickEnabled flag is set to true. | InteractiveObject | ||
![]() | 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 after an effect ends. | UIComponent | ||
![]() | Dispatched just before an effect starts. | UIComponent | ||
![]() | Dispatched when the playhead is entering a new frame. | DisplayObject | ||
![]() | Dispatched after the component has returned to the root view state. | UIComponent | ||
![]() | Dispatched before the component exits from the root view state. | UIComponent | ||
![]() | Dispatched after a display object gains focus. | InteractiveObject | ||
![]() | Dispatched after a display object loses focus. | InteractiveObject | ||
![]() | 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 when the user presses a key. | InteractiveObject | ||
![]() | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
![]() | Dispatched when the user releases a key. | InteractiveObject | ||
![]() | Dispatched when a user presses the pointing device button over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
![]() | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
![]() | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
![]() | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
![]() | Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
![]() | 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 when the specified UIComponent opens. | PopUpButton | |||
![]() | Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
![]() |
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
![]() | Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
![]() | Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
![]() | Dispatched when the component is resized. | UIComponent | ||
![]() | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
![]() |
Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
![]() |
Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
![]() |
Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
![]() | 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 | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
|
arrowButtonWidth
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the divider line and the right edge of the component. The default value is 16. | PopUpButton | ||
![]() | Type: uint Format: Color CSS Inheritance: no Color of the border. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its parent container. | UIComponent | ||
|
closeDuration
| Type: Number Format: Time CSS Inheritance: no Length of a close transition, in milliseconds. The default value is 250. | PopUpButton | ||
|
closeEasingFunction
| Type: Function CSS Inheritance: no Easing function to control component closing tween. | PopUpButton | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Radius of component corners. | Button | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not disabled. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and is disabled. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse button is down. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse button is down. | Button | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.. | UIComponent | ||
![]() | Type: Array CSS Inheritance: no Alphas used for the background fill of controls. | Button | ||
![]() | Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. | Button | ||
![]() | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | Button | ||
![]() | Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
![]() | Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | Button | ||
![]() | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
![]() | Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Button | ||
![]() | Type: String CSS Inheritance: yes Name of the font to use. | Button | ||
![]() | Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Button | ||
![]() | Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Button | ||
![]() | Type: String CSS Inheritance: yes Determines whether the text is italic font. | Button | ||
![]() | Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Button | ||
![]() | Type: String CSS Inheritance: yes Determines whether the text is boldface. | Button | ||
![]() | Type: Array CSS Inheritance: no Alpha transparencies used for the highlight fill of controls. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no Gap between the label and icon, when the labelPlacement property
is set to left or right. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the default icon. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Additional vertical space between lines of text. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's parent container to the left edge of the component. | UIComponent | ||
|
openDuration
| Type: Number Format: Time CSS Inheritance: no Length of an open transition, in milliseconds. The default value is 250. | PopUpButton | ||
|
openEasingFunction
| Type: Function CSS Inheritance: no Easing function to control component opening tween. | PopUpButton | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse is over the control. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is over the control. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and the bottom of its content area. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's left border and the left edge of its content area. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's right border and the right edge of its content area. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and the top of its content area. | Button | ||
|
popUpDownSkin
| Type: Class CSS Inheritance: no Skin class for the popUpDown state (when arrowButton is in down state) of the background and border. The default value is mx.skins.halo.PopUpButtonSkin. | PopUpButton | ||
|
popUpGap
| Type: Number Format: Length CSS Inheritance: no Number of vertical pixels between the PopUpButton and the specified popup UIComponent. The default value is 0. | PopUpButton | ||
|
popUpIcon
| Type: Class CSS Inheritance: no The icon used for the right button of PopUpButton. Supported classes are mx.skins.halo.PopUpIcon and mx.skins.halo.PopUpMenuIcon. The default value is mx.skins.halo.PopUpIcon. | PopUpButton | ||
|
popUpOverSkin
| Type: Class CSS Inheritance: no Skin class for the popUpOver state (over arrowButton) of the background and border. The default value is mx.skins.halo.PopUpButtonSkin. | PopUpButton | ||
![]() | Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown
event before repeating buttonDown events at each
repeatInterval. | Button | ||
![]() | Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events
if the user presses and holds the mouse on a button. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its parent container. | UIComponent | ||
![]() | Type: String CSS Inheritance: yes Alignment of text within a container. | Button | ||
![]() | Type: String CSS Inheritance: no Determines whether the text is underlined. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Button | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user moves the mouse pointer over the button. | Button | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user presses it. | Button | ||
![]() | Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the top edge of the component's parent container to the top edge of the component. | UIComponent | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. | Button | ||
![]() | Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is not over the control. | Button | ||
![]() | Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
![]() | Type: Number Format: Length CSS Inheritance: no Gap between the button's label and icon when the labelPlacement
property is set to "top" or "bottom". | Button | ||
| openAlways | property |
openAlways:Boolean [read-write]
If true, specifies to pop up the
popUp when you click the main button.
The popUp always appears when you press the Spacebar,
or when you click the pop-up button, regardless of the setting of
the openAlways property.
The default value is false.
public function get openAlways():Boolean
public function set openAlways(value:Boolean):void
| popUp | property |
popUp:IUIComponent [read-write]Specifies the UIComponent object, or object defined by a subclass of UIComponent, to pop up. For example, you can specify a Menu, TileList, or Tree control.
The default value is null.
This property can be used as the source for data binding.
Implementation public function get popUp():IUIComponent
public function set popUp(value:IUIComponent):void
| PopUpButton | () | constructor |
public function PopUpButton()Constructor.
| close | () | method |
public function close():voidCloses the UIComponent object opened by the PopUpButton control.
| open | () | method |
public function open():void
Opens the UIComponent object specified by the popUp property.
| close | event |
mx.events.DropdownEvent
mx.events.DropdownEvent.CLOSE
Dispatched when the specified UIComponent closes.
The DropdownEvent.CLOSE constant defines the value of the
type property of the event object for a close 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. |
triggerEvent | A value indicating the type of input action that triggered the event. |
| open | event |
mx.events.DropdownEvent
mx.events.DropdownEvent.OPEN
Dispatched when the specified UIComponent opens.
The DropdownEvent.OPEN constant defines the value of the
type property of the event object for a open 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. |
triggerEvent | A value indicating the type of input action that triggered the event. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the PopUpButton control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.controls.*;
import mx.events.*;
private var myMenu:Menu;
// Initialize the Menu control, and specify it as the pop up object
// of the PopUpButton control.
private function initMenu():void {
myMenu = new Menu();
var dp:Object = [{label: "New Folder"}, {label: "Sent Items"}, {label: "Inbox"}];
myMenu.dataProvider = dp;
myMenu.selectedIndex = 0;
myMenu.addEventListener("itemClick", itemClickHandler);
popB.popUp = myMenu;
popB.label = "Put in: " + myMenu.dataProvider[myMenu.selectedIndex].label;
}
// Define the event listener for the Menu control's itemClick event.
private function itemClickHandler(event:MenuEvent):void {
var label:String = event.item.label;
popTypeB.text=String("Moved to " + label);
popB.label = "Put in: " + label;
popB.close();
myMenu.selectedIndex = event.index;
}
]]>
</mx:Script>
<mx:Panel title="PopUpButton Control Example" height="75%" width="75%"
paddingTop="10" paddingBottom="10" paddingRight="10" paddingLeft="10">
<mx:Label width="100%" color="blue"
text="Button label contains the name of the last selected menu item." />
<mx:PopUpButton id="popB" label="Edit" creationComplete="initMenu();" width="135" />
<mx:Spacer height="50" />
<mx:TextInput id="popTypeB" />
</mx:Panel>
</mx:Application>