csdk.v2.api.filesystem.local

Interface ILocalFileSystemContext

All Superinterfaces:

IContext, Serializable

public interface ILocalFileSystemContext
extends IContext

Define os métodos disponíveis para acesso da aplicação ao sistema de arquivos local do cliente. A vantagem de se usar este contexto ao invés de acessar diretamente os arquivos pelas classes de I/O padrão é a forma transparente de tratar arquivos locais e de projeto na aplicação através da interface IFile.

Method Summary

Modifier and Type	Method and Description
IFile	browseLocalFileInOpenMode(String[] fileTypes, boolean allowAll, IFile currentLocalDirectory, FileSelectionType selectionType, Window window) Mostra um navegador para seleção de um arquivo local em modo de leitura.
IFile	browseLocalFileInSaveMode(String[] fileTypes, boolean allowAll, String defaultName, IFile currentLocalDirectory, Window window) Mostra um navegador para seleção de um arquivo local em modo de escrita.
IFile[]	browseMultipleLocalFilesInOpenMode(String[] fileTypes, boolean allowAll, IFile currentLocalDirectory, FileSelectionType selectionType, Window window) Mostra um navegador para seleção de múltiplos arquivos locais em modo de leitura.
IFile	createLocalFile(String[] path, String name, boolean isDir) Cria um arquivo local no diretório especificado.
IFile	getLocalFile(String[] path) Obtém o arquivo local com o caminho especificado.
boolean	removeLocalFile(String[] path) Remove um arquivo ou diretório local no caminho especificado.

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

isActive, onContextActivate, onContextDeactivate

Method Detail

browseLocalFileInOpenMode

IFile browseLocalFileInOpenMode(String[] fileTypes,
                                boolean allowAll,
                                IFile currentLocalDirectory,
                                FileSelectionType selectionType,
                                Window window)
                         throws LocalFileSystemException

Mostra um navegador para seleção de um arquivo local 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.

currentLocalDirectory - diretório inicial do navegador de arquivos.

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:

LocalFileSystemException - em caso de erro ao acessar o sistema de arquivos local.

browseMultipleLocalFilesInOpenMode

IFile[] browseMultipleLocalFilesInOpenMode(String[] fileTypes,
                                           boolean allowAll,
                                           IFile currentLocalDirectory,
                                           FileSelectionType selectionType,
                                           Window window)
                                    throws LocalFileSystemException

Mostra um navegador para seleção de múltiplos arquivos locais 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.

currentLocalDirectory - diretório inicial do navegador de arquivos.

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:

LocalFileSystemException - em caso de erro ao acessar o sistema de arquivos local.

browseLocalFileInSaveMode

IFile browseLocalFileInSaveMode(String[] fileTypes,
                                boolean allowAll,
                                String defaultName,
                                IFile currentLocalDirectory,
                                Window window)
                         throws LocalFileSystemException

Mostra um navegador para seleção de um arquivo local 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.

currentLocalDirectory - diretório inicial do navegador de arquivos.

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

Returns:

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

Throws:

LocalFileSystemException - em caso de erro ao acessar o sistema de arquivos local.

getLocalFile

IFile getLocalFile(String[] path)
            throws LocalFileSystemException

Obtém o arquivo local com o caminho especificado. O caminho deve ser informado em forma de array, para evitar problemas de separadores dependentes de plataforma. Exemplos: (Diretório corrente) "./abc.txt" -> {"abc.txt"} (Caminho relativo) "./dir/abc/" -> {"dir", "abc"} (Caminho absoluto) "/tmp/dir/abc.txt" -> { "", "tmp", "dir", "abc.txt"}.

Parameters:

path - o caminho sem separador.

Returns:

o arquivo ou null caso não exista.

Throws:

LocalFileSystemException - em caso de erro ao obter o arquivo.

createLocalFile

IFile createLocalFile(String[] path,
                      String name,
                      boolean isDir)
               throws LocalFileSystemException

Cria um arquivo local no diretório especificado. O caminho do diretório pai deve ser informado em forma de array, para evitar problemas de separadores dependentes de plataforma. Exemplos: (Diretório corrente) "./" -> null ou array vazio (Caminho relativo) "./dir/abc/" -> {"dir", "abc"} (Caminho absoluto) "/tmp/dir/abc/" -> { "", "tmp", "dir", "abc"}.

Parameters:

path - o caminho do diretório pai sem separador.

name - o nome do arquivo a ser criado.

isDir - determina se o arquivo a ser criado é um diretório.

Returns:

o arquivo ou null caso não seja possível criar o arquivo.

Throws:

LocalFileSystemException - em caso de erro ao criar o arquivo.

removeLocalFile

boolean removeLocalFile(String[] path)
                 throws LocalFileSystemException

Remove um arquivo ou diretório local no caminho especificado. O caminho 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: (Diretório corrente) "./abc.txt" -> {"abc.txt"} (Caminho relativo) "./dir/abc/" -> {"dir", "abc"} (Caminho absoluto) "/tmp/dir/abc.txt" -> { "", "tmp", "dir", "abc.txt"}.

Parameters:

path - o caminho para o arquivo sem separador.

Returns:

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

Throws:

LocalFileSystemException - em caso de erro ao remover o arquivo.