Pacotemx.controls.treeClasses
Classeclasse pública DefaultDataDescriptor
HerançaDefaultDataDescriptor Inheritance Object
Implementos ITreeDataDescriptor2, IMenuDataDescriptor

A classe DefaultDataDescriptor providencia uma implementação padrão para acessar e manipular dados a serem usados em controles tal como Tree e Menu. Essa implementação maneja e4x XML e nodes de objetos de maneiras similiares porém diferentes. Veja cada descrição de método para detalhes de como o método acessa valores em nodes de vários tipos. Essa classe é o valor padrão das propriedades dataDescriptor dos controles Tree, Menu, MenuBar, e PopUpMenuButton.

Ver também

mx.controls.treeClasses.ITreeDataDescriptor
mx.controls.menuClasses.IMenuDataDescriptor
mx.controls.Menu
mx.controls.MenuBar
mx.controls.PopUpMenuButton
mx.controls.Tree


Propriedades Públicas
 PropriedadeDefinido Por
 Inheritedconstructor : Object
Uma referência ao objeto da classe ou função construtora para uma instância determinada de um objeto.
Object
 Inheritedprototype : Object
[static] Uma referência ao objeto protótipo de uma classe ou função de objeto.
Object
Métodos Públicos
 MétodoDefinido Por
  
Constructor
DefaultDataDescriptor
  
addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
Adiciona um child node a um node no índice especificado.
DefaultDataDescriptor
  
Providencia acesso aos children de um node.
DefaultDataDescriptor
  
getData(node:Object, model:Object = null):Object
Retorna os dados de um node.
DefaultDataDescriptor
  
Retorna o nome do grupo de botão de rádio na qual o node pertence, se houver.
DefaultDataDescriptor
  
getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView
Retorna uma instância ICollectionView que faz os dados de hierarquia aparecerem como se fossem uma instância linear ICollectionView.
DefaultDataDescriptor
  
getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int
Retorna a profundidad do node, significando o número de ancestrais que ele tem.
DefaultDataDescriptor
  
getParent(node:Object, collection:ICollectionView, model:Object = null):Object
Retorna o parant do node.
DefaultDataDescriptor
  
Retorna o identificador de tipo de um node.
DefaultDataDescriptor
  
hasChildren(node:Object, model:Object = null):Boolean
Retorna true se o node tiver children.
DefaultDataDescriptor
 Inherited
Indica se um objeto tem uma propriedade específica definida.
Object
  
isBranch(node:Object, model:Object = null):Boolean
Testa um node para término.
DefaultDataDescriptor
  
Retorna se o node estiver ativado.
DefaultDataDescriptor
 Inherited
Indica se uma instância da classe Object está na corrente do protótipo do objeto determinado como parâmetro.
Object
  
Retorna se o estado do node for alterado.
DefaultDataDescriptor
 Inherited
Indica se a propriedade especificada existe e se é enumerável.
Object
  
removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
Remove o child node de um node no índice especificado.
DefaultDataDescriptor
  
setEnabled(node:Object, value:Boolean):void
Ajsuta o valor do campo ou atributo no data provider que identifica se o node está ativado.
DefaultDataDescriptor
 Inherited
Determina a disponibilidade de uma propriedade dinâmica para operações em loop.
Object
  
setToggled(node:Object, value:Boolean):void
Ajusta ovalor do campo ou atributo no data provider que identifica se o node está alterado.
DefaultDataDescriptor
 Inherited
Retorna a representação em string de um objeto determinado.
Object
 Inherited
Retorna o valor primitivo de um objeto específico.
Object
Detalhe do Construtor
DefaultDataDescriptor()Construtor
public function DefaultDataDescriptor()

Constructor

Detalhe do Método
addChildAt()método
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

Adiciona um child node a um node no índice especificado. Essa implementação faz o seguinte:

Parâmetros

parent:Object — O objeto node que vai ser parent do child.
 
newChild:Object — O objeto node cujo node será seu parent.
 
index:int — O índice baseado em zero de onde colocar o child node relativo ao parent.
 
model:Object (default = null) — A coleção inteira do qual esse node faz parte.

Retorna
Boolean — true se obteve êxito
getChildren()método 
public function getChildren(node:Object, model:Object = null):ICollectionView

Providencia acesso aos children de um node. Retorna uma coleção de nodes, se existirem. Se o node for um Object, o método retorna o conteúdo do campo do objeto children como sendo um ArrayCollection. Se o node for XML, o método retorna um XMLListCollection contendo os elementos child.

Parâmetros

node:Object — O node atualmente sendo avaliado.
 
model:Object (default = null) — A coleção que contém o node; ignorada por essa classe.

Retorna
ICollectionView — Um objeto contendo esses children nodes.
getData()método 
public function getData(node:Object, model:Object = null):Object

Retorna os dados de um node. Atualmente retorna o node inteiro.

Parâmetros

node:Object — O node atualmente sendo avaliado.
 
model:Object (default = null) — A coleção que contém o node; ignorada por essa classe.

Retorna
Object — O node.
getGroupName()método 
public function getGroupName(node:Object):String

