| Appendixes | Conventions | Frames
| Package | mx.controls |
| Class | public class PopUpButton |
| Inheritance | PopUpButton  Button UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | FileSystemHistoryButton, 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.
The PopUpButton control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default size | Sufficient width to accommodate the label and icon on the main button and the icon on the pop-up button |
| Minimum size | 0 pixels |
| Maximum size | Undefined |
Hide MXML Syntax
The <mx:PopUpButton> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:PopUpButton
Properties
openAlways="false|true
popUp="No default"
Styles
arrowButtonWidth="16"
closeDuration="250"
closeEasingFunction="No default"
disabledIconColor="0x999999"
iconColor="0x111111"
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 | |
| activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| 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 | |
| autoRepeat : Boolean
Specifies whether to dispatch repeated buttonDown
events if the user holds down the mouse button.
| Button | |
| baselinePosition : Number
[read-only]
The y-coordinate of the baseline
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 or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
| 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 | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| 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 | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| 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 | |
| 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
[read-only]
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 | |
| 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 | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
| Button | |
| graphics : Graphics
[read-only]
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
[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 | |
| 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
[read-only]
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 | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| 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
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
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 | |
| numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | |
| numChildren : int
[read-only]
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
[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 | |
| 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
[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 | |
| root : DisplayObject
[read-only]
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 factor.
| UIComponent | |
| screen : Rectangle
[read-only]
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 | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
[read-only]
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
[read-only]
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 | |
|
Returns a set of properties that identify the child within
this container.
| 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.
| UIComponent | |
|
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 | |
|
Provides the automation object at the specified index.
| 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 | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| 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 | |
|
getObjectsUnderPoint(point:Point): | ||