Histórico da Página

XTree(): New ( [ nTop], [ nLeft], [ nWidth], [ nHeight], [ oOwner], [ uChange], [ uRClick] ) --> oObjeto

Nome	Tipo	Descrição	Obrigatório	Referência
nTop	Numérico	Indica a coordenada vertical superior do objeto.
nLeft	Numérico	Indica a coordenada horizontal à esquerda do objeto.
nWidth	Numérico	Indica a coordenada vertical inferior do objeto.
nHeight	Numérico	Indica a coordenada horizontal à direita do objeto.
oOwner	Objeto	Indica a janela ou controle visual onde o objeto será criado.
uChange	Bloco de código	Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual.
uRClick	Bloco de código	Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto.
bDblClick	Bloco de código	Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto.

oObjeto

Retorna o objeto criado.

oTree := xTree():New(000,000,300,300,oDlg,/*uChange*/,/*uRClick*/,/*bDblClick*/)

Métodos

AddItem

Adiciona um item ou subitem na árvore.

XTree(): AddItem ( cPrompt,cCargo,cResource1,cResource2,nType,bAction,bRClick,bDblClick ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
cPrompt	Caracter	Indica a descrição do novo item.	x
cCargo	Caracter	Indica a chave de identificação do item na árvore.	x
cResource1	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver fechado.
cResource2	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver aberto.
nType	Numérico	Indica o nível que o item ou subitem será adicionado, sendo: 1=No mesmo nível ou 2=Abaixo.
bAction	Bloco de código
bRClick	Bloco de código
bDblClick	Bloco de código

Utilizado para adicionar itens dinamicamente na árvore, depois de sua construção. Para adicionar itens durante a criação do objeto, utilize os métodos AddTree e AddTreeItem.

//Adiciona um novo item abaixo do item posicionado.

oTree:AddItem("Novo Item","0106","folder5.png","folder6.png",2,/*bAction*/,/*bRClick*/,/*bDblClick*/)

AddTree

Adiciona um item, com nível 1, na árvore.

XTree(): AddTree ( cPrompt, cResource1, cResource2, cCargo, bAction, bRClick, bDblClick ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
cPrompt	Caracter	Indica a descrição do novo item.
cResource1	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver fechado.
cResource2	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver aberto.
cCargo	Caracter	Indica a chave de identificação do item na árvore.
bAction	Bloco de código
bRClick	Bloco de código
bDblClick	Bloco de código

Utilizado para adicionar um nó na árvore durante a construção do objeto. Para adicionar dinamicamente, utilizar método AddItem.
Após a utilização desse método deve haver a chamada do método EndTree() para fechar o nó construído

//Cria nó na árvore

oTree:AddTree("Nó","folder5.png","folder6.png","0101",/*bAction*/,/*bRClick*/,/*bDblClick*/)

 //Adiciona filhos
 oTree:AddTreeItem("Nó filho","folder5.png","0102",/*bAction*/,/*bRClick*/,/*bDblClick*/)

//Fecha nó criado
oTree:EndTree()

AddTreeItem

Adiciona um item, na árvore.

XTree(): AddTreeItem ( cPrompt, cResource, cCargo, bAction, bRClick, bDblClick )

Nome	Tipo	Descrição	Obrigatório	Referência
cPrompt	Caracter	Indica a descrição do novo item.
cResource	Caracter	Indica o nome da imagem no repositório.
cCargo	Caracter	Indica a chave de identificação do elemento na árvore.
bAction
bRClick
bDblClick

Utilizado para adicionar um item no nó da árvore aberto durante a construção do objeto. Para adicionar dinamicamente, utilizar método AddItem.

//Cria nó na árvore

oTree:AddTree("Nó","folder5.png","folder6.png","0101",/*bAction*/,/*bRClick*/,/*bDblClick*/)

 //Adiciona filhos
 oTree:AddTreeItem("Nó filho","folder5.png","0102",/*bAction*/,/*bRClick*/,/*bDblClick*/)

//Fecha nó criado
oTree:EndTree()

ChangeBmp

Altera as imagens definidas para a árvore.

XTree(): ChangeBmp ( cResource1, cResource2, cCargo, lForceUpdate)

Nome	Tipo	Descrição	Obrigatório	Referência
cResource1	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver fechado.
cResource2	Caracter	Indica o nome da imagem, no repositório, que será apresentada quando o item estiver aberto.
cCargo	Caracter	Indica a chave de identificação do item na árvore.
lForceUpdate	Lógico

oTree:ChangeBmp("LBNO","LBTIK","01")

ChangePrompt

Altera a descrição de um item da árvore.

XTree(): ChangePrompt ( [ cPrompt], [ cCargo] ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
cPrompt	Caracter	Indica a nova descrição do item.
cCargo	Caracter	Indica a chave de identificação do item na árvore.

Pode se utilizar em conjunto com o método GetCargo para alterar a descrição do item atual.

oTree:ChangePrompt("Novo Texto Item 001","001")

DelItem

DeItem

Exclui o item selecionado e, consequentemente, todos os seus subitens.

DBTreeXTree(): DelItem DeItem ( ) -->

oTree:DelItem()

EndTree

Indica o término da contrução da árvore.

DBTreeXTree(): EndTree ( ) -->

oTree:EndTree()

EndUpdate

Encerra a criação dos itens.

DBTree

()

: EndUpdate ( ) -->

Este método é muito importante na criação do objeto para que os ajustes de criação e performance sejam realizados corretamente.

oTree:EndUpdate()

GetCargo

Retorna a chave de identificação do item selecionado.

DBTreeXTree(): GetCargo ( ) --> cCargo

cCargo

Indica a chave de identificação do item selecionado na árvore.

oTree:GetCargo()

GetPrompt

GetFatherNode

Retorna

a descrição do item selecionado

informações do nó pai.

DBTree

XTree():

GetPrompt

GetFatherNode(

[ lSpace]

) -->

cPrompt

aFather

aFather

(array)

Retorna vetor com informações do nó pai no seguinte formato:
1. Caracter
2. Caracter
3. L[ogico

oTree:GetFatherNode()

GetPrompt

Retorna a descrição do item selecionado.

XTree(): GetPrompt ( ) --> cPrompt

Nome	Tipo	Descrição	Obrigatório	Referência
lSpace	Lógico	Indica se, verdadeiro (.T.), retorna a descrição com os espaços ou, falso (.F.), se retira os espaços à direita e à esquerda da descrição.

cPrompt

Retorna a descrição do item selecionado.

A opção de múltiplas colunas definidas pelo parâmetro cHeaders do construtor New do objeto e alimentadas por valores separados por ponto e vírgula do parâmetro cPrompt deste método, está disponível somente em builds superiores à 7.00.120420A.

oTree:GetPrompt(.T.) // Result: "Subnível 01"

IsEmpty

oTree:GetPrompt()

IsEmpty

Indica se existem

IsEmpty

Indica se existem itens na árvore.

DBTreeXTree(): IsEmpty ( ) --> lIsEmpty

lIsEmpty

Retorna, verdadeiro (.T.), se a árvore estiver vazia; caso contrário, retornará falso (.F.).

oTree:IsEmpty() // Result: .F.

Nivel

Reset

Limpa todos os itens da árvore

Nivel

Retorna o nível do item selecionado

.

DBTreeXTree(): Nivel Reset ( ) --> nNivel

Observações Retorno

nNivel

oTree:Reset()

Retorna o nível do item selecionado, sendo que o primeiro item estará no nível 1, seus filhos no nível 2 e assim sucessivamente.

oTree:Nivel() // Result: 3

Preview

Exemplo do método Nivel

Image Removed

PTRefresh

Atualiza todos os níveis da árvore.

DBTree(): PTRefresh ( ) -->

oTree:PTRefresh()

PTSendTree

Permite realizar a construção inicial, da classe DBTree(), a partir de um array pré-definido.

DBTree(): PTSendTree ( < aNodes> ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
aNodes	Vetor	Indica o array pré-definido com informações para criar a árvore. Para mais informações referente ao formato do array, consulte a área Observações.	X

Disponibilidade
Método disponível a partir da build 7.00.080806P.

Formato do array para criação dos itens da classe DBTree()

Nível do item (Caracter).
ID que identificará este item (Caracter).
Compatibilidade. Configure sempre com aspas "" (Caracter).
Descrição que será apresentada no item (Caracter).
Imagem quando o item da árvore estiver fechado (Caracter).
Imagem quando o item da árvore estiver aberto (Caracter).

Dicas de utilização do método

Este método foi desenvolvido para acelerar a criação da árvore. No entanto, para que funcione corretamente, é necessário seguir as seguintes regras na criação do array:

Os itens devem ser criados na ordem exata que serão apresentados.
Os níveis devem ser inseridos de acordo com a posição do item.

No exemplo abaixo, observe a maneira correta de alimentar o array:

// ExemploDEFINE DIALOG oDlg TITLE "Exemplo do PTSendTree" FROM 180,180 TO 550,700 PIXELIMAGE1 := "FOLDER5"IMAGE2 := "FOLDER6"aNodes := {}aadd(aNodes,{'00',"001","","Descrição Raiz",IMAGE1,IMAGE2})         // Raizaadd(aNodes,{'01',"002","","Descrição Subnível 01",IMAGE1,IMAGE2}) // Segundo nívelaadd(aNodes,{'02',"003","","Descrição Subnível 02",IMAGE1,IMAGE2}) // Terceiro nívelaadd(aNodes,{'01',"004","","Descrição Subnível 01",IMAGE1,IMAGE2}) // Segundo nívelaadd(aNodes,{'02',"005","","Descrição Subnível 02",IMAGE1,IMAGE2}) // Terceiro nível// Cria o objeto Tree e carrega os itensoTree := DbTree():New(0,0,160,260,oDlg,,,.T.)oTree:PTSendTree( aNodes )ACTIVATE DIALOG oDlg CENTERED

Visualização
Image Removed

#include "TOTVS.CH"User Function PTSendTree()Local nX,nY,nZDEFINE DIALOG oDlg TITLE "Exemplo do PTSendTree" FROM 180,180 TO 550,700 PIXELaNodes := {}IMAGE1  := "" 	// Imagem quando nível estiver fechadoIMAGE2  := "" 	// Imagem quando nível estiver abertonLoop   := 690  // Quantidade de Loops - irá gerar 20010 ItensnCount	:= 0	// Simula ID dos itens da Tree//cTime1 := Time()// PRIMEIRO NÍVELfor nX := 1 to nLoop		nCount++	IMAGE1 := "FOLDER5"	aadd( aNodes, {'00', StrZero(nCount,7), "", "Primeiro Nível->ID: "+;	StrZero(nCount,7), IMAGE1, IMAGE2} )		// SEGUNDO NÍVEL	for nY := 1 to 7				nCount++		IMAGE1 := "FOLDER6"		aadd( aNodes, {'01', StrZero(nCount,7), "", "Segundo Nível->ID: "+;		StrZero(nCount,7), IMAGE1, IMAGE2} )				// TERCEIRO NÍVEL		for nZ := 1 to 3						nCount++			IMAGE1 := "FOLDER10"			aadd( aNodes, {'02',StrZero(nCount,7),"","Terceiro Nível->ID: "+;			StrZero(nCount,7), IMAGE1, IMAGE2} )					next nZ			next nY	next nX// Cria o objeto TreeoTree := DbTree():New(0,0,160,260,oDlg,,,.T.)// Método para carga dos itens da TreeoTree:PTSendTree( aNodes )ACTIVATE DIALOG oDlg CENTEREDReturn

PTSrvUpdatePosition

Sincroniza as informações entre o objeto Tree, no Smart Client, e o Application Server.

DBTree(): PTSrvUpdatePosition ( ) -->

oTree:PTSrvUpdatePosition()

PTUpdateNodes

Atualiza o item e seus subitens.

DBTree(): PTUpdateNodes ( < cNivel> ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
cNivel	Caracter	Indica o nível que será atualizado.	X

oTree:PTUpdateNodes( "005" )

Reset

Limpa todos os itens da árvore.

DBTree(): Reset ( ) -->

oTree:Reset()

SetDisable

Desabilita a utilização da árvore.

DBTree(): SetDisable ( ) -->

oTree:SetDisable()

SetEnable

Habilita a utilização da árvore.

DBTree(): SetEnable ( ) -->

oTree:SetEnable()

SetFlags

Habilita/Desabilita certas funcionalidades do componente.

DBTree(): SetFlags( <nFlags> ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
nFlags	Numérico	Valor que representa a(s) funcionalidade(s) a ser(em) habilitada(s). Valores de flags podem ser somados para que mais de uma funcionalidade seja habilitada ao mesmo tempo.	X

Comandos	Descrição
1 (TTREE_ISEDITABLE)	Habilita edição do texto (prompt) dos itens.

Este método está disponível somente em builds superiores à build 7.00.120420A

#define TTREE_ISEDITABLE     1

oTree:SetFlags( TTREE_ISEDITABLE ) // Habilita possibilidade de edição do Prompt de cada item da árvore

SetScroll

Define a barra de rolagem da árvore.

DBTree(): SetScroll ( < nTipo>, < lHabilita> ) -->

Nome	Tipo	Descrição	Obrigatório	Referência
nTipo	Numérico	Indica o tipo (1=horizontal e 2=vertical) da barra de rolagem.	X
lHabilita	Lógico	Indica se habilita (.T.) ou desabilita (.F.) a barra de rolagem.	X

oTree:SetScroll(1,.T.) // Habilita barra de rolagem horizontaloTree:SetScroll(2,.T.) // Habilita barra de rolagem vertical

Total

Retorna o número de itens na árvore.

DBTree(): Total ( ) --> nItens

nItens

()

Retorna o número de itens na árvore.

oTree:Total() // Result: 8

TreeSeek

Localiza e posiciona o cursor em um determinado elemento.

DBTree(): TreeSeek ( < cCargo> ) --> lFind

Nome	Tipo	Descrição	Obrigatório	Referência
cCargo	Caracter	Indica a chave de identificação do elemento na árvore.	X

lFind

(logico)

Retorna, verdadeiro (.T.), se o cargo for localizado; caso contrário, retornará falso (.F.)

// Localiza o Cargo 001 e posiciona o cursor// para que o segundo nível seja criado abaixo dele// -----------------------------------------------------if oTree:TreeSeek("001")   oTree:AddItem("Segundo nível da DBTree","002", "FOLDER10",,,,2)	endif

Propriedade

Propriedade	Descrição	Tipo
aBmps	Indica o array que contêm as imagens dos itens do objeto.	Vetor
bInit	Indica o bloco de código que será executado na inicialização do objeto.	Bloco de código
lActivated	Indica se, verdadeiro (.T.), o objeto está ativo; caso contrário, falso (.F.).	Lógico
lCargo	Indica se, verdadeiro (.T.), os elementos da Tree utilizarão a propriedade cCargo, do método AddItem(), que armazena uma string identificadora, para cada elemento e item da árvore; caso contrário, falso (.F.).	Lógico
lEnable	Indica se, verdadeiro (.T.), o objeto está habilitado; caso contrário, falso (.F.).	Lógico
lProcess	Indica se, verdadeiro (.T.), o objeto está sendo atualizado; caso contrário, falso (.F.).	Lógico
lRefreshing	Indica se, verdadeiro (.T.), o objeto está sendo atualizado; caso contrário, falso (.F.).	Lógico
nTotal	Indica o total de itens do objeto.	Numérico
bPromptChanged	Indica o bloco de código, no formato {\|cID, nColumn, cNewPrompt\| }, que será executado quando um prompt for editado na Tree pelo usuário. O cID conterá o Cargo (valor identificador do item), nColumn a coluna e cNewPrompt o novo prompt do item. Disponível somente em builds superiores à build 7.00.120420A.	Bloco de código
nColumns	Retorna a quantidade de colunas do objeto. Disponível somente em builds superiores à build 7.00.120420A.	Numérico

Caso seja informada uma quantidade menor de colunas para um item do que a quantidade determinada no construtor do objeto, as colunas serão criadas automaticamente em branco, para que o item respeite a quantidade definida no construtor. Colunas excedentes de um item serão descartadas.
É possível definir a quantidade de colunas do objeto sem que o cabeçalho seja exibido. Para isto, basta informar somente os delimitadores, como por exemplo ";;;" para quatro colunas.
É importante utilizar os métodos BeginUpdate(), para iniciar a criação do objeto, e EndUpdate(), ao término, para que os ajustes de performance e criação sejam realizados corretamente.

TreeSeek

Localiza e posiciona o cursor em um determinado elemento.

XTree(): TreeSeek ( < cCargo> ) --> lFind

Nome	Tipo	Descrição	Obrigatório	Referência
cCargo	Caracter	Indica a chave de identificação do elemento na árvore.	X

lFind

(logico)

Retorna, verdadeiro (.T.), se o cargo for localizado; caso contrário, retornará falso (.F.)

// Localiza o Cargo 001 e posiciona o cursor

// para que o segundo nível seja criado abaixo dele

// -----------------------------------------------------

if oTree:TreeSeek("001")

oTree:AddItem("Segundo nível da DBTree","002",

A seguir, veja o código fonte exemplo:

oTree := DbTree():New(0,0,160,260,oDlg,,,.T.,,) // Cria a TreeoTree:BeginUpdate() // Prepara o objeto para receber os itensoTree:SetScroll(1,.T.) // Habilita a barra de rolagem horizontaloTree:SetScroll(2,.T.) // Habilita a barra de rolagem vertical for nX := 1 to 5 id++ cId := strZero(id,7) oTree:AddItem("Primeiro Nível: "+cId,cId, "FOLDER5" ,"FOLDER6",,,1) If oTree:TreeSeek(cId) for nY := 1 to 10 id++ cId := strZero(id,7) oTree:AddItem("Subnível:"+cId,cId,

 "FOLDER10",,,,2)

next endif next oTree:EndUpdate() // Finaliza a criação dos itens

endif