| Package | mx.controls |
| Class | public class Menu |
| Inheritance | Menu  List ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFocusManagerContainer |
Menu.hide() method.See also
| Property | Defined by | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
| ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time.
| ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| baselinePosition : Number
The baseline position for the control.
| List | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| 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 | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control.
| ListBase | |
| columnWidth : Number
The width of the control's columns.
| ListBase | |
| 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 item in the data provider this component should render when
this component is used as an item renderer or item editor.
| ListBase | |
| dataDescriptor : IMenuDataDescriptor
The object that accesses and manipulates data in the data provider.
| Menu | ||
| dataProvider : Object
Set of data to be viewed.
| ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip.
| ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
| ListBase | |
| 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 | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls.
| ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation.
| ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control.
| ListBase | |
| dropTarget : DisplayObject
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| editable : Boolean = false
A flag that indicates whether or not the user can edit
items in the data provider.
| List | |
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any.
| List | |
| editedItemRenderer : IListItemRenderer
A reference to the item renderer
in the DataGrid control whose item is currently being edited.
| List | |
| editorDataField : String = "text"
The name of the property of the item editor that contains the new
data for the list item.
| List | |
| editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer.
| List | |
| editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key.
| List | |
| editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer.
| List | |
| editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | |
| editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | |
| 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 | |
| hasRoot : Boolean
[read-only]
A flag that indicates that the current data provider has a root node; for example,
a single top node in a hierarchical structure.
| Menu | ||
| 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 | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon.
| ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon.
| ListBase | |
| id : String
ID of the component.
| UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode.
| List | |
| 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 | |
| itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true. | List | |
| itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor,
if it exists.
| List | |
| itemRenderer : IFactory
The custom item renderer for the control.
| ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label.
| ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label.
| ListBase | |
| 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 additional data from the list control. | ListBase | |
| loaderInfo : LoaderInfo
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| lockedColumnCount : int
The index of the first column in the control that scrolls.
| ListBase | |
| lockedRowCount : int
The index of the first row in the control that scrolls.
| ListBase | |
| 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 | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used.
| ListBase | |
| 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 | |
| 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 | |
| parentMenu : Menu
The parent menu in a hierarchical chain of menus, where the current
menu is a submenu of the parent.
| Menu | ||
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor.
| List | |
| 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 | |
| rowCount : int
Number of rows to be displayed.
| ListBase | |
| rowHeight : Number
The height of the rows in pixels.
| ListBase | |
| 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 | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected.
| ListBase | |
| selectedIndex : int
The index in the data provider of the selected item.
| ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items.
| ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider.
| ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider.
| ListBase | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows.
| ListBase | |
| showRoot : Boolean
/ A Boolean flag that specifies whether to display the data provider's
root node.
| Menu | ||
| 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 | |
| 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 | |
| value : Object
The selected item, or the data or label field of the selected item.
| ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height.
| ListBase | |
| viewMetrics : EdgeMetrics
An EdgeMetrics object taking into account the scroll bars,
if visible.
| ScrollControlBase | |
| 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 | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
| ListBase | |
| 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 | ||
|---|---|---|---|
|
Menu()
Constructor.
| Menu | ||
|
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 | |
|
Returns the index where the dropped items should be added
to the drop target.
| ListBase | |
|
Queues a function to be called later.
| UIComponent | |
|
Deletes a style property from this component instance.
| UIComponent | |
|
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 the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | List | |
|
[static]
Creates and returns an instance of the Menu class.
| Menu | ||
|
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 | |
|
Closes an item editor that is currently open on an item.
| List | |
|
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, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
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 | |
|
Finds an item in the list based on a string
and moves the selection to it.
| ListBase | |
|
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 | |
|
Hides the Menu control and any of its submenus if the Menu control is
visible.
| Menu | ||
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed.
| ListBase | |
|
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 | |
|
Get an item renderer for the index of an item in the data provider,
if one exists.
| ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex.
| ListBase | |
|
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 | |
|
Refresh all rows on next update.
| ListBase | |
|
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 | |
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or
or under the caret via keyboard navigation).
| ListBase | |
|
Determines if the item renderer for a data provider item
is selected.
| ListBase | |
|
Determines if an item is being displayed by a renderer.
| ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Determines whether a renderer contains (or owns) a display object.
| ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer.
| ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties.
| ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties.
| ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one.
| ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties.
| ListBase | |
|
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 a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items.
| ListBase | |
|
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 | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found.
| ListBase | |
|
Moves the component to a specified position within its parent.
| UIComponent | |
|
Propagate style changes to the children.
| UIComponent | |
|
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 | |
|
[static]
Sets the dataProvider of an existing Menu control and places the Menu
control in the specified parent container.
| Menu | ||
|
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 | |
|
Ensures that the data provider item at the given index is visible.
| ListBase | |
|
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 | |
|
Shows the Menu control.
| Menu | ||
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped.
| ListBase | |
|
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 | |
| Method | Defined by | ||
|---|---|---|---|
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation.
| ListBase | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it.
| ListBase | |
|
Adjust the focus rectangle.
| UIComponent | |
|
Sets up the effect for applying the selection indicator.
| ListBase | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | |
|
Calculates the y position of the drop indicator
when performing a drag-and-drop operation.
| ListBase | |
|
Performs any final processing after child objects are created.
| UIComponent | |
|
Removes all selection and highlight and caret indicators.
| ListBase | |
|
Clears the set of selected items and removes all graphics
depicting the selected state of those items.
| ListBase | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes.
| ListBase | |
|
Calculates the column width and row height and number of rows and
columns based on whether properties like
columnCount
columnWidth, rowHeight and
rowCount were explicitly set. | ListBase | |
|
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns.
| ListBase | |
|
Makes a copy of the selected items in the order they were
selected.
| ListBase | |
|
Creates the border for this component.
| ScrollControlBase | |
|
Create objects that are children of this ListBase, in this case
the
listContent object that will hold all the item
renderers. | ListBase | |
|
Handles
DragEvent.DRAG_COMPLETE events. | ListBase | |
|
Handles
DragEvent.DRAG_DROP events. | ListBase | |
|
Handles
DragEvent.DRAG_ENTER events. | ListBase | |
|
Handles
DragEvent.DRAG_EXIT events. | ListBase | |
|
Handles
DragEvent.DRAG_OVER events. | ListBase | |
|
Interval function that scrolls the list up or down
if the mouse goes above or below the list.
| ListBase | |
|
drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite
at the position, width and height specified using the
color specified.
| ListBase | |
|
drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite
at the position, width and height specified using the
color specified.
| ListBase | |
|
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators
that it is highlighted, selected, or the caret.
| ListBase | |
|
Draws a row background
at the position and height specified.
| List | |
|
Draws any alternating row colors, borders and backgrounds for the rows.
| ListBase | |
|
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite
at the position, width and height specified using the
color specified.
| ListBase | |
|
Stops the editing of an item in the data provider.
| List | |
|
Tries to find the next item in the data provider that
starts with the character in the
eventCode parameter. | ListBase | |
|
Sets selected items based on the
caretIndex and
anchorIndex properties. | ListBase | |
|
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
The column for the data provider item at the given index.
| ListBase | |
|
The row for the data provider item at the given index.
| ListBase | |
|
Finalizes the initialization of this component.
| UIComponent | |
|
Initializes this component's accessibility code.
| UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
Returns a Point containing the columnIndex and rowIndex of an
item renderer.
| ListBase | |
|
Determines the UID for a data provider item.
| ListBase | |
|
The event handler called for a
keyDown event. | UIComponent | |
|
The event handler called for a
keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders.
| ScrollControlBase | |
|
Positions the item editor instance at the suggested position
with the suggested dimensions.
| List | |
|
Creates a new ListData instance and populates the fields based on
the input data provider item.
| List | |
|
makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area
described by left, top, right, bottom.
| ListBase | |
|
Calculates the preferred width and height of the Menu based on the
widths and heights of its menu items.
| Menu | ||
|
Handles
MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles
MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | |
|
Handles
MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Determines which item renderer is under the mouse.
| ListBase | |
|
Handles
MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles
MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | |
|
Handles
MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | |
|
Handles
MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles mouseWheel events by changing scroll positions.
| ListBase | |
|
Moves the selection in a horizontal direction in response
to the user selecting items using the left-arrow or right-arrow
keys and modifiers such as the Shift and Ctrl keys.
| ListBase | |
|
Moves the selection in a vertical direction in response
to the user selecting items using the up-arrow or down-arrow
Keys and modifiers such as the Shift and Ctrl keys.
| ListBase | |
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider.
| ListBase | |
|
Default event handler for the
scroll event. | ScrollControlBase | |
|
Adjusts the renderers in response to a change
in scroll position.
| ListBase | |
|
Returns the data provider index for the item at the first visible
row and column for the given scroll positions.
| ListBase | |
|
Adjusts the renderers in response to a change
in scroll position.
| ListBase | |
|
The default failure handler when a seek fails due to a page fault.
| ListBase | |
|
The default result handler when a seek fails due to a page fault.
| ListBase | |
|
selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided
was clicked by the mouse and the keyboard modifiers are in the given
state.
| ListBase | |
|
Toggles the menu item.
| Menu | ||
|
Sets the rowCount property without causing
invalidation or setting the
explicitRowCount
property, which permanently locks in the number of rows. | ListBase | |
|
Sets rowHeight without causing invalidation or
setting of
explicitRowHeight which
permanently locks in the height of the rows
| ListBase | |
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in.
| ScrollControlBase | |
|
Adds or removes item renderers if the number of displayable items
changed.
| ListBase | |
|
Refreshes all rows now.
| ListBase | |
| 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 a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | 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. | ListBase | ||
| 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 a menu item is selected. | Menu | |||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
|
Dispatched when the editedItemPosition property is set
and the item can be edited. | List | ||
| Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item. | List | ||
| Dispatched when an item editing session is ending for any reason. | List | ||
| Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. | List | ||
| Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. | List | ||
| 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 menu or submenu is dismissed. | Menu | |||
| Dispatched when a menu or submenu opens. | Menu | |||
| 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 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 the content is scrolled. | ScrollControlBase | ||
| 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 | ||
|---|---|---|---|---|
|
alternatingItemColors
| Type: Array Format: Color CSS Inheritance: yes The colors used for menu or submenu menu items in an alternating pattern. The value can be an Array of two or more colors. This style is only used if backgroundColor is not specified.
The default value is "undefined". | Menu | ||
| Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor
property, of the image or SWF file defined by the backgroundImage
style. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Background color of a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | List | ||
| Type: Object Format: File CSS Inheritance: no Background image of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Scales the image specified by backgroundImage
to different percentage sizes. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box sides. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The border skin of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | ScrollControlBase | ||
| 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 | ||
|
branchDisabledIcon
| Type: Class CSS Inheritance: no The icon for all disabled menu items that have submenus. The default value is "MenuBranchDisabled". | Menu | ||
|
branchIcon
| Type: Class CSS Inheritance: no The icon for all enabled menu items that have submenus. The default value is "MenuBranchIcon". | Menu | ||
|
checkDisabledIcon
| Type: Class CSS Inheritance: no The icon for all dsiabled menu items whose type identifier is a check box. The default value is "MenuCheckDisabled". | Menu | ||
|
checkIcon
| Type: Class CSS Inheritance: no The icon for all enabled menu items whose type identifier is a check box. The default value is "MenuCheckEnabled". | Menu | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The skin to use to indicate where a dragged item can be dropped. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.. | UIComponent | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ListBase | ||
| 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. | ListBase | ||
| 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. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
| 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: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Additional vertical space between lines of text. | ScrollControlBase | ||
| 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 The duration of the menu or submenu opening transition, in milliseconds. The value 0 specifies no transition. The default value is 250. | Menu | ||
| Type: Number Format: Length CSS Inheritance: no The number of pixels between the bottom of the row and the bottom of the renderer in the row. | ListBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's left border and the left edge of its content area. | ListBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's right border and the right edge of its content area. | ListBase | ||
| Type: Number Format: Length CSS Inheritance: no The number of pixels between the top of the row and the top of the renderer in the row. | ListBase | ||
|
radioDisabledIcon
| Type: Class CSS Inheritance: no The icon for all disabled menu items whose type identifier is a radio button. The default value is "MenuRadioDisabled". | Menu | ||
|
radioIcon
| Type: Class CSS Inheritance: no The icon for all enabled menu items whose type identifier is a radio button. The default value is "MenuRadioEnabled". | Menu | ||
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown event
before repeating buttonDown events at the value specified by
repeatInterval. | ScrollControlBase | ||
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events
if the user presses and holds on a button. | ScrollControlBase | ||
| 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 | ||
|
rollOverColor
| Type: uint Format: Color CSS Inheritance: yes The color of the menu item background when a user rolls the mouse over it. The default value is 0xB2E1FF. | Menu | ||
|
selectionColor
| Type: uint Format: Color CSS Inheritance: yes The color of the menu item background when a menu item is selected. The default value is 0x7FCEFF. | Menu | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the component is disabled. | ListBase | ||
| Type: Number Format: Time CSS Inheritance: no The duration of the selection effect. | ListBase | ||
|
selectionEasingFunction
| Type: Function CSS Inheritance: no The reference to an easingFunction equation which is used to
control programmatic tweening.
The default value is "undefined". | Menu | ||
|
separatorSkin
| Type: Class CSS Inheritance: no The skin for all menu items which are identified as separators. The default value is "MenuSeparator". | Menu | ||
| Type: String CSS Inheritance: no Direction of the drop shadow. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Determines whether the text is underlined. | ScrollControlBase | ||
|
textIndent
| Type: Number Format: Length CSS Inheritance: yes The offset of the first line of text from the left side of the menu or submenu menu item. The default value is 0. | Menu | ||
|
textRollOverColor
| Type: uint Format: Color CSS Inheritance: yes The color of the menu item text when a user rolls the mouse over the menu item. The default value is 0x2B333C. | Menu | ||
|
textSelectedColor
| Type: uint Format: Color CSS Inheritance: yes The color of the menu item text when the menu item is selected. The default value is 0x2B333C. | Menu | ||
| 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: Boolean CSS Inheritance: no A flag that controls whether items are highlighted as the mouse rolls over them. | ListBase | ||
| Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | ListBase | ||
| 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: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
| dataDescriptor | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdataDescriptor:IMenuDataDescriptor [read-write]The object that accesses and manipulates data in the data provider. The Menu control delegates to the data descriptor for information about its data. This data is then used to parse and move about the data source. The default value is an internal instance of the DefaultDataDescriptor class.
Implementation public function get dataDescriptor():IMenuDataDescriptor
public function set dataDescriptor(value:IMenuDataDescriptor):void
| hasRoot | property |
hasRoot:Boolean [read-only]A flag that indicates that the current data provider has a root node; for example, a single top node in a hierarchical structure. XML and Object are examples of types that have a root node, while Lists and Arrays do not.
The default value is false.
public function get hasRoot():Boolean
See also
| parentMenu | property |
parentMenu:Menu [read-write]The parent menu in a hierarchical chain of menus, where the current menu is a submenu of the parent.
Implementation public function get parentMenu():Menu
public function set parentMenu(value:Menu):void
| showRoot | property |
showRoot:Boolean [read-write]
/ A Boolean flag that specifies whether to display the data provider's
root node.
If the dataProvider object has a root node, and showRoot is set to
false, the Menu control does not display the root node;
only the descendants of the root node will be displayed.
This flag has no effect on data providers without root nodes,
like Lists and Arrays.
The default value is true.
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void
See also
| Menu | () | constructor |
public function Menu()Constructor.
Applications do not normally call the Menu constructor directly.
Instead, Applications will call the Menu.createMenu()
method.
| createMenu | () | method |
public static function createMenu(parent:DisplayObjectContainer, mdp:Object, showRoot:Boolean = true):Menu
Creates and returns an instance of the Menu class. The Menu control's
content is determined by the method's mdp argument. The
Menu control is placed in the parent container specified by the
method's parent argument.
This method does not show the Menu control. Instead,
this method just creates the Menu control and allows for modifications
to be made to the Menu instance before the Menu is shown. To show the
Menu, call the Menu.show() method.
parent:DisplayObjectContainer — A container that the PopUpManager uses to place the Menu
control in. The Menu control may not actually be parented by this object.
|
|
mdp:Object — The data provider for the Menu control.
|
|
showRoot:Boolean (default = true) |
Menu —
An instance of the Menu class.
|
See also
| hide | () | method |
public function hide():voidHides the Menu control and any of its submenus if the Menu control is visible.
| measure | () | method |
protected override function measure():voidCalculates the preferred width and height of the Menu based on the widths and heights of its menu items. This method does not take into account the position and size of submenus.
| popUpMenu | () | method |
public static function popUpMenu(menu:Menu, parent:DisplayObjectContainer, mdp:Object):void
Sets the dataProvider of an existing Menu control and places the Menu
control in the specified parent container.
This method does not show the Menu control; you must use the
Menu.show() method to display the Menu control.
The Menu.createMenu() method uses this method.
menu:Menu — Menu control to popup.
|
|
parent:DisplayObjectContainer — A container that the PopUpManager uses to place the Menu
control in. The Menu control may not actually be parented by this object.
If you omit this property, the method sets the Menu control's parent to
the application.
|
|
mdp:Object — dataProvider object set on the popped up Menu. If you omit this
property, the method sets the Menu data provider to a new, empty XML object.
|
| setMenuItemToggled | () | method |
protected function setMenuItemToggled(item:Object, toggle:Boolean):voidToggles the menu item. The menu item type identifier must be a check box or radio button, otherwise this method has no effect.
Parametersitem:Object — The menu item to toggle
|
|
toggle:Boolean — Boolean value that indicates whether the item is
toggled.
|
| show | () | method |
public function show(xShow:Object = null, yShow:Object = null):void
Shows the Menu control. If the Menu control is not visible, this method
places the Menu in the upper-left corner of the parent application at
the given coordinates, resizes the Menu control as needed, and makes
the Menu control visible.
The x and y arguments of the show() method specify the
coordinates of the upper-left corner of the Menu control relative to the
parent application, which is not necessarily the direct parent of the
Menu control.
For example, if the Menu control is in an HBox container which is
nested within a Panel container, the x and y coordinates are
relative to the Application container, not to the HBox container.
xShow:Object (default = null) |
|
yShow:Object (default = null) |
| itemClick | event |
mx.events.MenuEvent
mx.events.MenuEvent.ITEM_CLICK
Dispatched when a menu item is selected.
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. |
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 |
| menuHide | event |
mx.events.MenuEvent
mx.events.MenuEvent.MENU_HIDE
Dispatched when a menu or submenu is dismissed.
The MenuEvent.MENU_HIDE event type constant indicates that a menu or submenu closed.
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 |
-1. This property is not set for this type of event. |
item |
null. This property is not set for this type of event. |
itemRenderer |
null. This property is not set for this type of event. |
label |
null. This property is not set for this type of event. |
menu |
The specific Menu instance that was hidden. |
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.MENU_HIDE |
| menuShow | event |
mx.events.MenuEvent
mx.events.MenuEvent.MENU_SHOW
Dispatched when a menu or submenu opens.
The MenuEvent.MENU_SHOW type constant indicates that the mouse pointer rolled a menu or submenu opened.
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 |
-1. This property is not set for this type of event. |
item |
null. This property is not set for this type of event. |
itemRenderer |
null. This property is not set for this type of event. |
label |
null. This property is not set for this type of event. |
menu |
The specific Menu instance associated with 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.MENU_SHOW |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Menu control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.controls.Menu;
import mx.events.MenuEvent;
import mx.controls.Alert;
import flash.geom.Point;
private var point1:Point = new Point();
private var myMenu:Menu;
// Create and display the Menu control.
private function showMenu():void {
myMenu= Menu.createMenu(panel, myMenuData, false);
myMenu.labelField="@label"
myMenu.addEventListener("itemClick", menuHandler);
// Calculate position of Menu in Application's coordinates.
point1.x=mybutton.x;
point1.y=mybutton.y;
point1=mybutton.localToGlobal(point1);
myMenu.show(point1.x + 25, point1.y + 25);
}
// Event handler for the Menu control's change event.
private function menuHandler(event:MenuEvent):void {
Alert.show("Label: " + event.item.@label, "Clicked menu item");
}
]]>
</mx:Script>
<mx:XML id="myMenuData">
<root>
<menuitem label="MenuItem 1" eventName="copy"/>
<menuitem label="MenuItem 2" eventName="paste"/>
</root>
</mx:XML>
<mx:Panel id="panel" title="Menu Control Example" height="75%" width="75%"
paddingTop="10" paddingLeft="10">
<mx:Label width="100%" color="blue"
text="Click the button to open the Menu control."/>
<mx:Button id="mybutton" label="Open Menu" click="showMenu();"/>
</mx:Panel>
</mx:Application>