csbase.client.applications

Class Application

java.lang.Object

java.util.Observable

csbase.client.applicationmanager.ApplicationType

csbase.client.applications.Application

Direct Known Subclasses:

ApplicationProject, CommandsMonitor, DesktopLauncher, DiskInfo, DiskMonitor, FileTransfer, ImageViewer, JobMonitor, LogAdministration, PDFViewer, PreferenceViewer, ProjectSynchronization, ServerDiagnostic, SGAMonitor

public abstract class Application
extends ApplicationType

Classe básica de aplicação com implementação para um suporte mínimo: lançamento e encerramento de suas intâncias, janela principal etc.

Author:

Tecgraf

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFERENCE_MESSAGE Usado para identificar objetos de preferências de aplicação ao chamarmos o método ApplicationType.sendMessage(String, Object, String) .
static java.lang.String	PROJECT_FILE_MESSAGE Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Application(java.lang.String id) Constrói uma aplicação desktop

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> void	addPreferenceListener(PreferenceDefinition name, PreferenceListener<T> listener) Adiciona ouvinte a uma preferência do usuário.
void	addWindow(java.awt.Window win) Registra uma janela cliente na janela principal de modo que, ao fechar a janela pricipal, todas as janelas registradas também são fechadas.
ApplicationComponentFrame	buildApplicationFrame() Criação de um frame da aplicação.
javax.swing.ImageIcon	buildApplicationImage(java.lang.String tag) Monta uma imagem do resource da aplicação.
void	closeDependentWindows() Fecha todas as janelas dependentes da janela principal da aplicação.
void	finishApplication() Método abstrato para fechamento do diálogo das aplicações
java.lang.String	getApplicationCommand() Consulta as propriedades pré-configuradas no manager.
java.lang.String	getApplicationCommandDir() Consulta ao diretório onde está o comando da aplicação.
ApplicationFrame	getApplicationFrame() Retorna o diálogo principal da aplicação.
csbase.logic.CommonClientProject	getApplicationProject() Consulta ao projeto corrente.
java.lang.String	getClassString(java.lang.Class<?> clazz, java.lang.String key) Consulta a uma string de locale, com base em um objeto
java.lang.String	getClassString(java.lang.Class<?> clazz, java.lang.String key, java.lang.Object[] args) Obtém a versão localizada de uma mensagem que contenha parâmetros, com base em um objeto.
DesktopFrame	getDesktopFrame() Consulta ao projeto corrente.
java.util.Locale	getLocale() Retorna o locale
PreferenceCategory	getPreferences() Retorna todas as preferências da aplicação.
java.io.InputStream	getResource(java.lang.String[] resourcePath) Retorna o stream de entrada correspondente a um arquivo que se encontra no repositório da aplicação.
csbase.logic.applicationservice.AppPropertyResourceBundle	getResourceBundle() Consulta ao bundle da aplicação.
javax.swing.JLabel	getStatusBar() Deprecated. Esse método retorna apenas a instância de um JLabel. Este não foi adicionado na janela da aplicação e é responsabilidade de quem utilizá-lo fazer isso. Ao invés deste utilize a barra de status que já existe na janela da aplicação.
java.lang.String	getString(java.lang.String key) Consulta a uma string de locale
java.lang.String	getString(java.lang.String key, java.lang.Object[] args) Obtém a versão localizada de uma mensagem que contenha parâmetros.
protected boolean	handleError(java.lang.Exception ex) Método padrão de tratamento de exceções da aplicação.
boolean	hasClassString(java.lang.Class<?> clazz, java.lang.String key) Consulta a existência de uma string de locale, com base em um objeto
boolean	hasString(java.lang.String key) Consulta a existência de uma string de locale
boolean	isConnectedToServer() Indica se a aplicação está rodando em ambiente de execução client-servidor; ou seja, conectada a um servidor CSBASE.
boolean	isVisible() Indica se a aplicação está visível
abstract void	killApplication() Método para encerramento da execução, que pode ser redefinido para comportamentos próprios da aplicações.
void	logDetailedApplicationEvent(java.lang.String[] queue, java.lang.String[] info) Método para log de informações específicas do cliente (applicação).
protected <T> void	removeAllPreferenceListeners() Remove todas os ouvintes de preferências da aplicação.
void	removeWindow(java.awt.Window win) Descadastra uma janela da cliente janela principal.
void	savePreferences() Salva as preferências da aplicação.
protected void	setInitialFrameState(int initState) Indica que a janela da aplicação deve ser iniciada no estado indicado, que pode ser Frame.NORMAL, Frame.MAXIMIZED_BOTH, etc..
void	setVisible(boolean flag) Torna status da aplicação visível/invisível
void	showError(java.awt.Component parent, java.lang.Object msg) Método para exibição de uma mensagem de erro.
void	showError(java.lang.Object msg) Método para exibição de uma mensagem de erro.
void	showException(java.lang.String msg, java.lang.Throwable t) Método para exibição de uma mensagem de erro, juntamente com a exceção associada.
void	showExceptionStack(java.lang.Throwable t) Método para exibição de uma pilha de erro (exceção).
void	showInformation(java.awt.Component parent, java.lang.Object msg) Método para exibição de uma mensagem informativa.
void	showInformation(java.lang.Object msg) Método para exibição de uma mensagem informativa.
void	showMessage(java.awt.Component parent, java.lang.String title, java.lang.Object msg, int type) Método para exibição de uma mensagem do tipo especificado.
void	showMessage(java.lang.Object msg) Método para exibição de uma mensagem informativa.
int	showOptionDialog(java.awt.Component parent, java.lang.String msg, java.lang.String[] options) Consulta a opções do programa.
int	showOptionDialog(java.lang.String msg, java.lang.String[] options) Consulta a opções do programa.
void	showWarning(java.awt.Component parent, java.lang.Object msg) Método para exibição de uma mensagem de aviso.
void	showWarning(java.lang.Object msg) Método para exibição de uma mensagem de aviso.
void	startApplication() Método abstrato para abertura do diálogo das aplicações

