csbase.client.preferences

Class PreferenceManager

java.lang.Object

csbase.client.preferences.PreferenceManager

public class PreferenceManager
extends java.lang.Object

Está classe representa o gerenciador de preferências do sistema. Este gerenciador é uma instância única (singleton) e é a partir dele que fazemos a carga e persistência das preferências do usuário. A inicialização do sistema de preferências é dividido em 2 partes:
- A carga das definições de preferências (via enumerações);
- A carga das preferências do usuário; Ao fazermos a carga das definições das preferências do sistema estamos, na verdade, construindo uma árvore de preferências default. Está carga é feita no momento em que o PreferenceManager é instanciado e está árvore armazena apenas as informações das preferências de aplicações junto aos seus valores default. Ao fazemos a primeira chamada ao método loadPreferences() estamos, de fato, fazendo a carga das preferências do usuário e, assim, preenchendo a árvore de preferências com os valores do usuário. Para que o PreferenceManager possa fazer a carga de uma nova definição de preferência que não seja de aplicação, é necessário invocar loadDefinition(Class). NOTA: Esta carga explícita só pode ser feita antes da carga das preferências do usuário. Uma vez que a leitura das preferências do usuário é feita, não é possível carregar nenhuma outra definição. Ao fazermos a carga das preferências do usuário, temos em mãos um objeto do tipo PreferenceCategory que é uma estrutura recursiva que armazena todas as preferências do usuário. Ao manipularmos os valores de preferências, podemos fazer a persistência chamando o método savePreferences().

Author:

Tecgraf

See Also:

PreferenceValue

Method Summary

Methods

Modifier and Type	Method and Description
static PreferenceManager	getInstance() Retorna a instância única do gerenciador de preferências.
boolean	hasAppPreferences(csbase.logic.applicationservice.ApplicationRegistry registry) True se a aplicação possuir preferências, false caso contrário.
PreferenceCategory	loadAppPreferences(csbase.logic.applicationservice.ApplicationRegistry registry, java.awt.Window parent) Retorna o objeto que encapsula as preferências de uma determinada aplicação.
void	loadDefinition(java.lang.Class<? extends PreferenceDefinition> enumClass) Permite a adição de preferências de sistema que serão carregadas na construção das preferências.
PreferenceCategory	loadPreferences() Carrega a árvore de preferências do usuário.
PreferenceCategory	loadPreferences(java.awt.Window parent) Carrega a árvore de preferências do usuário.
void	savePreferences() Salva as preferências do usuário.
void	savePreferences(java.awt.Window parent) Salva as preferências do usuário.
void	setDefaultValue(PreferenceDefinition name, java.lang.String defaultValue) Muda o valor dafult de uma preferência.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PreferenceManager getInstance()

Retorna a instância única do gerenciador de preferências.

Returns:

instância única do gerenciador de preferências.

loadPreferences

public PreferenceCategory loadPreferences()

Carrega a árvore de preferências do usuário.

Returns:

raíz da árvore de preferências do usuário.

loadPreferences

public PreferenceCategory loadPreferences(java.awt.Window parent)

Carrega a árvore de preferências do usuário.

Parameters:

parent - janela principal que está manipulando as preferências.

Returns:

raíz da árvore de preferências do usuário.

savePreferences

public void savePreferences()

Salva as preferências do usuário.

savePreferences

public void savePreferences(java.awt.Window parent)

Salva as preferências do usuário.

Parameters:

parent - janela principal que está manipulando as preferências.

loadAppPreferences

public PreferenceCategory loadAppPreferences(csbase.logic.applicationservice.ApplicationRegistry registry,
                                    java.awt.Window parent)

Retorna o objeto que encapsula as preferências de uma determinada aplicação.

Parameters:

registry - registro de uma aplicação.

parent - janela principal que está manipulando as preferências.

Returns:

objeto que encapsula as preferências do usuário de uma determinada aplicação.

hasAppPreferences

public boolean hasAppPreferences(csbase.logic.applicationservice.ApplicationRegistry registry)

True se a aplicação possuir preferências, false caso contrário.

Parameters:

registry - registro da aplicação.

Returns:

true se a aplicação possuir preferências, false caso contrário.

loadDefinition

public void loadDefinition(java.lang.Class<? extends PreferenceDefinition> enumClass)

Permite a adição de preferências de sistema que serão carregadas na construção das preferências. NOTA: A carga de uma nova definição só pode ser feita antes da primeira chamada de loadPreferences() quando, de fato, é feita a leitura das preferências do usuário. Uma vez que a leitura das preferências do usuário é feita, não é possível carregar nenhuma outra definição.

Parameters:

enumClass - enumeração que define preferências.

setDefaultValue

public void setDefaultValue(PreferenceDefinition name,
                   java.lang.String defaultValue)

Muda o valor dafult de uma preferência. NOTA: A alteração do valor default só pode ser feita antes da primeira chamada de loadPreferences() quando, de fato, é feita a leitura das preferências do usuário. Uma vez que a leitura das preferências do usuário é feita, não é possível modificar nenhum valor default.

Parameters:

name - constante que define a preferência.

defaultValue - novo valor default.