csbase.client.util.gui.log

Class LogPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

csbase.client.util.gui.log.LogPanel

All Implemented Interfaces:

AutoReloadable, Reloadable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class LogPanel
extends javax.swing.JPanel
implements AutoReloadable

Painel a ser adicionado a uma aplicação, dando-lhe assim a funcionalidade de visualização de logs.

Author:

Tecgraf / PUC-Rio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogPanel.FileEvent Representa um evento de arquivo que pode ser um arquivo de log sendo aberto, fechado, atualizado ou não encontrado.
static class	LogPanel.PagingEvent Representa um evento de paginação indicando que a página corrente foi alterada.
static class	LogPanel.ThrowableEvent Representa um evento a ser lançado quando ocorre um Throwable exceção que deve ser tratado pela aplicação dona do LogPanel.

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE_KB Tamanho da página (default) em Kb.
static int	EXPORT Adiciona a barra de ferramentas a funcionalidade de exportar o arquivo de log corrente.
static long	FIRST_PAGE Indica a primeira página de qualquer arquivo de log aberto.
static int	OPEN_CLOSE Adiciona a barra de ferramentas a funcionalidade de abrir e fechar arquivos.
static int	PAGING Adiciona a barra de ferramentas a funcionalidade de paginação (ir para a primeira página, página anterior, página seguinte, última página).
static int	RELOAD Adiciona a barra de ferramentas a funcionalidade de auto-recarga do arquivo corrente.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileEventListener(EventListener<LogPanel.FileEvent> listener) Armazena um EventListener para repassar a este eventos do tipo LogPanel.FileEvent.
void	addPagingEventListener(EventListener<LogPanel.PagingEvent> listener) Armazena um EventListener para repassar a este eventos do tipo LogPanel.PagingEvent.
void	addThrowableEventListener(EventListener<LogPanel.ThrowableEvent> listener) Armazena um EventListener para repassar a este eventos do tipo LogPanel.ThrowableEvent.
void	closeFile() Fecha o arquivo de log corrente e desliga a auto-recarga se esta estiver ligada.
long	countPages()
static LogPanel	createLogPanelWithCompleteToolBar(int pageSizeKb) Método utilitário para criação de painel de log com barra de ferramentas completa.
static LogPanel	createLogPanelWithoutToolBar(int pageSizeKb) Método utilitário para criação de painel de log rolável sem barra de ferramentas.
static LogPanel	createLogPanelWithToolBar(int toolBarFlags, int pageSizeKb) Método utilitário para criação de painel de log com barra de ferramentas customizada.
csbase.logic.ClientProjectFile	getFile()
java.awt.Window	getOwner()
long	getPageNumber()
LogPanelReloader	getReloader() Obtém o controlador de recargas do componente.
static java.lang.String	getString(java.lang.String tag, java.lang.Object... args) Retorna um texto do arquivo de idioma correto, de acordo com a internacionalização, utilizando com o chave a String "LogPanel." concatenada com a tag.
LogPanelTextArea	getTextArea()
java.lang.String	getTitle()
javax.swing.JToolBar	getToolBar()
void	goToPage(long newPage) Altera a página corrente.
void	openFile(csbase.logic.ClientProjectFile newFile) Abre um arquivo de log.
void	reload() Faz a recarga do arquivo corrente e mostra o final da última página.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_CLOSE

public static final int OPEN_CLOSE

Adiciona a barra de ferramentas a funcionalidade de abrir e fechar arquivos.

See Also:

Constant Field Values

RELOAD

public static final int RELOAD

Adiciona a barra de ferramentas a funcionalidade de auto-recarga do arquivo corrente.

See Also:

Constant Field Values

EXPORT

public static final int EXPORT

Adiciona a barra de ferramentas a funcionalidade de exportar o arquivo de log corrente.

See Also:

Constant Field Values

PAGING

public static final int PAGING

Adiciona a barra de ferramentas a funcionalidade de paginação (ir para a primeira página, página anterior, página seguinte, última página).

See Also:

Constant Field Values

FIRST_PAGE

public static final long FIRST_PAGE

Indica a primeira página de qualquer arquivo de log aberto.

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE_KB

public static final int DEFAULT_PAGE_SIZE_KB

