csdk.v1_0.api.filesystem.project
Interface IProjectContext

All Superinterfaces:

IContext, Serializable

public interface IProjectContext
extends IContext

Define os métodos disponíveis para acesso da aplicação à área de projetos durante a sua execução.

Method Summary

void	addProjectObserver(IProjectObserver listener) Adiciona um observador de mudanças no projeto corrente.
IFile[]	browseMultipleProjectFilesInOpenMode(String[] fileTypes, boolean allowAll, FileSelectionType selectionType, Window window) Mostra um navegador para seleção de múltiplos arquivos de projeto em modo de leitura.
IFile	browseProjectFileInOpenMode(String[] fileTypes, boolean allowAll, FileSelectionType selectionType, Window window) Mostra um navegador para seleção de um arquivo de projeto em modo de leitura.
IFile	browseProjectFileInSaveMode(String[] fileTypes, boolean allowAll, String defaultName, Window window) Mostra um navegador para seleção de um arquivo de projeto em modo de escrita.
IFile	createProjectFile(String[] path, String name, String fileType, Window window) Cria um arquivo de projeto no diretório especificado.
String	getCurrentProjectId() Obtém o identificador do projeto corrente ou null, caso não haja projeto aberto no momento.
IFile	getProjectFile(String[] path, Window window) Obtém o arquivo de projeto com o caminho especificado.
boolean	removeProjectFile(String[] path, Window window) Remove um arquivo ou diretório de projeto.
void	removeProjectObserver(IProjectObserver listener) Remove um observador de mudanças do projeto corrente.

Methods inherited from interface csdk.v1_0.api.core.IContext

isActive, onContextActivate, onContextDeactivate

Method Detail

browseProjectFileInOpenMode

IFile browseProjectFileInOpenMode(String[] fileTypes,
                                  boolean allowAll,
                                  FileSelectionType selectionType,
                                  Window window)
                                  throws ProjectException

Mostra um navegador para seleção de um arquivo de projeto em modo de leitura.

Parameters:

fileTypes - os tipos de arquivos selecionáveis no navegador. Exemplo: String[] fileTypes = {"XML", "TEXT}.

allowAll - determina a inclusão da opção de selecionar qualquer tipo de arquivo, além dos listados no parâmetro fileTypes.

selectionType - modo de seleção do navegador (somente arquivos FileSelectionType.FILES_ONLY ou somente diretórios FileSelectionType.DIRECTORIES_ONLY).

window - a janela-mãe do navegador de arquivos.

Returns:

o arquivo selecionado ou null caso a operação tenha sido cancelada.

Throws:

ProjectException - em caso de erro ao acessar a área de projetos.

browseMultipleProjectFilesInOpenMode

IFile[] browseMultipleProjectFilesInOpenMode(String[] fileTypes,
                                             boolean allowAll,
                                             FileSelectionType selectionType,
                                             Window window)
                                             throws ProjectException

Mostra um navegador para seleção de múltiplos arquivos de projeto em modo de leitura.

Parameters:

fileTypes - os tipos de arquivos selecionáveis no navegador. Exemplo: String[] fileTypes = {"XML", "TEXT}.

allowAll - determina a inclusão da opção de selecionar qualquer tipo de arquivo, além dos listados no parâmetro fileTypes.

selectionType - modo de seleção do navegador (somente arquivos FileSelectionType.FILES_ONLY ou somente diretórios FileSelectionType.DIRECTORIES_ONLY).

window - a janela-mãe do navegador de arquivos.

Returns:

o arquivo selecionado ou null caso a operação tenha sido cancelada.

Throws:

ProjectException - em caso de erro ao acessar a área de projetos.

browseProjectFileInSaveMode

IFile browseProjectFileInSaveMode(String[] fileTypes,
                                  boolean allowAll,
                                  String defaultName,
                                  Window window)
                                  throws ProjectException

Mostra um navegador para seleção de um arquivo de projeto em modo de escrita.

Parameters:

fileTypes - os tipos de arquivos selecionáveis no navegador. Exemplo: String[] fileTypes = {"XML", "TEXT}.

allowAll - determina a inclusão da opção de selecionar qualquer tipo de arquivo, além dos listados no parâmetro fileTypes.

defaultName - o nome padrão do arquivo.

window - a janela-mãe do navegador de arquivos.

Returns:

o arquivo selecionado ou null caso a operação tenha sido cancelada.

Throws:

ProjectException - em caso de erro ao acessar a área de projetos.

getProjectFile

IFile getProjectFile(String[] path,
                     Window window)
                     throws ProjectException

Obtém o arquivo de projeto com o caminho especificado. O caminho é relativo à raiz do projeto e deve ser informado em forma de array, para evitar problemas de separadores dependentes de plataforma. Exemplos: (Raiz do projeto) "[PROJETO]/abc.txt" -> {"abc.txt"} (Caminho relativo) "[PROJETO]/dir/abc/" -> {"dir", "abc"}

Parameters:

path - o caminho relativo ao projeto, sem separador.

window - a janela-mãe da ação.

Returns:

o arquivo selecionado ou null caso o arquivo não exista no projeto.

Throws:

ProjectException - em caso de erro ao obter o arquivo.

createProjectFile

IFile createProjectFile(String[] path,
                        String name,
                        String fileType,
                        Window window)
                        throws ProjectException

Cria um arquivo de projeto no diretório especificado. O caminho do diretório pai é relativo à raiz do projeto e deve ser informado em forma de array, para evitar problemas de separadores dependentes de plataforma. Exemplos: (Raiz do projeto) "[PROJETO]/" -> null ou array vazio (Caminho relativo) "[PROJETO]/dir/abc/" -> {"dir", "abc"}

Parameters:

path - o caminho do diretório pai (relativo ao projeto), sem separador.

name - o nome do arquivo a ser criado.

fileType - o tipo do arquivo ou "DIRECTORY_TYPE" caso seja um diretório.

window - a janela-mãe da ação.

Returns:

o arquivo criado.

Throws:

ProjectException - em caso de erro ao criar o arquivo.

removeProjectFile

boolean removeProjectFile(String[] path,
                          Window window)
                          throws ProjectException

Remove um arquivo ou diretório de projeto. O caminho é relativo à raiz do projeto e deve ser informado em forma de array, para evitar problemas de separadores dependentes de plataforma. Para remover um diretório, este precisa estar vazio. Exemplos: (Raiz do projeto) "[PROJETO]/abc.txt" -> {"abc.txt"} (Caminho relativo) "[PROJETO]/dir/abc/" -> {"dir", "abc"}

Parameters:

path - o caminho relativo ao projeto, sem separador.

window - a janela-mãe da ação.

Returns:

true caso a remoção seja feita com sucesso ou false caso contrário.

Throws:

ProjectException - em caso de erro ao remover o arquivo.

getCurrentProjectId

String getCurrentProjectId()

Obtém o identificador do projeto corrente ou null, caso não haja projeto aberto no momento.

Returns:

o identificador do projeto ou null, caso não haja projeto aberto no momento.

addProjectObserver

void addProjectObserver(IProjectObserver listener)

Adiciona um observador de mudanças no projeto corrente.

Parameters:

listener - o observador.

removeProjectObserver

void removeProjectObserver(IProjectObserver listener)

Remove um observador de mudanças do projeto corrente.

Parameters:

listener - o observador.