org.lyra.Interface
Class CloseApplicationDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.lyra.Interface.CloseApplicationDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class CloseApplicationDialog
extends javax.swing.JDialog
implements java.lang.Runnable

Basic user interface allowing the user to confirm if they want to terminate execution. Also permits the user to make this feature disappear unless they explicitly want it.

With this class the constructors are hidden outside of the class itself as we make use of a Static function to create the instance and extract the response from the user:

if (CloseApplicationDialog.getVerdict) { ... Close the application }

Version:
1.0.5, %Revision, 174%, %LastChangedDate, 27/10/12 3:33PM%
Author:
Martin Foster
See Also:
Serialized Form

Nested Class Summary
private  class CloseApplicationDialog.Interact
          Implements the most basic logic elements.
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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
private  CloseApplicationDialog.Interact Action
           
private  javax.swing.JTextPane areaNotice
           
private  javax.swing.JButton buttonAccept
           
private  javax.swing.JButton buttonCancel
           
private  javax.swing.JCheckBox checkPrompt
           
private  javax.swing.JLabel iconResize
           
private  javax.swing.JPanel jContentPane
           
private  javax.swing.JLabel labelPrompt
           
private  java.util.Map<java.lang.String,java.lang.String> Lang
           
private  Ledger Logger
           
private  Comptroller Manager
           
private  javax.swing.JPanel panelAction
           
private  javax.swing.JPanel panelMain
           
private  javax.swing.JPanel panelPrompt
           
private  javax.swing.JPanel panelStatus
           
private  boolean Process
           
private static boolean Return
           
private static long serialVersionUID
           
private  java.lang.Thread Waitor
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
private CloseApplicationDialog(Ledger logger, Comptroller manager, java.util.Map<java.lang.String,java.lang.String> lang, java.awt.Window owner)
          Primary constructor used by the application.
 
Method Summary
private  javax.swing.JTextPane getAreaNotice()
          This method initialises areaNotice.
private  javax.swing.JButton getButtonAccept()
          This method initialises buttonAccept
private  javax.swing.JButton getButtonCancel()
          This method initialises buttonCancel.
private  javax.swing.JCheckBox getCheckPrompt()
          This method initialises checkPrompt.
private  javax.swing.JLabel getIconResize()
          This method initialises iconResize
private  javax.swing.JPanel getJContentPane()
          This method initialises jContentPane.
private  javax.swing.JLabel getLabelPrompt()
          This method initialises labelPrompt.
private  javax.swing.JPanel getPanelAction()
          This method initialises panelAction.
private  javax.swing.JPanel getPanelMain()
          This method initialises panelMain.
private  javax.swing.JPanel getPanelPrompt()
          This method initialises panelPrompt.
private  javax.swing.JPanel getPanelStatus()
          This method initialises panelStatus
static boolean getVerdict(Ledger logger, Comptroller manager, java.util.Map<java.lang.String,java.lang.String> lang, java.awt.Window parent)
          Element which will deal with the creation of the class instance and extracting the information prior to returning it to the calling program.
private  void initDialog(java.awt.Window owner)
          This method initialises the user elements along with the look and feel of the interface.
 void run()
          This method will wait out until the HashMap is defined.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

jContentPane

private javax.swing.JPanel jContentPane

panelAction

private javax.swing.JPanel panelAction

panelMain

private javax.swing.JPanel panelMain

panelPrompt

private javax.swing.JPanel panelPrompt

panelStatus

private javax.swing.JPanel panelStatus

checkPrompt

private javax.swing.JCheckBox checkPrompt

labelPrompt

private javax.swing.JLabel labelPrompt

iconResize

private javax.swing.JLabel iconResize

buttonAccept

private javax.swing.JButton buttonAccept

buttonCancel

private javax.swing.JButton buttonCancel

areaNotice

private javax.swing.JTextPane areaNotice

Lang

private java.util.Map<java.lang.String,java.lang.String> Lang

Waitor

private java.lang.Thread Waitor

Manager

private Comptroller Manager

Logger

private Ledger Logger

Process

private boolean Process

Return

private static boolean Return

Action

private CloseApplicationDialog.Interact Action
Constructor Detail

CloseApplicationDialog

private CloseApplicationDialog(Ledger logger,
                               Comptroller manager,
                               java.util.Map<java.lang.String,java.lang.String> lang,
                               java.awt.Window owner)
Primary constructor used by the application. Will provide logging and language independent display.

Parameters:
logger - Ledger instance for logging actions.
manager - Comptroller instance for establishing settings.
lang - Map containing language elements.
owner - Frame to block.
Method Detail

getVerdict

public static boolean getVerdict(Ledger logger,
                                 Comptroller manager,
                                 java.util.Map<java.lang.String,java.lang.String> lang,
                                 java.awt.Window parent)
Element which will deal with the creation of the class instance and extracting the information prior to returning it to the calling program.

Parameters:
logger - Ledger instance for logging actions.
manager - Comptroller instance for establishing settings.
lang - Map containing language elements.
parent - Frame to block.
Returns:
boolean confirming user choice.

run

public void run()
This method will wait out until the HashMap is defined. If not it will sleep until interrupted.

Specified by:
run in interface java.lang.Runnable

initDialog

private void initDialog(java.awt.Window owner)
This method initialises the user elements along with the look and feel of the interface. Permits the use of multiple constructor but a single drawing element.

Parameters:
owner - Frame attached to this endeavour.

getJContentPane

private javax.swing.JPanel getJContentPane()
This method initialises jContentPane.

Returns:
javax.swing.JPanel

getPanelMain

private javax.swing.JPanel getPanelMain()
This method initialises panelMain.

Returns:
javax.swing.JPanel

getPanelPrompt

private javax.swing.JPanel getPanelPrompt()
This method initialises panelPrompt.

Returns:
javax.swing.JPanel

getPanelAction

private javax.swing.JPanel getPanelAction()
This method initialises panelAction.

Returns:
javax.swing.JPanel

getCheckPrompt

private javax.swing.JCheckBox getCheckPrompt()
This method initialises checkPrompt.

Returns:
javax.swing.JCheckBox

getLabelPrompt

private javax.swing.JLabel getLabelPrompt()
This method initialises labelPrompt.

Returns:
javax.swing.JLabel

getButtonAccept

private javax.swing.JButton getButtonAccept()
This method initialises buttonAccept

Returns:
javax.swing.JButton

getButtonCancel

private javax.swing.JButton getButtonCancel()
This method initialises buttonCancel.

Returns:
javax.swing.JButton

getAreaNotice

private javax.swing.JTextPane getAreaNotice()
This method initialises areaNotice.

Returns:
javax.swing.JTextPane

getPanelStatus

private javax.swing.JPanel getPanelStatus()
This method initialises panelStatus

Returns:
javax.swing.JPanel

getIconResize

private javax.swing.JLabel getIconResize()
This method initialises iconResize

Returns:
javax.swing.JLabel