csbase.client.project

Class ProjectTree

java.lang.Object

csbase.client.project.ProjectTree

All Implemented Interfaces:

ProjectFileContainer

Direct Known Subclasses:

BasicProjectTree

public class ProjectTree
extends java.lang.Object
implements ProjectFileContainer

A classe modela uma árvore de diretórios de um projeto. A representação usa uma JTree que pode ser recuperada com o método getTree().

É possível definir quais arquivos serão visualizados através da árvore e quais arquivos poderão ser selecionados. Para fazer essa filtragem, deve-se utilizar objetos do pacote csbase.logic.filters

Author:

Tecgraf

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deleteEnabled Indica se a remoção de arquivos está habilitada.
protected boolean	refreshEnabled Indica se a atualização de diretórios e do projeto está habilitada.
protected boolean	renameEnabled Indica se a edição de nomes de arquivos está habilitada.
protected boolean	transferEnabled Indica se a transferência de arquivos está habilitada.

Fields inherited from interface csbase.client.project.ProjectFileContainer

MIME_FOR_PROJECT_FILE, PROJECT_FILE_FLAVOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProjectTree(java.awt.Window owner, java.lang.String title) Cria a árvore de projetos.
protected	ProjectTree(java.awt.Window owner, java.lang.String title, csbase.logic.CommonClientProject project) Cria a árvore de projetos que representará o projeto recebido.
protected	ProjectTree(java.awt.Window owner, java.lang.String title, csbase.logic.CommonClientProject project, csbase.logic.ProjectFileFilter visualFilter) Cria a árvore de projetos que representará o projeto recebido.
protected	ProjectTree(java.awt.Window owner, java.lang.String title, csbase.logic.CommonClientProject project, csbase.logic.ProjectFileFilter visualFilter, csbase.logic.ProjectFileFilter selectionFilter) Cria a árvore de projetos que representará o projeto recebido.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener() Adiciona o MouseListener da Tree
void	addProjectTreeListener(ProjectTreeListener listener) Adiciona um listener de projeto.
void	addTreeModelListener(javax.swing.event.TreeModelListener listener) Adiciona listener de modificação do modelo da árvore.
boolean	addTreeSelectionListener(ProjectTreeSelectionListener listener) Adiciona um ouvinte que está interessado em mudanças na seleção da árvore.
void	clearClipboard() Limpa a área de clipboard.
void	clearSelection() Limpa a seleção da árvore.
void	closeProject() Fecha o projeto corrente.
protected boolean	doubleClickIntercepted(csbase.logic.ClientProjectFile file) Método de interceptação de arquivo acionado (duplo-clique) na árvore de projetos, para que cada sistema possa eventualmente redefinir a ação para outra coisa além de simplesmente abrir o mesmo com uma aplicação correspondente.
void	enableDeleteAction(boolean enable) Habilita/desabilita a remoção de arquivos usando a tecla DELETE.
void	enableRefreshAction(boolean enable) Habilita/desabilita a atualização da árvore de projetos usando a tecla F5.
void	enableRenameAction(boolean enable) Habilita/desabilita edição nos nós da árvore.
void	enableTransferAction(boolean enable) Habilita/desabilita a transferência de arquivos por drag&drop e clipboard.
csbase.logic.filetypefinder.FileTypeFinder	getFileTypeFinder() Retorna o buscador (por inferência) de tipo de arquivo que, por default, é nulo (null); mas pode ser redefinido pelos sistemas para seus tipos de arquivos.
java.util.Vector<ProjectTreeListener>	getListeners() Obtem os listeners interessados em mudanças na árvore
javax.swing.JPopupMenu	getPopupDir() Obtem o menu pop-up de diretórios.
javax.swing.JPopupMenu	getPopupFile() Obtem o menu pop-up de arquivos
javax.swing.JPopupMenu	getPopupMultSelection() Obtem o menu pop-up de seleção múltipla.
javax.swing.JPopupMenu	getPopupRoot() Obtem o menu pop-up da raíz
csbase.logic.CommonClientProject	getProject() Obtém o projeto da árvore.
csbase.logic.ClientProjectFile	getSelectedFile() Obtem o arquivo selecionado na árvore.
csbase.logic.ClientProjectFile[]	getSelectedFiles() Obtém os arquivos atualmente selecionados na árvore.
int	getSelectionCount()
java.lang.String	getTitle() Obtém o título da árvore.
javax.swing.JTree	getTree() Obtém o componente de interface que apresenta a árvore de diretórios.
java.awt.Window	getWindow() Obtém a janela onde essa árvore está sendo exibida.
boolean	hasFileToPaste() Indica se existem arquivos na árvore marcados para copy.
void	release() Liberação da visualização da árvore.
void	removeProjectTreeListener(ProjectTreeListener listener) Remove um listener de seleção da projeto.
void	removeTreeModelListener(javax.swing.event.TreeModelListener listener) Retira listener de modificação do modelo da árvore.
boolean	removeTreeSelectionListener(ProjectTreeSelectionListener listener) Remove um ouvinte que estava interessado em mudanças na seleção da árvore.
void	repaint()
void	resetProject() Limpa a árvore que está sendo apresentada.
void	setComparator(java.util.Comparator<ProjectTreeNode> comparator) Modifica a forma como os nós da árvore são ordenados.
void	setOutOfDate()
void	setPopupDir(javax.swing.JPopupMenu popupDir) Atribui um menu pop-up para diretórios.
void	setPopupFile(javax.swing.JPopupMenu popupFile) Atribui um menu pop-up para arquivos.
void	setPopupMultSelection(javax.swing.JPopupMenu popupMultSelection) Atribui um menu pop-up para seleção múltipla.
void	setPopupRoot(javax.swing.JPopupMenu popupRoot) Atribui um menu de pop-up para a raíz da árvore.
void	setProject(csbase.logic.CommonClientProject newProject) Modifica o conteúdo da árvore que está sendo visualizada, a partir da raiz.
void	setSelectedFile(csbase.logic.ClientProjectFile file) Seleciona o arquivo ou diretório especificado na árvore
void	setSelectionFilter(csbase.logic.ProjectFileFilter filter) Ajusta filtro de seleção.
void	setSelectionPath(java.lang.String[] selectedPath) Seleciona o caminho escolhido do diretório dentro da árvore de projeto.
void	setSelectionPath(javax.swing.tree.TreePath selectedPath) Seleciona o caminho escolhido do diretório dentro da árvore de projeto
void	setSingleSelectionMode(boolean singleSelection) Determina se a árvore possui seleção simples ou seleção múltipla.
void	setVisualFilter(csbase.logic.ProjectFileFilter filter) Define o filtro de visualização da árvore.
void	startCopyAction() Copia os arquivos selecionados para o clipboard.
void	startCutAction() Recorta os arquivos selecionados para o clipboard.
void	startPasteAction() Transfere os arquivos que estão no clipboard.
void	startRenamingAction() Inicia a edição de um nome de um arquivo ou diretório da árvore.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

transferEnabled

protected boolean transferEnabled

Indica se a transferência de arquivos está habilitada.

deleteEnabled

protected boolean deleteEnabled

Indica se a remoção de arquivos está habilitada.

renameEnabled

protected boolean renameEnabled

Indica se a edição de nomes de arquivos está habilitada.

refreshEnabled

protected boolean refreshEnabled

Indica se a atualização de diretórios e do projeto está habilitada.

Constructor Detail

ProjectTree

protected ProjectTree(java.awt.Window owner,
                      java.lang.String title)

Cria a árvore de projetos. A árvore estará vazia, pois não representará nenhum projeto. Para configurar um projeto, utilize o método setProject(CommonClientProject).

Parameters:

owner - A janela pai onde a árvore será exibida.

title - O título da janela pai.

ProjectTree

protected ProjectTree(java.awt.Window owner,
                      java.lang.String title,
                      csbase.logic.CommonClientProject project)

Cria a árvore de projetos que representará o projeto recebido.

Parameters:

owner - A janela pai onde a árvore será exibida.

title - O título da janela pai.

project - O projeto que será representado.

ProjectTree

protected ProjectTree(java.awt.Window owner,
                      java.lang.String title,
                      csbase.logic.CommonClientProject project,
                      csbase.logic.ProjectFileFilter visualFilter)

Cria a árvore de projetos que representará o projeto recebido. Só serão apresentados na árvore os arquivos do projeto que são aceitos pelo filtro.

Parameters:

owner - A janela pai onde a árvore será exibida.

title - O título da janela pai.

project - O projeto que será representado.

visualFilter - O filtro de visualização.

ProjectTree

protected ProjectTree(java.awt.Window owner,
                      java.lang.String title,
                      csbase.logic.CommonClientProject project,
                      csbase.logic.ProjectFileFilter visualFilter,
                      csbase.logic.ProjectFileFilter selectionFilter)

Cria a árvore de projetos que representará o projeto recebido. Só serão apresentados na árvore os arquivos do projeto que são aceitos pelo filtro de visualização. Só poderão ser selecionados os arquivos do projeto que estejam sendo exibidos e que sejam aceitos pelo filtro de seleção.

Parameters:

owner - A janela pai onde a árvore será exibida.

title - O título da janela pai.

project - O projeto que será representado.

visualFilter - O filtro de visualização.

selectionFilter - O filtro de seleção.

Throws:

java.lang.IllegalArgumentException - Caso a janela ou o título da janela sejam nulos (null).

Method Detail

setPopupRoot

public void setPopupRoot(javax.swing.JPopupMenu popupRoot)

Atribui um menu de pop-up para a raíz da árvore.

Parameters:

popupRoot - O menu pop-up da raíz.

getPopupRoot

public javax.swing.JPopupMenu getPopupRoot()

Obtem o menu pop-up da raíz

Returns:

O menu pop-up da raíz.

setPopupFile

public void setPopupFile(javax.swing.JPopupMenu popupFile)

Atribui um menu pop-up para arquivos.

Parameters:

popupFile - O menu pop-up de arquivos.

getPopupFile

public javax.swing.JPopupMenu getPopupFile()

Obtem o menu pop-up de arquivos

Returns:

O menu pop-up de arquivos.

setPopupMultSelection

public void setPopupMultSelection(javax.swing.JPopupMenu popupMultSelection)

Atribui um menu pop-up para seleção múltipla.

Parameters:

popupMultSelection - O menu pop-up para seleção múltipla.

getPopupMultSelection

public javax.swing.JPopupMenu getPopupMultSelection()

Obtem o menu pop-up de seleção múltipla.

Returns:

O menu pop-up de seleção múltipla.

setPopupDir

public void setPopupDir(javax.swing.JPopupMenu popupDir)

Atribui um menu pop-up para diretórios.

Parameters:

popupDir - O menu pop-up para diretórios.

getPopupDir

public javax.swing.JPopupMenu getPopupDir()

Obtem o menu pop-up de diretórios.

Returns:

O menu pop-up de diretórios.

getWindow

public java.awt.Window getWindow()

Obtém a janela onde essa árvore está sendo exibida.

Specified by:

getWindow in interface ProjectFileContainer

Returns:

A janela pai dessa árvore.

getTitle

public java.lang.String getTitle()

Obtém o título da árvore.

Specified by:

getTitle in interface ProjectFileContainer

Returns:

O título da árvore.

getTree

public javax.swing.JTree getTree()

Obtém o componente de interface que apresenta a árvore de diretórios.

Returns:

O componente de interface de visualização da árvore.

clearSelection

public void clearSelection()

Limpa a seleção da árvore.

Specified by:

clearSelection in interface ProjectFileContainer

addTreeSelectionListener

public boolean addTreeSelectionListener(ProjectTreeSelectionListener listener)

Adiciona um ouvinte que está interessado em mudanças na seleção da árvore.

