csbase.client.project

Class AbstractProjectFileTransferHandler

java.lang.Object

javax.swing.TransferHandler

csbase.client.project.AbstractProjectFileTransferHandler

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ProjectTreeTransferHandler

public abstract class AbstractProjectFileTransferHandler
extends javax.swing.TransferHandler

Author:

TecMSV

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.TransferHandler

javax.swing.TransferHandler.DropLocation, javax.swing.TransferHandler.TransferSupport

Field Summary

Fields inherited from class javax.swing.TransferHandler

COPY, COPY_OR_MOVE, LINK, MOVE, NONE

Constructor Summary

Constructors

Constructor and Description
AbstractProjectFileTransferHandler(java.awt.Window ownerWindow, java.lang.String ownerTitle) Constrói um handler de transferência de objetos de uma árvore de projeto.

Method Summary

Modifier and Type	Method and Description
boolean	canImport(javax.swing.JComponent c, java.awt.datatransfer.DataFlavor[] flavor)
void	clearClipboard() Limpa a área de transferência caso esteja ocorrendo uma transferência que tenha sido iniciada por uma ação de COPY/PASTE.
java.awt.datatransfer.Transferable	createTransferable(javax.swing.JComponent dragSource) Cria uma representação do objeto que vai ser transferido durante uma operação de drag&drop ou através do clipboard.
void	exportAsDrag(javax.swing.JComponent source, java.awt.event.InputEvent event, int action) É chamada ao início de uma ação de Drag.
protected void	exportDone(javax.swing.JComponent source, java.awt.datatransfer.Transferable data, int action) Este método deveria apenas remover os dados de origem após uma importação bem sucedida no caso de uma ação de mover (MOVE), porém como as ações rodam dentro de uma thread, este método não teria como saber se a importação foi bem sucedida ou não para então remover o dado original.
void	exportToClipboard(javax.swing.JComponent source, java.awt.datatransfer.Clipboard clip, int action) É chamada ao início de uma ação de transferência para o clipboard.
protected abstract csbase.logic.ClientProjectFile	getDestinationDirectory(javax.swing.JComponent destination)
protected abstract csbase.logic.ClientProjectFile[]	getFilesToExport(javax.swing.JComponent source)
int	getSourceActions(javax.swing.JComponent c) Obtém os tipos de ação de transferência suportados pela árvore de projeto.
boolean	hasTransferableInClipboard()
boolean	importData(javax.swing.JComponent destination, java.awt.datatransfer.Transferable data) Este método deveria implementar a importação dos dados na fonte do drop, porém como as ações rodam dentro de uma thread, a ação de mover não poderia ser quebrada em importar(importData)+remover(exportDone), pois se um erro ocorresse durante a importação, a etapa de remover ocorreria em seguida e os dados seriam perdidos.

Methods inherited from class javax.swing.TransferHandler

canImport, getCopyAction, getCutAction, getDragImage, getDragImageOffset, getPasteAction, getVisualRepresentation, importData, setDragImage, setDragImageOffset

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProjectFileTransferHandler

public AbstractProjectFileTransferHandler(java.awt.Window ownerWindow,
                                          java.lang.String ownerTitle)

Constrói um handler de transferência de objetos de uma árvore de projeto.

Parameters:

ownerWindow - A janela sobre a qual uma DesktopTask deve ser efetuada.

ownerTitle - O título da janela de DesktopTask

Method Detail

hasTransferableInClipboard

public boolean hasTransferableInClipboard()

Returns:

true se existe um arquivo para ser copiado/movido.

clearClipboard

public void clearClipboard()

Limpa a área de transferência caso esteja ocorrendo uma transferência que tenha sido iniciada por uma ação de COPY/PASTE.

getSourceActions

public int getSourceActions(javax.swing.JComponent c)

Obtém os tipos de ação de transferência suportados pela árvore de projeto. Pode ser COPY ou MOVE.

Overrides:

getSourceActions in class javax.swing.TransferHandler

Parameters:

c - .

Returns:

O código da ação TransferHandler.COPY_OR_MOVE.

canImport

public boolean canImport(javax.swing.JComponent c,
                         java.awt.datatransfer.DataFlavor[] flavor)

Overrides:

canImport in class javax.swing.TransferHandler

exportAsDrag

public void exportAsDrag(javax.swing.JComponent source,
                         java.awt.event.InputEvent event,
                         int action)

É chamada ao início de uma ação de Drag.

Overrides:

exportAsDrag in class javax.swing.TransferHandler

Parameters:

source - Componente fonte do objeto sendo transferido.

event - O evento que iniciou a transferência.

action - A ação (COPY/MOVE) que iniciou a transferência.

exportToClipboard

public void exportToClipboard(javax.swing.JComponent source,
                              java.awt.datatransfer.Clipboard clip,
                              int action)

É chamada ao início de uma ação de transferência para o clipboard.

Overrides:

exportToClipboard in class javax.swing.TransferHandler

Parameters:

source - Componente fonte do objeto sendo transferido.

clip - Deve ser null, pois está sendo utilizado um clipboard próprio.

action - A ação (COPY/MOVE) que iniciou a transferência.

createTransferable

public java.awt.datatransfer.Transferable createTransferable(javax.swing.JComponent dragSource)

Cria uma representação do objeto que vai ser transferido durante uma operação de drag&drop ou através do clipboard. Nesse caso, o objeto criado contém referências para um ou mais instâncias de ProjectFile que foram selecionadas na árvore.

Overrides:

createTransferable in class javax.swing.TransferHandler

Parameters:

dragSource - O compoenente JTree que contém os objetos que serão transferidos.

Returns:

Um objeto Transferable que contém os nós de arquivos ou diretórios selecionados na árvore de projeto.

importData

public boolean importData(javax.swing.JComponent destination,
                          java.awt.datatransfer.Transferable data)

Este método deveria implementar a importação dos dados na fonte do drop, porém como as ações rodam dentro de uma thread, a ação de mover não poderia ser quebrada em importar(importData)+remover(exportDone), pois se um erro ocorresse durante a importação, a etapa de remover ocorreria em seguida e os dados seriam perdidos. Devido a isso, a implementação das ações ficou a cargo do método exportDone pois este recebe que ação deve ser executada, copiar ou mover, e assim não precisamos quebrar a ação de mover em etapas.
Este método então, fica encarregado de testar se a importação poderia ser feita e de salvar o destino da importação para ser utilizado pelo método exportDone.
Obs. Isso só foi possível por que a árvore é tanto a fonte do drag quanto do drop.

Overrides:

importData in class javax.swing.TransferHandler

Parameters:

destination - O componente que possui os objetos sobre o qual a transferência será efetuada.

data - O objeto que representa o que está sendo transferido.

Returns:

Verdadeiro, se a transferência foi feita ou, falso, caso a transferência não seja feita.

exportDone

protected void exportDone(javax.swing.JComponent source,
                          java.awt.datatransfer.Transferable data,
                          int action)

Este método deveria apenas remover os dados de origem após uma importação bem sucedida no caso de uma ação de mover (MOVE), porém como as ações rodam dentro de uma thread, este método não teria como saber se a importação foi bem sucedida ou não para então remover o dado original. Desta forma, este método está disparando as ações, para que assim a ação de mover não seja quebrada em duas (importar+apagar).
Obs. Isso só foi possível por que a árvore é tanto a fonte do drag quanto do drop.

Overrides:

exportDone in class javax.swing.TransferHandler

Parameters:

source - o componente que foi a fonte dos dados.

data - o dado transferido ou null se a ação foi NONE.

action - a ação que foi executada.

getFilesToExport

protected abstract csbase.logic.ClientProjectFile[] getFilesToExport(javax.swing.JComponent source)

Parameters:

source - componente fonte de uma ação de copiar ou de mover.

Returns:

arquivos/diretórios que serão exportados.

getDestinationDirectory

protected abstract csbase.logic.ClientProjectFile getDestinationDirectory(javax.swing.JComponent destination)

Parameters:

destination - componente que irá receber os arquivos/diretórios exportados.

Returns:

o diretório de destino dos arquivos exportados (copiados/movidos).