Methods inherited from class csbase.client.applicationmanager.ApplicationType

closeApplication, getApplicationRegistry, getApplicationResourceAsStream, getApplicationResourceAsStream, getApplicationResourceAsURL, getApplicationResourceAsURL, getAuthorMail, getAuthorName, getBooleanSpecificProperty, getDescription, getDoubleSpecificProperty, getFileTypes, getId, getImageIcon, getImageIcon, getImageIcon, getInstanceId, getInstanceIndex, getIntSpecificProperty, getLongSpecificProperty, getLongSpecificProperty, getMainApplicationClass, getName, getStringListSpecificProperty, getStringSpecificProperty, getVersion, getVersionNumber, launchApplication, postInitialization, sendMessage, userCanKillApplication

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_FILE_MESSAGE

@Deprecated
public static final java.lang.String PROJECT_FILE_MESSAGE

Deprecated.

O identificar de mensagens enviadas no método ApplicationType.sendMessage(String, Object, String).

See Also:

Constant Field Values

PREFERENCE_MESSAGE

public static final java.lang.String PREFERENCE_MESSAGE

Usado para identificar objetos de preferências de aplicação ao chamarmos o método ApplicationType.sendMessage(String, Object, String) .

See Also:

Constant Field Values

Constructor Detail

Application

protected Application(java.lang.String id)

Constrói uma aplicação desktop

Parameters:

id - identificador da aplicação.

Method Detail

getStatusBar

@Deprecated
public javax.swing.JLabel getStatusBar()

Deprecated. Esse método retorna apenas a instância de um JLabel. Este não foi adicionado na janela da aplicação e é responsabilidade de quem utilizá-lo fazer isso. Ao invés deste utilize a barra de status que já existe na janela da aplicação.

Obtém a barra de status para ser usada em uma aplicação.

Returns:

.

See Also:

DesktopComponentFrame.getStatusBar(), DesktopComponentFrame.showStatusBar(), StatusBar

getLocale

public java.util.Locale getLocale()

Retorna o locale

Returns:

o locale

getDesktopFrame

public final DesktopFrame getDesktopFrame()

Consulta ao projeto corrente.

Returns:

o projeto corrente (que necessariamente existe).

Throws:

java.lang.RuntimeException - se não houver desktop e/ou projeto.

getApplicationProject

public final csbase.logic.CommonClientProject getApplicationProject()

Consulta ao projeto corrente.

Returns:

o projeto corrente (que necessariamente existe).

Throws:

java.lang.RuntimeException - se não houver desktop e/ou projeto.

getApplicationCommand

public final java.lang.String getApplicationCommand()