Parameters:

listener - O ouvinte a ser adicionado.

Returns:

true, se conseguiu adicioná-lo, false, caso contrário.

Throws:

java.lang.IllegalArgumentException - Caso seja recebido um ouvinte nulo.

removeTreeSelectionListener

public boolean removeTreeSelectionListener(ProjectTreeSelectionListener listener)

Remove um ouvinte que estava interessado em mudanças na seleção da árvore.

Parameters:

listener - O ouvinte a ser removido.

Returns:

true, se conseguiu removê-lo, false, caso contrário.

addTreeModelListener

public void addTreeModelListener(javax.swing.event.TreeModelListener listener)

Adiciona listener de modificação do modelo da árvore.

Parameters:

listener - listener

removeTreeModelListener

public void removeTreeModelListener(javax.swing.event.TreeModelListener listener)

Retira listener de modificação do modelo da árvore.

Parameters:

listener - listener

getListeners

public java.util.Vector<ProjectTreeListener> getListeners()

Obtem os listeners interessados em mudanças na árvore

Returns:

.

setSelectionPath

public void setSelectionPath(java.lang.String[] selectedPath)

Seleciona o caminho escolhido do diretório dentro da árvore de projeto. Deve-se fornecer null quando se deseja selecionar a raiz do projeto. Quando se deseja selecionar um diretório dentro do proejto, o caminho a ser usado NÃO deve incluir o diretório com o nome do projeto (raiz).

Parameters:

selectedPath - O caminho na árvore de projeto.

setSelectionPath

public void setSelectionPath(javax.swing.tree.TreePath selectedPath)

Seleciona o caminho escolhido do diretório dentro da árvore de projeto

Parameters:

selectedPath - O componente que representa o caminho na árvore de projeto.

getProject

public csbase.logic.CommonClientProject getProject()

Obtém o projeto da árvore.

Specified by:

getProject in interface ProjectFileContainer

Returns:

O projeto.

setComparator

public void setComparator(java.util.Comparator<ProjectTreeNode> comparator)

Modifica a forma como os nós da árvore são ordenados. Existem dois tipos de ordenação padrão: por nome (feito pelo comparador ProjectTreeNodeNameComparator) e por extensão (feito pelo comparador ProjectTreeNodeExtensionComparator).

Parameters:

comparator -

setProject

public void setProject(csbase.logic.CommonClientProject newProject)

Modifica o conteúdo da árvore que está sendo visualizada, a partir da raiz.

Parameters:

newProject - O novo projeto a ser apresentado pela árvore.

resetProject

public void resetProject()

Limpa a árvore que está sendo apresentada.

closeProject

public void closeProject()

Fecha o projeto corrente.

Throws:

java.lang.IllegalStateException - Caso não exista projeto aberto.

setSingleSelectionMode

public void setSingleSelectionMode(boolean singleSelection)

Determina se a árvore possui seleção simples ou seleção múltipla.

Parameters:

singleSelection - true, se a árvore possui seleção simples ou false, se possui seleção múltipla.

getSelectedFile

public csbase.logic.ClientProjectFile getSelectedFile()

Obtem o arquivo selecionado na árvore.

Specified by:

getSelectedFile in interface ProjectFileContainer

Returns:

O arquivo selecionado. Caso não exista arquivo selecionado ou não exista projeto aberto, retornará null.

getSelectedFiles

public csbase.logic.ClientProjectFile[] getSelectedFiles()

Obtém os arquivos atualmente selecionados na árvore.

Specified by:

getSelectedFiles in interface ProjectFileContainer

Returns:

Os arquivos selecionados na árvore. Caso não existam arquivo selecionados ou não exista projeto aberto, retornará null.

setOutOfDate

public void setOutOfDate()

enableTransferAction

public void enableTransferAction(boolean enable)

Habilita/desabilita a transferência de arquivos por drag&drop e clipboard.

Specified by:

enableTransferAction in interface ProjectFileContainer

Parameters:

enable - true, para habilitar a transferência, ou false, caso contrário.

enableRenameAction

public void enableRenameAction(boolean enable)

Habilita/desabilita edição nos nós da árvore. Usado para renomear os arquivos de projeto.

Specified by:

enableRenameAction in interface ProjectFileContainer

Parameters:

enable - true, para habilitar a edição, ou false, caso contrário.

startRenamingAction

public void startRenamingAction()

Inicia a edição de um nome de um arquivo ou diretório da árvore.

Specified by:

startRenamingAction in interface ProjectFileContainer

startCutAction

public void startCutAction()

Recorta os arquivos selecionados para o clipboard.

Specified by:

startCutAction in interface ProjectFileContainer

startCopyAction

public void startCopyAction()

Copia os arquivos selecionados para o clipboard.

Specified by:

startCopyAction in interface ProjectFileContainer

startPasteAction

public void startPasteAction()

Transfere os arquivos que estão no clipboard.

Specified by:

startPasteAction in interface ProjectFileContainer

enableDeleteAction

public void enableDeleteAction(boolean enable)

Habilita/desabilita a remoção de arquivos usando a tecla DELETE.

Specified by:

enableDeleteAction in interface ProjectFileContainer

Parameters:

enable - se true, habilita; caso contrário, desabilita.

enableRefreshAction

public void enableRefreshAction(boolean enable)

Habilita/desabilita a atualização da árvore de projetos usando a tecla F5.

Specified by:

enableRefreshAction in interface ProjectFileContainer

Parameters:

enable - se true, habilita; caso contrário, desabilita.

clearClipboard

public void clearClipboard()

Limpa a área de clipboard.

Specified by:

clearClipboard in interface ProjectFileContainer

setVisualFilter

public void setVisualFilter(csbase.logic.ProjectFileFilter filter)

Define o filtro de visualização da árvore.

Parameters:

filter - filtro (pode ser null)

setSelectionFilter

public void setSelectionFilter(csbase.logic.ProjectFileFilter filter)

Ajusta filtro de seleção.

Parameters:

filter - filtro

addMouseListener

public void addMouseListener()

Adiciona o MouseListener da Tree

doubleClickIntercepted

protected boolean doubleClickIntercepted(csbase.logic.ClientProjectFile file)

Método de interceptação de arquivo acionado (duplo-clique) na árvore de projetos, para que cada sistema possa eventualmente redefinir a ação para outra coisa além de simplesmente abrir o mesmo com uma aplicação correspondente. Ao retornar true, nada mais será feito após a interceptação.

Parameters:

file - arquivo da árvore de projeto

Returns:

indicativo de interceptação.

addProjectTreeListener

public void addProjectTreeListener(ProjectTreeListener listener)

Adiciona um listener de projeto. Sempre que o projeto da árvore for modificado, os listeners são notificados.

Parameters:

listener - Um listener de seleção a ser incluído.

removeProjectTreeListener

public void removeProjectTreeListener(ProjectTreeListener listener)

Remove um listener de seleção da projeto.

Parameters:

listener - Um listener de seleção a ser removido.

hasFileToPaste

public boolean hasFileToPaste()

Indica se existem arquivos na árvore marcados para copy.

Returns:

.

setSelectedFile

public void setSelectedFile(csbase.logic.ClientProjectFile file)

Seleciona o arquivo ou diretório especificado na árvore

Parameters:

file - arquivo a ser selecionado

getSelectionCount

public int getSelectionCount()

Specified by:

getSelectionCount in interface ProjectFileContainer

repaint

public void repaint()

Specified by:

repaint in interface ProjectFileContainer

release

public void release()

Liberação da visualização da árvore. Descadastra o observador de alterações da árvore do projeto.

getFileTypeFinder

public csbase.logic.filetypefinder.FileTypeFinder getFileTypeFinder()

Retorna o buscador (por inferência) de tipo de arquivo que, por default, é nulo (null); mas pode ser redefinido pelos sistemas para seus tipos de arquivos.

Returns:

o buscador