csdk.v2.api.application

Interface IApplicationContext

All Superinterfaces:

IContext, Serializable

public interface IApplicationContext
extends IContext

Define os métodos disponíveis para acesso da aplicação ao seu registro durante a sua execução.

Method Summary

Modifier and Type	Method and Description
String	getApplicationDescription() Obtém a descrição da aplicação.
String[]	getApplicationFileTypes() Obtém os tipos de arquivo associados à aplicação.
ImageIcon	getApplicationIcon() Obtém o ícone da aplicação.
String	getApplicationId() Obtém o identificador da aplicação.
String	getApplicationName() Obtém o nome da aplicação.
String	getAuthor() Obtém o nome do autor da aplicação.
String	getAuthorEmail() Obtém o endereço de contato do autor da aplicação.
ImageIcon	getImageIcon(String[] path) Obtém uma imagem do diretório padrão da aplicação, no caminho especificado.
String	getInstanceId() Obtém o identificador único da instância da aplicação.
String	getProperty(String propName) Obtém o valor da propriedade especificada.
ImageIcon	getSmallApplicationIcon() Obtém o ícone reduzido da aplicação.
String	getString(String key, Object... args) Obtém uma string de idioma do pacote de internacionalização.
String	getVersion() Obtém a versão da aplicação.
boolean	hasString(String key) Consulta da existência de uma string de idioma no pacote de internacionalização.
boolean	isBundleRequired() Indica se a aplicação faz uso do pacote de internacionalização.
boolean	isPropertyNull(String propName) Indica se a propriedade especificada está sem valor.
boolean	isSingleton() Indica se a aplicação só pode ter uma única instância ativa.
boolean	requiresProject() Indica se a aplicação só pode ser executada com um projeto aberto.

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

isActive, onContextActivate, onContextDeactivate

Method Detail

getApplicationId

String getApplicationId()

Obtém o identificador da aplicação. Este id é comum a todas as instâncias de um mesmo tipo de aplicação.

Returns:

o id da aplicação.

getInstanceId

String getInstanceId()

Obtém o identificador único da instância da aplicação.

Returns:

o id da instância.

getApplicationName

String getApplicationName()

Obtém o nome da aplicação.

Returns:

o nome da aplicação.

getVersion

String getVersion()

Obtém a versão da aplicação.

Returns:

a versão como string.

getAuthor

String getAuthor()

Obtém o nome do autor da aplicação.

Returns:

o autor da aplicação.

getAuthorEmail

String getAuthorEmail()

Obtém o endereço de contato do autor da aplicação.

Returns:

o endereço.

getApplicationDescription

String getApplicationDescription()

Obtém a descrição da aplicação.

Returns:

a descrição.

isSingleton

boolean isSingleton()

Indica se a aplicação só pode ter uma única instância ativa.

Returns:

true se a aplicação só pode ter uma única instância ou false, caso contrário.

requiresProject

boolean requiresProject()

Indica se a aplicação só pode ser executada com um projeto aberto.

Returns:

true se a aplicação precisa de um projeto para executar ou false, caso contrário.

isPropertyNull

boolean isPropertyNull(String propName)

Indica se a propriedade especificada está sem valor.

Parameters:

propName - nome da propriedade.

Returns:

true se a propriedade está sem valor definido ou false caso contrário.

getProperty

String getProperty(String propName)

Obtém o valor da propriedade especificada.

Parameters:

propName - nome da propriedade.

Returns:

o valor da propriedade.

Throws:

IllegalStateException - se a propriedade não foi definida.

isBundleRequired

boolean isBundleRequired()

Indica se a aplicação faz uso do pacote de internacionalização.

Returns:

true se a aplicação precisa do pacote ou false caso contrário.

hasString

boolean hasString(String key)

Consulta da existência de uma string de idioma no pacote de internacionalização. [ATENÇÃO] Este método só deve ser chamado por aplicações que usam o pacote de internacionalização (onde isBundleRequired() retorna true).

Parameters:

key - a chave de busca.

Returns:

true se a chave foi definida no pacote de internacionalização ou false caso contrário.

getString

String getString(String key,
                 Object... args)

Obtém uma string de idioma do pacote de internacionalização. [ATENÇÃO] Este método só deve ser chamado por aplicações que usam o pacote de internacionalização (onde isBundleRequired() retorna true).

Parameters:

key - a chave de busca.

args - os argumentos de formatação da string.

Returns:

o texto no idioma correto ou uma string com a chave, caso a chave não seja encontrada no pacote de internacionalização (ex: <<key>>).

getImageIcon

ImageIcon getImageIcon(String[] path)

Obtém uma imagem do diretório padrão da aplicação, no caminho especificado.

Parameters:

path - o caminho para o arquivo de imagem, relativo ao diretório de imagens padrão da aplicação.

Returns:

a imagem ou null caso a imagem não seja encontrada no caminho especificado.

getSmallApplicationIcon

ImageIcon getSmallApplicationIcon()

Obtém o ícone reduzido da aplicação.

Returns:

o ícone reduzido da aplicação.

getApplicationIcon

ImageIcon getApplicationIcon()

Obtém o ícone da aplicação.

Returns:

o ícone da aplicação.

getApplicationFileTypes

String[] getApplicationFileTypes()

Obtém os tipos de arquivo associados à aplicação.

Returns:

os tipos.