| Package | mx.controls |
| Class | public class PopUpMenuButton |
| Inheritance | PopUpMenuButton  PopUpButton Button UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
dataProvider property.
Unlike the Menu and MenuBar controls, the PopUpMenuButton control
supports only a single-level menu. This means that the menu cannot contain
cascading submenus.
The main sub-button of the PopUpMenuButton control can have a
text label, an icon, or both on its face.
When a user selects an item from the drop-down menu or clicks
the main button of the PopUpMenuButton control, the control
dispatches an itemClick event.
When a user clicks the main button of the
control, the control also dispatches a click event.
You can customize the look of a PopUpMenuButton control.
The PopUpMenuButton control has the following sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | Sufficient to accommodate the label and any icon on the main button, and the icon on the pop-up button. The control does not reserve space for the menu. |
| Minimum size | 0 pixels. |
| Maximum size | 10000 by 10000. |
Hide MXML Syntax
The <mx:PopUpMenuButton> tag inherits all of the tag
attributes of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:PopUpMenuButton
Properties
dataDescriptor="instance of DefaultDataDescriptor"
dataProvider="undefined"
labelField="null"
labelFunction="undefined"
showRoot="false|true"
Event
change=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 | |
| dataDescriptor : IMenuDataDescriptor
The data descriptor accesses and manipulates data in the data provider.
| PopUpMenuButton | ||
| dataProvider : Object
DataProvider for popUpMenu.
| PopUpMenuButton | ||
| 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 | |
| labelField : String
Name of the field in the dataProvider Array that contains the text to
show for each menu item.
| PopUpMenuButton | ||
| labelFunction : Function
A function that determines the text to display for each menu item.
| PopUpMenuButton | ||
| 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
[write-only]
A reference to the pop-up Menu object.
| PopUpMenuButton | ||
| 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 | |
| showRoot : Boolean
Specifies whether to display the top-level node or nodes of the data provider.
| PopUpMenuButton | ||
| 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.
| PopUpMenuButton | ||
|
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 | |
|
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 | |
|
Propagates 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, registers 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 | |
|
Replays the specified event.
| UIComponent | |
|
Resolves a child by using the id provided.
| UIComponent | |
|
[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 | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
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 or an AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| 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 a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | 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 user selects the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| 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 or an AIR application loses operating system focus and is becoming inactive. | EventDispatcher | ||
| 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 by the drag initiator when starting 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 a user selects an item from the pop-up menu. | PopUpMenuButton | |||
| 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 and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | 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. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | 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 by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| 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 a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | 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. | 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 | ||
|---|---|---|---|---|
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the divider line and the right edge of the component. | PopUpButton | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | Button | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: Number Format: Time CSS Inheritance: no Length of a close transition, in milliseconds. | PopUpButton | ||
| 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 disabled and not selected. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. | PopUpButton | ||
| 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: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| 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 The default icon class for the main button. | PopUpButton | ||
| Type: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. | PopUpButton | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Button | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Button | ||
| Type: Number Format: Time CSS Inheritance: no Length of an open transition, in milliseconds. | PopUpButton | ||
| 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 component's bottom border and the bottom of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Button | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's top border and the top of its content area. | Button | ||
| Type: Class CSS Inheritance: no Skin class for the popUpDown state (when arrowButton is in down state) of the background and border. | PopUpButton | ||
| Type: Number Format: Length CSS Inheritance: no Number of vertical pixels between the PopUpButton and the specified popup UIComponent. | PopUpButton | ||
| Type: Class CSS Inheritance: no The icon used for the right button of PopUpButton. | PopUpButton | ||
| Type: Class CSS Inheritance: no Skin class for the popUpOver state (over arrowButton) of the background and border. | PopUpButton | ||
|
popUpStyleName
| Type: String CSS Inheritance: no The name of a CSS style declaration used by the dropdown menu. This property allows you to control the appearance of the dropdown menu. The default value sets the fontWeight to normal and
the textAlign to left.
The default value is "popUpMenu". | PopUpMenuButton | ||
| 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: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: Class CSS Inheritance: no Default stateful skin class for the control. | PopUpButton | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | Button | ||
| Type: String CSS Inheritance: yes 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: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area 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: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| 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 | ||
| dataDescriptor | property |
dataDescriptor:IMenuDataDescriptor [read-write] The data descriptor accesses and manipulates data in the data provider.
When you specify this property as an attribute in MXML, you must use a reference to the data descriptor, not the string name of the descriptor. Use the following format for the property:
<mx:PopUpMenuButton id="menubar" dataDescriptor="{new MyCustomDataDescriptor()}"/>
Alternatively, you can specify the property in MXML as a nested subtag, as the following example shows:
<mx:PopUpMenuButton>
<mx:dataDescriptor>
<myCustomDataDescriptor>
</mx:dataDescriptor>
...
The default value is an internal instance of the DefaultDataDescriptor class.
public function get dataDescriptor():IMenuDataDescriptor
public function set dataDescriptor(value:IMenuDataDescriptor):void
| dataProvider | property |
dataProvider:Object [read-write] DataProvider for popUpMenu.
The default value is null.
This property can be used as the source for data binding.
public function get dataProvider():Object
public function set dataProvider(value:Object):void
| labelField | property |
labelField:String [read-write]
Name of the field in the dataProvider Array that contains the text to
show for each menu item.
The labelFunction property, if set, overrides this property.
If the data provider is an Array of Strings, Flex uses each String
value as the label.
If the data provider is an E4X XML object, you must set this property
explicitly; for example, use @label to specify the label attribute.
The default value is "label".
This property can be used as the source for data binding.
public function get labelField():String
public function set labelField(value:String):void
| labelFunction | property |
labelFunction:Function [read-write]
A function that determines the text to display for each menu item.
If you omit this property, Flex uses the contents of the field or attribute
determined by the labelField property.
If you specify this property, Flex ignores any labelField
property value.
If you specify this property, the label function must find the
appropriate field or fields and return a displayable string.
The labelFunction property is good for handling formatting
and localization.
The label function must take a single argument which is the item in the dataProvider and return a String.
The default value is null.
public function get labelFunction():Function
public function set labelFunction(value:Function):void
| popUp | property |
popUp:IUIComponent [write-only] A reference to the pop-up Menu object.
This property is read-only, and setting it has no effect.
Set the dataProvider property, instead.
(The write-only indicator appears in the syntax summary because the
property in the superclass is read-write and this class overrides
the setter with an empty implementation.)
public function set popUp(value:IUIComponent):void
| showRoot | property |
showRoot:Boolean [read-write]
Specifies whether to display the top-level node or nodes of the data provider.
If this is set to false, the control displays
only descendants of the first top-level node.
Any other top-level nodes are ignored.
You normally set this property to false for
E4X format XML data providers, where the top-level node is the document
object.
The default value is true.
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void
| PopUpMenuButton | () | Constructor |
public function PopUpMenuButton()
Constructor.
| itemClick | Event |
mx.events.MenuEvent
mx.events.MenuEvent.ITEM_CLICK
Dispatched when a user selects an item from the pop-up menu.
The MenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
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. |
index | The index in the menu of the selected menu item. |
item | The item in the dataProvider that was selected. |
itemRenderer | The ListItemRenderer of the selected menu item. |
label | The label text of the selected menu item. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
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 | MenuEvent.ITEM_CLICK |
<?xml version="1.0" encoding="utf-8"?>
<!-- PopUpMenuButton control example. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.events.*;
import mx.controls.*;
//Event handler, invoked when you select from the menu.
public function itemClickHandler(event:MenuEvent):void {
Alert.show("Menu label: " + event.label
+ " \n menu item index within parent menu: " + event.index);
}
]]>
</mx:Script>
<!-- A an data provider in E4X format. -->
<mx:XMLList id="treeDP2">
<node label="Inbox"/>
<node label="Calendar"/>
<node label="Deleted Items"/>
</mx:XMLList>
<mx:Panel title="PopUpMenuButton Control Example" height="100%" width="100%"
paddingTop="10" paddingLeft="10" paddingRight="10">
<mx:Label width="100%" color="blue"
text="Click the down arrow to open the menu."/>
<mx:PopUpMenuButton id="p2"
dataProvider="{treeDP2}"
labelField="@label"
itemClick="itemClickHandler(event);"/>
</mx:Panel>
</mx:Application>