Package adams.gui.flow

Class FlowPanelNotificationArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.flow.FlowPanelNotificationArea

All Implemented Interfaces:

PopupMenuCustomizer<TextEditorPanel>, ImageObserver, MenuContainer, Serializable, Accessible

public class FlowPanelNotificationArea
extends BasePanel
implements PopupMenuCustomizer<TextEditorPanel>

Shows textual notifications.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowPanelNotificationArea.NotificationType	The type of notification.

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

Modifier and Type	Field	Description
protected List<AbstractNotificationAreaAction>	m_Actions	the available actions.
protected BaseFlatSplitButton	m_ButtonAction	the action button.
protected BaseFlatButton	m_ButtonClose	the close button.
protected BaseCheckBox	m_CheckBoxConsole	the checkbox for including the console output.
protected HashSet<ActionListener>	m_CloseListeners	the close listeners.
protected String	m_Icon	the custom icon to display.
protected String	m_Notification	the notification string.
protected FlowWorkerHandler	m_Owner	the owner.
protected JPanel	m_PanelButtons	the panel for the buttons.
protected TextPanel	m_TextNotification	for displaying the text.
protected FlowPanelNotificationArea.NotificationType	m_Type	the type of notification.

Fields inherited from class adams.gui.core.BasePanel

m_FileChooser

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor	Description
FlowPanelNotificationArea()

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(ActionListener l)	Adds the listener to the list of listeners waiting for the "Close" button to be pressed.
static void	clearIcon(FlowWorkerHandler handler)	Clears any icon.
void	clearNotification()	Removes the notification.
void	customizePopupMenu(TextEditorPanel source, JPopupMenu menu)	For customizing the popup menu.
static void	displayIcon(FlowWorkerHandler handler, FlowPanelNotificationArea.NotificationType type)	Displays the icon associated with the notification type.
static void	displayIcon(FlowWorkerHandler handler, String icon)	Displays the icon.
String	getContent()	Returns the textual content of the notification area.
FlowWorkerHandler	getOwner()	Returns the current owner.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
void	notifyCloseListeners()	Notifies all the listeners that the close button was pressed.
void	printText()	Pops up a print dialog.
void	removeCloseListener(ActionListener l)	Removes the listener from the list of listeners waiting for the "Close" button to be pressed.
void	setOwner(FlowWorkerHandler value)	Sets the owning panel.
void	showNotification(String msg, FlowPanelNotificationArea.NotificationType type)	Displays the notification text.
void	showNotification(String msg, String icon)	Displays the notification text.
protected void	update()	Updates the notification area.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

m_Owner

protected FlowWorkerHandler m_Owner

the owner.

m_TextNotification

protected TextPanel m_TextNotification

for displaying the text.

m_PanelButtons

protected JPanel m_PanelButtons

the panel for the buttons.

m_ButtonClose

protected BaseFlatButton m_ButtonClose

the close button.

m_ButtonAction

protected BaseFlatSplitButton m_ButtonAction

the action button.

m_CheckBoxConsole

protected BaseCheckBox m_CheckBoxConsole

the checkbox for including the console output.

m_CloseListeners

protected HashSet<ActionListener> m_CloseListeners

the close listeners.

m_Notification

protected String m_Notification

the notification string.

m_Type

protected FlowPanelNotificationArea.NotificationType m_Type

the type of notification.

m_Icon

protected String m_Icon

the custom icon to display.

m_Actions

protected List<AbstractNotificationAreaAction> m_Actions

the available actions.

Constructor Detail

FlowPanelNotificationArea

public FlowPanelNotificationArea()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

setOwner

public void setOwner(FlowWorkerHandler value)

Sets the owning panel.

Parameters:

value - the owner

getOwner

public FlowWorkerHandler getOwner()

Returns the current owner.

Returns:

the owner, null if none set

addCloseListener

public void addCloseListener(ActionListener l)

Adds the listener to the list of listeners waiting for the "Close" button to be pressed.

Parameters:

l - the listener to add

removeCloseListener

public void removeCloseListener(ActionListener l)

Removes the listener from the list of listeners waiting for the "Close" button to be pressed.

Parameters:

l - the listener to remove

notifyCloseListeners

public void notifyCloseListeners()

Notifies all the listeners that the close button was pressed.

update

protected void update()

Updates the notification area.

showNotification

public void showNotification(String msg,
                             FlowPanelNotificationArea.NotificationType type)

Displays the notification text.

Parameters:

msg - the text to display

type - the type of notification (info/warning/error)

showNotification

public void showNotification(String msg,
                             String icon)

Displays the notification text.

Parameters:

msg - the text to display

icon - the icon to use

clearNotification

public void clearNotification()

Removes the notification.

customizePopupMenu

public void customizePopupMenu(TextEditorPanel source,
                               JPopupMenu menu)

For customizing the popup menu.

Specified by:

customizePopupMenu in interface PopupMenuCustomizer<TextEditorPanel>

Parameters:

source - the source, e.g., event

menu - the menu to customize

getContent

public String getContent()

Returns the textual content of the notification area.

Returns:

the text

printText

public void printText()

Pops up a print dialog.

displayIcon

public static void displayIcon(FlowWorkerHandler handler,
                               FlowPanelNotificationArea.NotificationType type)

Displays the icon associated with the notification type.

Parameters:

handler - the handler to display the icon with

type - the type of icon to display

displayIcon

public static void displayIcon(FlowWorkerHandler handler,
                               String icon)

Displays the icon.

Parameters:

handler - the handler to display the icon with

icon - the name of the icon to display

clearIcon

public static void clearIcon(FlowWorkerHandler handler)

Clears any icon.

Parameters:

handler - the handler to display the icon with