org.biomoby.service.dashboard
Class CommonConsole

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.biomoby.service.dashboard.CommonConsole

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible

public class CommonConsole
extends JPanel
implements PropertyChangeListener

A simple console component. It allows:

• to display text in a text area (not-editable) - but see SimpleClientPanel how to make it editable easily}
• to do it in an append or override mode,
• to increase and decrease used font size,
• to listen to events and display their contents if in verbose mode,
• to clean the area, and
• to save its contents to a file

Version:

$Id: CommonConsole.java,v 1.11 2008/03/02 12:45:26 senger Exp $

Author:

Martin Senger

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

static String

VERBOSE_EVENT A default name of property change event that is considered to carry verbose messages.

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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

CommonConsole()
Constructor.

Method Summary

void	clean() Clean the console (disregading of any current modes).
JTextArea	getArea() Direct access to the text area.
boolean	hasAppendModeSwitcher()
boolean	hasCleanButton()
boolean	hasSaveButton()
boolean	hasVerboseModeSwitcher()
boolean	isAppendMode()
boolean	isVerboseMode()
void	propertyChange(PropertyChangeEvent event) Here this instance is notified when somebody fires a verbose message.
boolean	setAppendMode(boolean enabled)
void	setEnabledAppendMode(boolean enabled) This allows to disable and enable append-mode check box - so user cannot change the append more.
void	setPropertyChannel(PropertyChannel propertyChannel) Remember the property channel.
void	setText(String value)
void	setVerboseEventName(String eventName) Remember what event name will be considered by this instance for its verbose messages.
boolean	setVerboseMode(boolean enabled)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

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

Field Detail

VERBOSE_EVENT

public static final String VERBOSE_EVENT

A default name of property change event that is considered to carry verbose messages. It is used unless a different name is set by setVerboseEventName(java.lang.String).

See Also:

Constant Field Values

Constructor Detail

CommonConsole

public CommonConsole()

Constructor.

Method Detail

getArea

public JTextArea getArea()

Direct access to the text area.

setText

public void setText(String value)

clean

public void clean()

Clean the console (disregading of any current modes).

setAppendMode

public boolean setAppendMode(boolean enabled)

isAppendMode

public boolean isAppendMode()

setEnabledAppendMode

public void setEnabledAppendMode(boolean enabled)

This allows to disable and enable append-mode check box - so user cannot change the append more. This is useful for a sequence of messages that we do not want to be cleaned in the middle.

setVerboseMode

public boolean setVerboseMode(boolean enabled)

isVerboseMode

public boolean isVerboseMode()

setPropertyChannel

public void setPropertyChannel(PropertyChannel propertyChannel)

Remember the property channel. It will be used for listening to the the verbose messages.

setVerboseEventName

public void setVerboseEventName(String eventName)

Remember what event name will be considered by this instance for its verbose messages.

propertyChange

public void propertyChange(PropertyChangeEvent event)

Here this instance is notified when somebody fires a verbose message. Only events carrying verbose messages are used here. The verbose messages are those with name set by setVerboseEventName(java.lang.String) (default is defined by VERBOSE_EVENT).

Specified by:

propertyChange in interface PropertyChangeListener

hasCleanButton

public boolean hasCleanButton()

hasSaveButton

public boolean hasSaveButton()

hasAppendModeSwitcher

public boolean hasAppendModeSwitcher()

hasVerboseModeSwitcher

public boolean hasVerboseModeSwitcher()