tecgraf.javautils.gui
Class StatusBar

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by tecgraf.javautils.gui.StatusBar
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class StatusBar
extends JPanel

Representa uma barra de status a ser utilizada em interfaces de usuário. Obs. Uma barra de status é apenas um label com borda.

Author:
Tecgraf/PUC-Rio
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
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
 
Constructor Summary
StatusBar()
          Construtor
 
Method Summary
 void addComponent(JComponent component, double weightX)
          Adição de componente
 void clearStatus()
          Limpa a barra de status.
 void clearStatus(boolean condition)
          Limpa a barra de status se a condição dada for verdadeira.
 String getText()
          Consulta o texto da status bar.
 void hideStatusBar()
          Esconde a barra de status.
 void hideStatusBar(boolean condition)
          Esconde a barra de status se a condição dada for verdadeira.
 boolean isHidden()
           
 void setError(boolean condition, String message)
          Escreve uma mensagem na barra de status precedida por um ícone de erro se a condição dada for verdadeira.
 void setError(boolean condition, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de erro se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
 void setError(String message)
          Escreve uma mensagem na barra de status precedida por um ícone de erro.
 void setError(String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de erro, com um timeout para que a mensagem desapareça.
 void setInfo(boolean condition, String message)
          Escreve uma mensagem na barra de status precedida por um ícone de informação se a condição dada for verdadeira.
 void setInfo(boolean condition, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de informação se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
 void setInfo(String message)
          Escreve uma mensagem na barra de status precedida por um ícone de informação.
 void setInfo(String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de informação, com um timeout para que a mensagem desapareça.
 void setStatus(boolean condition, ImageIcon icon, String message)
          Escreve uma mensagem na barra de status precedida por um ícone se a condição dada for verdadeira.
Obs.
 void setStatus(boolean condition, ImageIcon icon, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
Obs.
 void setStatus(boolean condition, String message)
          Escreve uma mensagem na barra de status se a condição dada for verdadeira.
 void setStatus(boolean condition, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
 void setStatus(ImageIcon icon, String message)
          Escreve uma mensagem na barra de status precedida por um ícone.
 void setStatus(ImageIcon icon, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone e com um timeout para que ela desapareça.
 void setStatus(String message)
          Escreve uma mensagem na barra de status.
 void setStatus(String message, int timeoutSecs)
          Escreve uma mensagem na barra de status com um timeout para que a mensagem desapareça.
 void setText(String message)
          Ajusta o texto da status bar.
 void setVisible(boolean visible)
          Deprecated. use showStatusBar() ou hideStatusBar()
 void setWarning(boolean condition, String message)
          Escreve uma mensagem na barra de status precedida por um ícone de aviso se a condição dada for verdadeira.
 void setWarning(boolean condition, String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de aviso se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
 void setWarning(String message)
          Escreve uma mensagem na barra de status precedida por um ícone de aviso.
 void setWarning(String message, int timeoutSecs)
          Escreve uma mensagem na barra de status precedida por um ícone de aviso, com um timeout para que a mensagem desapareça.
 void showStatusBar()
          Mostra a barra de status.
 void showStatusBar(boolean condition)
          Mostra a barra de status se a condição dada for verdadeira.
 void shutdownTimer()
          Cancela tasks de atualização da statusbar que ainda estejam pendentes.
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StatusBar

public StatusBar()
Construtor

Method Detail

addComponent

public void addComponent(JComponent component,
                         double weightX)
Adição de componente

Parameters:
component - component
weightX - peso de expansão em X (normalizado com 1 do label de texto).

setVisible

@Deprecated
public void setVisible(boolean visible)
Deprecated. use showStatusBar() ou hideStatusBar()

Faz com que o componente seja visível ou invisível.

Overrides:
setVisible in class JComponent
Parameters:
visible - indicativo de visibilidade.
See Also:
showStatusBar(), hideStatusBar()

showStatusBar

public void showStatusBar(boolean condition)
Mostra a barra de status se a condição dada for verdadeira.

Parameters:
condition - condição.

showStatusBar

public void showStatusBar()
Mostra a barra de status.


hideStatusBar

public void hideStatusBar(boolean condition)
Esconde a barra de status se a condição dada for verdadeira.

Parameters:
condition - condição.

hideStatusBar

public void hideStatusBar()
Esconde a barra de status.


isHidden

public boolean isHidden()
Returns:
true se a barra de status estiver escondida.

clearStatus

public void clearStatus(boolean condition)
Limpa a barra de status se a condição dada for verdadeira. Obs. Esse método não faz com que a barra de status apareça caso ela esteja escondida.

Parameters:
condition - condição.

clearStatus

public void clearStatus()
Limpa a barra de status.


setStatus

public void setStatus(boolean condition,
                      ImageIcon icon,
                      String message,
                      int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone se a condição dada for verdadeira e com um timeout para que a mensagem desapareça.
Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
condition - condição.
icon - ícone
message - mensagem
timeoutSecs - timeout (em segundos)

setStatus

public void setStatus(boolean condition,
                      ImageIcon icon,
                      String message)
Escreve uma mensagem na barra de status precedida por um ícone se a condição dada for verdadeira.
Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
condition - condição.
icon - ícone
message - mensagem

setStatus

public void setStatus(ImageIcon icon,
                      String message)
Escreve uma mensagem na barra de status precedida por um ícone. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
icon - ícone
message - mensagem

setStatus

public void setStatus(ImageIcon icon,
                      String message,
                      int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone e com um timeout para que ela desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
icon - ícone
message - mensagem
timeoutSecs - timeout (em segundos)

setStatus

public void setStatus(boolean condition,
                      String message)
Escreve uma mensagem na barra de status se a condição dada for verdadeira. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
condition - condição.
message - mensagem.

setStatus

public void setStatus(boolean condition,
                      String message,
                      int timeoutSecs)
Escreve uma mensagem na barra de status se a condição dada for verdadeira e com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
condition - condição.
message - mensagem.
timeoutSecs - timeout (em segundos)

setStatus

public void setStatus(String message)
Escreve uma mensagem na barra de status. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
message - mensagem.

setStatus

public void setStatus(String message,
                      int timeoutSecs)
Escreve uma mensagem na barra de status com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.
Obs. se a mensagem for vazia ("") ou nula (null) e se o ícone for nulo (null), será o mesmo que chamar hideStatusBar().

Parameters:
message - mensagem.
timeoutSecs - timeout (em segundos)

setInfo

public void setInfo(boolean condition,
                    String message)
Escreve uma mensagem na barra de status precedida por um ícone de informação se a condição dada for verdadeira. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.

setInfo

public void setInfo(boolean condition,
                    String message,
                    int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de informação se a condição dada for verdadeira e com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.
timeoutSecs - timeout (em segundos)

setInfo

public void setInfo(String message)
Escreve uma mensagem na barra de status precedida por um ícone de informação. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.

setInfo

public void setInfo(String message,
                    int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de informação, com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.
timeoutSecs - timeout (em segundos)

setWarning

public void setWarning(boolean condition,
                       String message)
Escreve uma mensagem na barra de status precedida por um ícone de aviso se a condição dada for verdadeira. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.

setWarning

public void setWarning(boolean condition,
                       String message,
                       int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de aviso se a condição dada for verdadeira e com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.
timeoutSecs - timeout (em segundos)

setWarning

public void setWarning(String message)
Escreve uma mensagem na barra de status precedida por um ícone de aviso. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.

setWarning

public void setWarning(String message,
                       int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de aviso, com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.
timeoutSecs - timeout (em segundos)

setError

public void setError(boolean condition,
                     String message)
Escreve uma mensagem na barra de status precedida por um ícone de erro se a condição dada for verdadeira. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.

setError

public void setError(boolean condition,
                     String message,
                     int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de erro se a condição dada for verdadeira e com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
condition - condição.
message - mensagem.
timeoutSecs - timeout (em segundos)

setError

public void setError(String message)
Escreve uma mensagem na barra de status precedida por um ícone de erro. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.

setError

public void setError(String message,
                     int timeoutSecs)
Escreve uma mensagem na barra de status precedida por um ícone de erro, com um timeout para que a mensagem desapareça. Obs. caso a barra de status estivesse escondida, ela irá aparecer para apresentar a mensagem.

Parameters:
message - mensagem.
timeoutSecs - timeout (em segundos)

shutdownTimer

public void shutdownTimer()
Cancela tasks de atualização da statusbar que ainda estejam pendentes.

Este método só pode ser chamado quando não se pretender mais usar o timer (p.ex. quando a tela for fechada), pois não será possível criar novas tasks após sua execução.


getText

public String getText()
Consulta o texto da status bar.

Returns:
texto

setText

public void setText(String message)
Ajusta o texto da status bar.

Parameters:
message - a mensagem.


Copyright © 2014 Tecgraf/PUC-Rio. All rights reserved.