| Package | mx.controls.menuClasses |
| Interface | public interface IMenuDataDescriptor |
| Implementors | DefaultDataDescriptor |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
| Method | Defined By | ||
|---|---|---|---|
Add a child node to a node at the specified index. | IMenuDataDescriptor | ||
Provides access to a node's children. | IMenuDataDescriptor | ||
Returns a node's data. | IMenuDataDescriptor | ||
Returns the name of the radio button group to which
the node belongs, if any. | IMenuDataDescriptor | ||
Returns the type identifier of a node. | IMenuDataDescriptor | ||
Determines if the node actually has children. | IMenuDataDescriptor | ||
Tests a node for termination. | IMenuDataDescriptor | ||
Returns whether the node is enabled. | IMenuDataDescriptor | ||
Returns whether the node is toggled. | IMenuDataDescriptor | ||
Removes the child node from a node at the specified index. | IMenuDataDescriptor | ||
Sets the value of the field or attribute in the data provider
that identifies whether the node is enabled. | IMenuDataDescriptor | ||
Sets the value of the field or attribute in the data provider
that identifies whether the node is toggled. | IMenuDataDescriptor | ||
addChildAt | () | method |
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Add a child node to a node at the specified index. This implementation does the following:
- If the
parentparameter is null or undefined, inserts thechildparameter at the specified index in the collection specified bymodelparameter. - If the
parentparameter has achildrenfield or property, the method adds thechildparameter to it at theindexparameter location. In this case, themodelparameter is not required. - If the
parentparameter does not have achildrenfield or property, the method adds thechildrenproperty to theparent. The method then adds thechildparameter to the parent at theindexparameter location. In this case, themodelparameter is not required. - If the
indexvalue is greater than the collection length or number of children in the parent, adds the object as the last child.
Parameters
parent:Object — The node object that will parent the child.
| |
newChild:Object — The node object that will be parented by the node.
| |
index:int — The 0-based index of where to put the child node relative to the parent.
| |
model:Object (default = null) |
Boolean — true if successful.
|
getChildren | () | method |
public function getChildren(node:Object, model:Object = null):ICollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to a node's children. Returns a collection
of children if they exist. If the node is an Object, the method
returns the contents of the object's children field as
an ArrayCollection.
If the node is XML, the method returns an XMLListCollection containing
the child elements.
Parameters
node:Object — The node object currently being evaluated.
| |
model:Object (default = null) |
ICollectionView — An object containing the children nodes.
|
getData | () | method |
public function getData(node:Object, model:Object = null):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a node's data. Currently returns the entire node.
Parameters
node:Object — The node object currently being evaluated.
| |
model:Object (default = null) |
Object — The node.
|
getGroupName | () | method |
public function getGroupName(node:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the name of the radio button group to which the node belongs, if any. This method is used by menu-based controls.
Parameters
node:Object — The node for which to get the group name.
|
String — The value of the node's groupName
attribute or field, or an empty string if there is no such
entry.
|
getType | () | method |
public function getType(node:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the type identifier of a node. This method is used by menu-based controls to determine if the node represents a separator, radio button, a check box, or normal item.
Parameters
node:Object — The node object for which to get the type.
|
String — The value of the type attribute or field,
or the empty string if there is no such field.
|
hasChildren | () | method |
public function hasChildren(node:Object, model:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the node actually has children.
Parameters
node:Object — The node object currently being evaluated.
| |
model:Object (default = null) |
Boolean — true if this node currently has children.
|
isBranch | () | method |
public function isBranch(node:Object, model:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests a node for termination.
Branches are non-terminating but are not required to have any leaf nodes.
If the node is XML, returns true if the node has children
or a true isBranch attribute.
If the node is an object, returns true if the node has a
(possibly empty) children field.
Parameters
node:Object — The node object currently being evaluated.
| |
model:Object (default = null) |
Boolean — true if this node is non-terminating.
|
isEnabled | () | method |
public function isEnabled(node:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns whether the node is enabled. This method is used by menu-based controls.
Parameters
node:Object — The node for which to get the status.
|
Boolean — The value of the node's enabled
attribute or field, or true if there is no such
entry or the value is not false.
|
isToggled | () | method |
public function isToggled(node:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns whether the node is toggled. This method is used by menu-based controls.
Parameters
node:Object — The node for which to get the status.
|
Boolean — The value of the node's toggled
attribute or field, or false if there is no such
entry.
|
removeChildAt | () | method |
public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes the child node from a node at the specified index.
If the parent parameter is null
or undefined, the method uses the model parameter to
access the child; otherwise, it uses the parent parameter
and ignores the model parameter.
Parameters
parent:Object — The node object that currently parents the child node.
| |
child:Object — The node that is being removed.
| |
index:int — The 0-based index of the child node to remove relative to the parent.
| |
model:Object (default = null) |
Boolean — true if successful.
|
setEnabled | () | method |
public function setEnabled(node:Object, value:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the value of the field or attribute in the data provider
that identifies whether the node is enabled.
This method sets the value of the node's enabled
attribute or field.
This method is used by menu-based controls.
Parameters
node:Object — The node for which to set the status.
| |
value:Boolean — Whether the node is enabled.
|
setToggled | () | method |
public function setToggled(node:Object, value:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the value of the field or attribute in the data provider
that identifies whether the node is toggled.
This method sets the value of the node's toggled
attribute or field.
This method is used by menu-based controls.
Parameters
node:Object — The node for which to set the status.
| |
value:Boolean — Whether the node is toggled.
|
Mon Apr 10 2017, 12:28 PM -07:00