csbase.client.preferences

Class PreferenceValue<T>

java.lang.Object

csbase.client.preferences.PreferenceValue<T>

Type Parameters:

T - tipo do valor armazenado.

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PVBoolean, PVColor, PVDimension, PVInteger, PVList, PVMap, PVString, PVTables

public abstract class PreferenceValue<T>
extends java.lang.Object
implements java.lang.Cloneable

Classe abstrata que define o tipo do valor de uma preferência do usuário. Um valor de preferência encapsula um valor de fato (String, Boolean, Map etc), o valor default e a política de visibilidade deste valor. É importante frisar que o conceito de valor de preferência está separado do conceito de edição do valor de preferência. É possível que um valor seja editável através de várias interface gráficas diferentes. Para isso, cada valor de preferência possui uma referência para o seu editor, sendo este, podendo ser alterado. Mais sobre a edição de valores de preferências PreferenceEditor.
Mais sobre a política de visibilidade PreferencePolicy.

Author:

Tecgraf

See Also:

PreferenceCategory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultValue String definida como o valor default da preferência.
protected PreferenceEditor<T>	editor Referência para o editor desta preferência.
protected java.util.List<PreferenceListener<T>>	listeners Lista com os ouvintes desta preferência.
protected PreferenceDefinition	name Nome da preferência que possui este valor.
protected PreferencePolicy	policy Política de visibilidade da preferência
protected PreferenceBundle	preferenceBundle Objeto responsável pela internacionalização.
protected java.lang.Class<? extends PreferenceEditor<T>>	preferenceEditorClass Classe do editor desta preferência para incialização tardia.
protected T	value Valor da preferência.

Constructor Summary

Constructors

Constructor and Description
PreferenceValue(PreferenceDefinition name, java.lang.String value, java.lang.String defaultValue, PreferencePolicy policy, PreferenceBundle preferenceBundle) Este construtor é usado para instanciar os valores por reflexão na hora em que as descrições de preferências são carregadas.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPreferenceListener(PreferenceListener<T> l) Adiciona ouvinte para esta preferência.
abstract PreferenceValue<T>	clone() Cria o clone desta preferência.
abstract java.lang.String	getClassName() Retorna o nome da classe.
T	getDefaultValue() Retorna o valor default da preferência.
java.lang.String	getDescription() Descrição da preferência.
PreferenceEditor<T>	getEditor() Retorna o objeto que encapsula o componente visual que permite a edição do valor.
java.lang.String	getLabel() Rótulo da preferência.
PreferenceDefinition	getName() Nome da preferência que possui este valor.
PreferencePolicy	getPolicy() Retorna a política de visibilidade da preferência.
PreferenceBundle	getPreferenceBundle() Retorna o objeto responsável pela internacionalização.
java.lang.Class<? extends PreferenceEditor<T>>	getPreferenceEditorClass() Retorna a classe que implementa o editor desta preferência.
T	getValue() Retorna o valor da preferência.
void	removePreferenceListener(PreferenceListener<T> l) Remove ouvinte desta preferência.
void	setPreferenceEditorClass(java.lang.Class<? extends PreferenceEditor<T>> preferenceEditorClass) Seta a classe do editor deste valor de preferência.
void	setValue(T value) Seta o valor da preferência.
abstract java.lang.String	toString() Converte o valor em um String.
abstract T	toValue(java.lang.String value) Converte o valor do tipo String para o tipo correto.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected PreferenceDefinition name

Nome da preferência que possui este valor.

value

protected T value

Valor da preferência.

defaultValue

protected java.lang.String defaultValue

String definida como o valor default da preferência.

policy

protected PreferencePolicy policy

Política de visibilidade da preferência

preferenceBundle

protected PreferenceBundle preferenceBundle

Objeto responsável pela internacionalização.

preferenceEditorClass

protected java.lang.Class<? extends PreferenceEditor<T>> preferenceEditorClass

Classe do editor desta preferência para incialização tardia.

editor

protected PreferenceEditor<T> editor

Referência para o editor desta preferência.

listeners

protected java.util.List<PreferenceListener<T>> listeners

Lista com os ouvintes desta preferência.

Constructor Detail

PreferenceValue

public PreferenceValue(PreferenceDefinition name,
               java.lang.String value,
               java.lang.String defaultValue,
               PreferencePolicy policy,
               PreferenceBundle preferenceBundle)

Este construtor é usado para instanciar os valores por reflexão na hora em que as descrições de preferências são carregadas. Neste momento, usamos este construtor que recebe o valor como um String e o converte para o tipo correto usando o método toValue(String). Logo, todas as subclasses de PreferenceValue devem definir o método toValue(String) e definir um construtor com esta mesma assinatura.

Parameters:

name - nome da preferência que possui este valor.

value - valor da preferência.

defaultValue - valor default da preferência.

policy - política de visibilidade do valor.

preferenceBundle - objeto responsável pela internacionalização.

Method Detail

getName

public PreferenceDefinition getName()

Nome da preferência que possui este valor.

Returns:

nome da preferência que possui este valor.

getLabel

public java.lang.String getLabel()

Rótulo da preferência.

Returns:

rótulo da preferência.

getDescription

public java.lang.String getDescription()

Descrição da preferência.

Returns:

descrição da preferência.

getPolicy

public PreferencePolicy getPolicy()

Retorna a política de visibilidade da preferência.

Returns:

política de visibilidade da preferência.

getPreferenceBundle

public PreferenceBundle getPreferenceBundle()

Retorna o objeto responsável pela internacionalização.

Returns:

objeto responsável pela internacionalização.

getEditor

public PreferenceEditor<T> getEditor()

Retorna o objeto que encapsula o componente visual que permite a edição do valor.

Returns:

objeto que encapsula o componente visual que permite a edição do valor.

getPreferenceEditorClass

public java.lang.Class<? extends PreferenceEditor<T>> getPreferenceEditorClass()

Retorna a classe que implementa o editor desta preferência.

Returns:

classe que implementa o editor desta preferência.

getDefaultValue

public T getDefaultValue()

Retorna o valor default da preferência.

Returns:

valor default da preferência.

getValue

public T getValue()

Retorna o valor da preferência.

Returns:

valor da preferência.

setPreferenceEditorClass

public void setPreferenceEditorClass(java.lang.Class<? extends PreferenceEditor<T>> preferenceEditorClass)

Seta a classe do editor deste valor de preferência.

Parameters:

preferenceEditorClass - classe do editor desta preferência.

setValue

public void setValue(T value)

Seta o valor da preferência.

Parameters:

value - valor da preferência.

addPreferenceListener

public void addPreferenceListener(PreferenceListener<T> l)

Adiciona ouvinte para esta preferência.

Parameters:

l - ouvinte.

removePreferenceListener

public void removePreferenceListener(PreferenceListener<T> l)

Remove ouvinte desta preferência.

Parameters:

l - ouvinte.

getClassName

public abstract java.lang.String getClassName()

Retorna o nome da classe.

Returns:

o nome da classe.

toValue

public abstract T toValue(java.lang.String value)

Converte o valor do tipo String para o tipo correto. Por exemplo, converte a string "123" para o inteiro 123, a string "true" para o valor boleano true.

Parameters:

value - valor em string.

Returns:

valor no tipo correto.

toString

public abstract java.lang.String toString()

Converte o valor em um String.

Overrides:

toString in class java.lang.Object

clone

public abstract PreferenceValue<T> clone()

Cria o clone desta preferência.

Overrides:

clone in class java.lang.Object

Returns:

clone do valor.