Consulta as propriedades pré-configuradas no manager.

Returns:

as propriedades

getApplicationCommandDir

public final java.lang.String getApplicationCommandDir()

Consulta ao diretório onde está o comando da aplicação.

Returns:

o diretório onde está o comando da aplicação

isConnectedToServer

public final boolean isConnectedToServer()

Indica se a aplicação está rodando em ambiente de execução client-servidor; ou seja, conectada a um servidor CSBASE.

Returns:

indicativo

buildApplicationImage

public final javax.swing.ImageIcon buildApplicationImage(java.lang.String tag)

Monta uma imagem do resource da aplicação.

Parameters:

tag - nome do arquivo de imagem.

Returns:

uma imagem (ícone)

buildApplicationFrame

public final ApplicationComponentFrame buildApplicationFrame()

Criação de um frame da aplicação.

Returns:

um frame da aplicação.

getApplicationFrame

public final ApplicationFrame getApplicationFrame()

Retorna o diálogo principal da aplicação.

Returns:

a janela.

getResourceBundle

public final csbase.logic.applicationservice.AppPropertyResourceBundle getResourceBundle()

Consulta ao bundle da aplicação.

Returns:

o bundle

hasString

public final boolean hasString(java.lang.String key)

Consulta a existência de uma string de locale

Parameters:

key - a chave de consulta

Returns:

um indicativo

getString

public final java.lang.String getString(java.lang.String key)

Consulta a uma string de locale

Parameters:

key - a chave de consulta

Returns:

a string baseada no locale.

getString

public final java.lang.String getString(java.lang.String key,
                         java.lang.Object[] args)

Obtém a versão localizada de uma mensagem que contenha parâmetros.

Parameters:

key - chave para a mensagem que contém parâmetros.

args - argumentos para a mensagem.

Returns:

mensagem preenchida pelos argumentos e localizada.

hasClassString

public final boolean hasClassString(java.lang.Class<?> clazz,
                     java.lang.String key)

Consulta a existência de uma string de locale, com base em um objeto

Parameters:

clazz - classe de consulta.

key - a chave de consulta

Returns:

um indicativo

getClassString

public final java.lang.String getClassString(java.lang.Class<?> clazz,
                              java.lang.String key)

Consulta a uma string de locale, com base em um objeto

Parameters:

clazz - classe de consulta.

key - a chave de consulta

Returns:

a string baseada no locale.

getClassString

public final java.lang.String getClassString(java.lang.Class<?> clazz,
                              java.lang.String key,
                              java.lang.Object[] args)

Obtém a versão localizada de uma mensagem que contenha parâmetros, com base em um objeto.

Parameters:

clazz - classe de consulta.

key - chave para a mensagem que contém parâmetros.

args - argumentos para a mensagem.

Returns:

mensagem preenchida pelos argumentos e localizada.

getResource

public final java.io.InputStream getResource(java.lang.String[] resourcePath)

Retorna o stream de entrada correspondente a um arquivo que se encontra no repositório da aplicação. NOTA: É necessário fechar o stream de entrada retornado por este método.

Parameters:

resourcePath - - path do arquivo.

Returns:

stream de entrada correspondente ao arquivo.

startApplication

public void startApplication()
                      throws ApplicationException

Método abstrato para abertura do diálogo das aplicações

Specified by:

startApplication in class ApplicationType

Throws:

ApplicationException - Em caso de erro ao iniciar a aplicação.

finishApplication

public final void finishApplication()

Método abstrato para fechamento do diálogo das aplicações

Specified by:

finishApplication in class ApplicationType

logDetailedApplicationEvent

public final void logDetailedApplicationEvent(java.lang.String[] queue,
                               java.lang.String[] info)

Método para log de informações específicas do cliente (applicação).

Parameters:

queue - fila

info - mensagem a ser exibida.

showMessage

public final void showMessage(java.lang.Object msg)

Método para exibição de uma mensagem informativa.

Parameters:

msg - mensagem a ser exibida.

showMessage

public final void showMessage(java.awt.Component parent,
               java.lang.String title,
               java.lang.Object msg,
               int type)

Método para exibição de uma mensagem do tipo especificado.

Parameters:

parent - elemento (janela) pai.

title - título.

msg - mensagem a ser exibida.

type - tipo da mensagem.

showOptionDialog