Tamanho da página (default) em Kb. 0 < ( *1024) <= Integer.MAX_VALUE

See Also:

Constant Field Values

Method Detail

createLogPanelWithCompleteToolBar

public static final LogPanel createLogPanelWithCompleteToolBar(int pageSizeKb)

Método utilitário para criação de painel de log com barra de ferramentas completa.

Parameters:

pageSizeKb - o tamanho (em Kb) da página.

Returns:

um painel de log com a barra de ferramentas completa com opções de: abrir e fechar arquivo, recarga automática, paginação e ajuda.

createLogPanelWithoutToolBar

public static final LogPanel createLogPanelWithoutToolBar(int pageSizeKb)

Método utilitário para criação de painel de log rolável sem barra de ferramentas.

Parameters:

pageSizeKb - o tamanho (em Kb) da página.

Returns:

um painel de log sem barra de ferramentas.

createLogPanelWithToolBar

public static final LogPanel createLogPanelWithToolBar(int toolBarFlags,
                                 int pageSizeKb)

Método utilitário para criação de painel de log com barra de ferramentas customizada.

Parameters:

toolBarFlags - uma máscara de bits indicando que ferramentas devem aparecer na toolbar. As opções são: OPEN_CLOSE, RELOAD e PAGING.

pageSizeKb - o tamanho (em Kb) da página.

Returns:

cria um painel de log com uma barra de ferramenta customizada.

getString

public static final java.lang.String getString(java.lang.String tag,
                         java.lang.Object... args)

Retorna um texto do arquivo de idioma correto, de acordo com a internacionalização, utilizando com o chave a String "LogPanel." concatenada com a tag.
Ex.: tag = "test", então será procurado o texto no arquivo de idiomas referente a chave "LogPanel.test".

Parameters:

tag - a tag

args - argumento para a formatação de texto estilo String.format(String, Object...)

Returns:

um texto sem espaços antes nem depois caso a chave tenha sido encontrada ou nulo caso contrário.

addFileEventListener

public void addFileEventListener(EventListener<LogPanel.FileEvent> listener)

Armazena um EventListener para repassar a este eventos do tipo LogPanel.FileEvent.

Parameters:

listener - o listener

addPagingEventListener

public void addPagingEventListener(EventListener<LogPanel.PagingEvent> listener)

Armazena um EventListener para repassar a este eventos do tipo LogPanel.PagingEvent.

Parameters:

listener - o listener

addThrowableEventListener

public void addThrowableEventListener(EventListener<LogPanel.ThrowableEvent> listener)

Armazena um EventListener para repassar a este eventos do tipo LogPanel.ThrowableEvent.

Parameters:

listener - o listener

closeFile

public final void closeFile()

Fecha o arquivo de log corrente e desliga a auto-recarga se esta estiver ligada.

countPages

public long countPages()

Returns:

o total de páginas do arquivo.

getFile

public final csbase.logic.ClientProjectFile getFile()

Returns:

o arquivo de log.

getOwner

public java.awt.Window getOwner()

Returns:

a aplicação que detém esta instância.

getPageNumber

public long getPageNumber()

Returns:

a página corrente [FIRST_PAGE..countPages()] ou 0 caso o arquivo não exista.

getReloader

public final LogPanelReloader getReloader()

Obtém o controlador de recargas do componente.

Specified by:

getReloader in interface AutoReloadable

Returns:

o controlador de recargas.

getTextArea

public final LogPanelTextArea getTextArea()

Returns:

a área de texto.

getTitle

public java.lang.String getTitle()

Returns:

o título da janela que detém esta instância ou, caso este seja null, o retorno de com o parâmetro tag tendo o valor "title.default".

getToolBar

public final javax.swing.JToolBar getToolBar()

Returns:

a barra de ferramentas ou null caso este painel tenha sido criado pelo método createLogPanelWithoutToolBar(int)

goToPage

public void goToPage(long newPage)

Altera a página corrente.

Parameters:

newPage - a nova página

openFile

public final void openFile(csbase.logic.ClientProjectFile newFile)

Abre um arquivo de log.

Parameters:

newFile - o arquivo a ser aberto.

reload

public void reload()

Faz a recarga do arquivo corrente e mostra o final da última página.

Specified by:

reload in interface Reloadable