Retorna o nome do grupo de botão de rádio na qual o node pertence, se houver. Esse método é usado pelos controles baseados em menu.

Parâmetros

node:Object — O node pelo qual se deve pegar o nome do grupo.

Retorna
String — O valor do atributo ou campo groupName do node, ou um string vazio se não há tal registro.
getHierarchicalCollectionAdaptor()método 
public function getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView

Retorna uma instância ICollectionView que faz os dados de hierarquia aparecerem como se fossem uma instância linear ICollectionView.

Parâmetros

hierarchicalData:ICollectionView — O dados da hierarquia.
 
uidFunction:Function — Uma função que pega um Object e retorna o UID, em um String. Esse parâmetro geralmente é o método Tree.itemToUID().
 
openItems:Object — Os itens quando abertos ou ajustados para aberto.
 
model:Object (default = null) — A coleção a qual esse node pertence.

Retorna
ICollectionView — Uma instância ICollectionView.
getNodeDepth()método 
public function getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int

Retorna a profundidad do node, significando o número de ancestrais que ele tem.

Parâmetros

node:Object — O Object que define o node.
 
iterator:IViewCursor — Uma instância IViewCursor que poderia ser usada para fazer os cálculos.
 
model:Object (default = null) — A coleção a qual esse node pertence.

Retorna
int — A profundidade do node, onde 0 corresponde ao nível superior, e -1 se a profundidade não pode ser calculada.
getParent()método 
public function getParent(node:Object, collection:ICollectionView, model:Object = null):Object

Returns the parent of the node The parent of a top-level node is null.

Parâmetros

node:Object — O Object que define o node.
 
collection:ICollectionView — Uma instância ICollectionView que pode ser usada para fazer os cálculos.
 
model:Object (default = null) — A coleção a qual esse node pertence.

Retorna
Object — O parent node contendo o node como child, null para um node de nível superior, e undefined se o parent não puder ser determinado.
getType()método 
public function getType(node:Object):String

Retorna o identificador de tipo de um node. Esse método é usado por controles baseados em menu para determinar se o node representa um separado, botão radio, um check box, ou item normal.

Parâmetros

node:Object — O objeto node para qual se deve pegar o tipo.

Retorna
String — O valor do atributo ou campo type, ou o string vazio caso não haja tal campo.
hasChildren()método 
public function hasChildren(node:Object, model:Object = null):Boolean

Retorna true se o node tiver children.

Parâmetros

node:Object — O node atualmente sendo avaliado.
 
model:Object (default = null) — A coleção que contém o node; ignorada por essa classe.

Retorna
Boolean — Boolean indicando se esse node atualmente tem children.
isBranch()método 
public function isBranch(node:Object, model:Object = null):Boolean

Testa um node para término. Branches são sem término mas não é requerido que eles tenham leaf nodes. Se o node for XML, retorna true se o node tiver children ou uma atributo true isBrach. Se o node for um objeto, retorna true se o node tiver um campo (possivelmente vazio) children.

Parâmetros

node:Object — O node atualmente sendo avaliado.
 
model:Object (default = null) — A coleção que contém o node; ignorada por essa classe.

Retorna
Boolean — Boolean indicando se esse node é não-término.
isEnabled()método 
public function isEnabled(node:Object):Boolean

Retorna se o node estiver ativado. Esse método é usado pelos controles baseados em menu.

Parâmetros

node:Object — O node pelo qual se deve pegar o status.

Retorna O
Boolean — valor do atributo ou campo enabled do node, ou true caso não haja registro, ou caso o valor seja false.
isToggled()método 
public function isToggled(node:Object):Boolean

Retorna se o estado do node for alterado. Esse método é usado pelos controles baseados em menu.

Parâmetros

node:Object — O node pelo qual se deve pegar o status.

Retorna
Boolean — O valor do atributo ou campo toggled do node, ou false caso não haja registro.
removeChildAt()método 
public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

Remove o child node de um node no índice especificado. Se o parâmetro parent é null ou undefined, o método usa o parâmetro model para acessar o child; caso contrário, ele usa o parâmetro parent e ignora o parâmetro model.

Parâmetros

parent:Object — O ojeto node que atualmente é parent do chidl node.
 
child:Object — O node que está sendo removido.
 
index:int — O índice baseado em zero de um child node para remover relativo ao parent.
 
model:Object (default = null) — A coleção inteira do qual esse node faz parte.

Retorna
Boolean — true se obteve êxito
setEnabled()método 
public function setEnabled(node:Object, value:Boolean):void

Ajsuta o valor do campo ou atributo no data provider que identifica se o node está ativado. Esse método ajusta o valor do atributo ou campo enabled do node. Esse método é usado pelos controles baseados em menu.

Parâmetros

node:Object — O node para qual se deve ajustar o status.
 
value:Boolean — Se o node está ativado.

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

Ajusta ovalor do campo ou atributo no data provider que identifica se o node está alterado. Esse método ajusta o valor do atributo ou campo toggle do node. Esse método é usado pelos controles baseados em menu.

Parâmetros

node:Object — O node para qual se deve ajustar o status.
 
value:Boolean — Se o node sofrer toggle.