public final int showOptionDialog(java.awt.Component parent,
                   java.lang.String msg,
                   java.lang.String[] options)

Consulta a opções do programa.

Parameters:

parent - componente-pai do diálogo a ser exibido.

msg - mensagem a ser exibida.

options - array de opções.

Returns:

a opção selecionada.

showOptionDialog

public final int showOptionDialog(java.lang.String msg,
                   java.lang.String[] options)

Consulta a opções do programa.

Parameters:

msg - mensagem a ser exibida.

options - array de opções.

Returns:

a opção selecionada.

showExceptionStack

public final void showExceptionStack(java.lang.Throwable t)

Método para exibição de uma pilha de erro (exceção).

Parameters:

t - a exceção.

showException

public final void showException(java.lang.String msg,
                 java.lang.Throwable t)

Método para exibição de uma mensagem de erro, juntamente com a exceção associada.

Parameters:

msg - uma mensagem.

t - a exceção.

showError

public final void showError(java.lang.Object msg)

Método para exibição de uma mensagem de erro.

Parameters:

msg - o texto mensagem.

showError

public final void showError(java.awt.Component parent,
             java.lang.Object msg)

Método para exibição de uma mensagem de erro.

Parameters:

parent - elemento (janela) pai.

msg - o texto da mensagem.

showInformation

public final void showInformation(java.awt.Component parent,
                   java.lang.Object msg)

Método para exibição de uma mensagem informativa.

Parameters:

parent - elemento (janela) pai.

msg - o texto da mensagem.

showInformation

public final void showInformation(java.lang.Object msg)

Método para exibição de uma mensagem informativa.

Parameters:

msg - o texto da mensagem.

showWarning

public final void showWarning(java.awt.Component parent,
               java.lang.Object msg)

Método para exibição de uma mensagem de aviso.

Parameters:

parent - elemento (janela) pai.

msg - o texto da mensagem.

showWarning

public final void showWarning(java.lang.Object msg)

Método para exibição de uma mensagem de aviso.

Parameters:

msg - o texto da mensagem.

addWindow

public final void addWindow(java.awt.Window win)

Registra uma janela cliente na janela principal de modo que, ao fechar a janela pricipal, todas as janelas registradas também são fechadas.

Parameters:

win - uma nova janela registrada

removeWindow

public final void removeWindow(java.awt.Window win)

Descadastra uma janela da cliente janela principal.

Parameters:

win - a janela que deve ser removida da janela principal.

closeDependentWindows

public final void closeDependentWindows()

Fecha todas as janelas dependentes da janela principal da aplicação.

isVisible

public final boolean isVisible()

Indica se a aplicação está visível

Returns:

indicativo

setVisible

public final void setVisible(boolean flag)

Torna status da aplicação visível/invisível

Parameters:

flag - indicativo

getPreferences

public final PreferenceCategory getPreferences()

Retorna todas as preferências da aplicação.

Returns:

preferências da aplicação.

savePreferences

public final void savePreferences()

Salva as preferências da aplicação.

addPreferenceListener

protected <T> void addPreferenceListener(PreferenceDefinition name,
                             PreferenceListener<T> listener)

Adiciona ouvinte a uma preferência do usuário. Assim que a aplicação for fechada, todos os ouvintes serão removidos automaticamente.

Type Parameters:

T - - tipo do valor da preferência.

Parameters:

name - - nome da preferência.

listener - - ouvinte da preferência.

removeAllPreferenceListeners

protected <T> void removeAllPreferenceListeners()

Remove todas os ouvintes de preferências da aplicação.

Type Parameters:

T - - tipo da preferência a ser removida.

handleError

protected boolean handleError(java.lang.Exception ex)

Método padrão de tratamento de exceções da aplicação.

Parameters:

ex - a exceção.

Returns:

false por default.

setInitialFrameState

protected final void setInitialFrameState(int initState)

Indica que a janela da aplicação deve ser iniciada no estado indicado, que pode ser Frame.NORMAL, Frame.MAXIMIZED_BOTH, etc..

Parameters:

initState - - o estado inicial.

killApplication

public abstract void killApplication()
                              throws ApplicationException

Método para encerramento da execução, que pode ser redefinido para comportamentos próprios da aplicações.

Specified by:

killApplication in class ApplicationType

Throws:

ApplicationException - em caso de erro no fechamento da applicação.