HiRISE

HiRISE.HiPlan.HOGG
Class Message_Panel

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 HiRISE.HiPlan.HOGG.Message_Panel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class Message_Panel
extends JPanel

A message panel capable of showing formatted text.

Version:
2.5
Author:
Christian Schaller - UA/PIRL
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
static SimpleAttributeSet ATTENTION_STYLE
          A text style suitable for messages meant to get the operator's attention.
static SimpleAttributeSet BLUE_STYLE
          A bold, blue text style.
static SimpleAttributeSet ERROR_STYLE
          A text style suitable for error messages.
static SimpleAttributeSet GREEN_STYLE
          A bold, green text style.
static String ID
          Class identification name with source code version and date.
static SimpleAttributeSet ORANGE_STYLE
          A bold, orange text style.
static SimpleAttributeSet PLAIN_STYLE
          The plain text style for messages.
static SimpleAttributeSet RED_STYLE
          A bold, ed text style.
static SimpleAttributeSet SUCCESS_STYLE
          A text style suitable for success messages.
static SimpleAttributeSet WARNING_STYLE
          A text style suitable for warning messages.
 
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
Message_Panel()
          Creates a new message panel.
 
Method Summary
 void append(String msg)
          Adds a plain message to the panel.
 void append(String msg, AttributeSet attributes)
          Adds a message to the panel using the given attribute set.
 void appendAttentionMessage(String msg)
          Adds an attention message to the panel.
 void appendBlueMessage(String msg)
          Adds blue-text message to the panel.
 void appendErrorMessage(String msg)
          Adds an error message to the panel.
 void appendGreenMessage(String msg)
          Adds green-text message to the panel.
 void appendOrangeMessage(String msg)
          Adds orange-text message to the panel.
 void appendRedMessage(String msg)
          Adds red-text message to the panel.
 void appendSuccessMessage(String msg)
          Adds an success message to the panel.
 void appendWarningMessage(String msg)
          Adds a warning message to the panel.
 void clear()
          Clears all messages from the panel.
 JTextPane getJTextPane()
          Gets the message panel's message text area.
 
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, 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, 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
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

PLAIN_STYLE

public static final SimpleAttributeSet PLAIN_STYLE
The plain text style for messages. It uses a slightly smaller font than the default font size, but otherwise has the default attributes of the SimpleAttributeSet.


ATTENTION_STYLE

public static final SimpleAttributeSet ATTENTION_STYLE
A text style suitable for messages meant to get the operator's attention. It uses the same font size as the PLAIN_STYLE, but the text is bold and blue.


SUCCESS_STYLE

public static final SimpleAttributeSet SUCCESS_STYLE
A text style suitable for success messages. It uses the same font size as the PLAIN_STYLE, but the text is bold and dark green.


WARNING_STYLE

public static final SimpleAttributeSet WARNING_STYLE
A text style suitable for warning messages. It uses the same font size as the PLAIN_STYLE, but the text is bold and dark orange.


ERROR_STYLE

public static final SimpleAttributeSet ERROR_STYLE
A text style suitable for error messages. It uses the same font size as the PLAIN_STYLE, but the text is bold and red.


BLUE_STYLE

public static final SimpleAttributeSet BLUE_STYLE
A bold, blue text style. It uses the same font size as the PLAIN_STYLE. It is identical to the ATTENTION_STYLE.


GREEN_STYLE

public static final SimpleAttributeSet GREEN_STYLE
A bold, green text style. It uses the same font size as the PLAIN_STYLE. It is identical to the SUCCESS_STYLE.


ORANGE_STYLE

public static final SimpleAttributeSet ORANGE_STYLE
A bold, orange text style. It uses the same font size as the PLAIN_STYLE. It is identical to the WARNING_STYLE.


RED_STYLE

public static final SimpleAttributeSet RED_STYLE
A bold, ed text style. It uses the same font size as the PLAIN_STYLE. It is identical to the ERROR_STYLE.

Constructor Detail

Message_Panel

public Message_Panel()
Creates a new message panel.

Method Detail

getJTextPane

public JTextPane getJTextPane()
Gets the message panel's message text area.

Returns:
the message text area.

clear

public void clear()
Clears all messages from the panel.


append

public void append(String msg,
                   AttributeSet attributes)
Adds a message to the panel using the given attribute set. If the attribute set is null, the PLAIN_STYLE will be used. If the message is null, the panel will be cleared.

Parameters:
msg - the message to add.
attributes - the attribute set to be applied to the message.

append

public void append(String msg)
Adds a plain message to the panel. The PLAIN_STYLE style is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendAttentionMessage

public void appendAttentionMessage(String msg)
Adds an attention message to the panel. The ATTENTION_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendSuccessMessage

public void appendSuccessMessage(String msg)
Adds an success message to the panel. The SUCCESS_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendWarningMessage

public void appendWarningMessage(String msg)
Adds a warning message to the panel. The WARNING_STYLE style is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendErrorMessage

public void appendErrorMessage(String msg)
Adds an error message to the panel. The ERROR_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendBlueMessage

public void appendBlueMessage(String msg)
Adds blue-text message to the panel. The BLUE_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendGreenMessage

public void appendGreenMessage(String msg)
Adds green-text message to the panel. The GREEN_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendOrangeMessage

public void appendOrangeMessage(String msg)
Adds orange-text message to the panel. The ORANGE_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

appendRedMessage

public void appendRedMessage(String msg)
Adds red-text message to the panel. The RED_STYLE is used. If msg is null, the panel will be cleared.

Parameters:
msg - the message to add.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona