IMenuDataDescriptor - Guida di riferimento alle API Adobe ActionScript® 3 (AS3 Flex)

Pacchetto	mx.controls.menuClasses
Interfaccia	public interface IMenuDataDescriptor
Implementatori	DefaultDataDescriptor

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

The IMenuDataDescriptor interface defines the interface that a dataDescriptor for a Menu or MenuBar control must implement. The interface provides methods for parsing and modifyng a collection of data that is displayed by a Menu or MenuBar control.

Elementi API correlati

mx.collections.ICollectionView

Metodi pubblici

	Metodo		Definito da
		addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean Add a child node to a node at the specified index.	IMenuDataDescriptor
		getChildren(node:Object, model:Object = null):ICollectionView Provides access to a node's children.	IMenuDataDescriptor
		getData(node:Object, model:Object = null):Object Returns a node's data.	IMenuDataDescriptor
		getGroupName(node:Object):String Returns the name of the radio button group to which the node belongs, if any.	IMenuDataDescriptor
		getType(node:Object):String Returns the type identifier of a node.	IMenuDataDescriptor
		hasChildren(node:Object, model:Object = null):Boolean Determines if the node actually has children.	IMenuDataDescriptor
		isBranch(node:Object, model:Object = null):Boolean Tests a node for termination.	IMenuDataDescriptor
		isEnabled(node:Object):Boolean Returns whether the node is enabled.	IMenuDataDescriptor
		isToggled(node:Object):Boolean Returns whether the node is toggled.	IMenuDataDescriptor
		removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean Removes the child node from a node at the specified index.	IMenuDataDescriptor
		setEnabled(node:Object, value:Boolean):void Sets the value of the field or attribute in the data provider that identifies whether the node is enabled.	IMenuDataDescriptor
		setToggled(node:Object, value:Boolean):void Sets the value of the field or attribute in the data provider that identifies whether the node is toggled.	IMenuDataDescriptor

Descrizione dei metodi

addChildAt

()

metodo

public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Add a child node to a node at the specified index. This implementation does the following:

If the parent parameter is null or undefined, inserts the child parameter at the specified index in the collection specified by model parameter.
If the parent parameter has a children field or property, the method adds the child parameter to it at the index parameter location. In this case, the model parameter is not required.
If the parent parameter does not have a children field or property, the method adds the children property to the parent. The method then adds the child parameter to the parent at the index parameter location. In this case, the model parameter is not required.
If the index value is greater than the collection length or number of children in the parent, adds the object as the last child.

Parametri

	`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`) — The entire collection that this node is a part of.

Restituisce

Boolean — true if successful.

getChildren

()

metodo

public function getChildren(node:Object, model:Object = null):ICollectionView

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

	`node:Object` — The node object currently being evaluated.

	`model:Object` (default = `null`) — The collection that contains the node; ignored by this class.

Restituisce

ICollectionView — An object containing the children nodes.

getData

()

metodo

public function getData(node:Object, model:Object = null):Object

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns a node's data. Currently returns the entire node.

Parametri

	`node:Object` — The node object currently being evaluated.

	`model:Object` (default = `null`) — The collection that contains the node; ignored by this class.

Restituisce

Object — The node.

getGroupName

()

metodo

public function getGroupName(node:Object):String

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

node:Object — The node for which to get the group name.

Restituisce

String — The value of the node's groupName attribute or field, or an empty string if there is no such entry.

getType

()

metodo

public function getType(node:Object):String

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

node:Object — The node object for which to get the type.

Restituisce

String — The value of the type attribute or field, or the empty string if there is no such field.

hasChildren

()

metodo

public function hasChildren(node:Object, model:Object = null):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Determines if the node actually has children.

Parametri

	`node:Object` — The node object currently being evaluated.

	`model:Object` (default = `null`) — The collection that contains the node; ignored by this class.

Restituisce

Boolean — true if this node currently has children.

isBranch

()

metodo

public function isBranch(node:Object, model:Object = null):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

	`node:Object` — The node object currently being evaluated.

	`model:Object` (default = `null`) — The collection that contains the node; ignored by this class.

Restituisce

Boolean — true if this node is non-terminating.

isEnabled

()

metodo

public function isEnabled(node:Object):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns whether the node is enabled. This method is used by menu-based controls.

Parametri

node:Object — The node for which to get the status.

Restituisce

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

()

metodo

public function isToggled(node:Object):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns whether the node is toggled. This method is used by menu-based controls.

Parametri

node:Object — The node for which to get the status.

Restituisce

Boolean — The value of the node's toggled attribute or field, or false if there is no such entry.

removeChildAt

()

metodo

public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

	`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`) — The entire collection that this node is a part of.

Restituisce

Boolean — true if successful.

setEnabled

()

metodo

public function setEnabled(node:Object, value:Boolean):void

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

	`node:Object` — The node for which to set the status.

	`value:Boolean` — Whether the node is enabled.

setToggled

()

metodo

public function setToggled(node:Object, value:Boolean):void

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

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.

Parametri

	`node:Object` — The node for which to set the status.

	`value:Boolean` — Whether the node is toggled.

Note legali | Informativa sulla privacy online

IMenuDataDescriptor - AS3 Flex

Classi x

addChildAt

getChildren

getData

getGroupName

getType

hasChildren

isBranch

isEnabled

isToggled

removeChildAt

setEnabled

setToggled