sears.gui
Class ErrorDialog

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 sears.gui.SearsJDialog
                          extended by sears.gui.ErrorDialog
All Implemented Interfaces:
java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ErrorDialog
extends SearsJDialog

ErrorDialog allows to display 3 things:

ErrorDialog provides static method for access to generics error dialog:
# showOpenErrorDialog(String, String, boolean)
# showSaveErrorDialog(String, String)

See Also:
Serialized Form

Nested Class Summary
 
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
static java.awt.Font BIG_FONT
          derived font of DEFAULT_FONT
static java.awt.Font DEFAULT_FONT
          this font is used for all the dialog's components
static java.awt.Font MIDDLE_FONT
          derived font of DEFAULT_FONT
static java.awt.Font SMALL_FONT
          derived font of DEFAULT_FONT
 
Fields inherited from class sears.gui.SearsJDialog
border, jButtonCancel, jButtonOk, jPanelButtons, validationStatus
 
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
ErrorDialog()
          Constructs a new instance of ErrorDialog
A preferred size is set as default
 
Method Summary
 void appendErrorDetail(java.lang.String detail)
          Appends text to the actual message error
 void clearErrorDetail()
          Clears the error detail
protected  void configureSize()
          Redefines super method, add components to the dialog before compute the it size :D
protected  java.lang.String getDialogName()
          Method getDialogName.
 void setCharsetSelectionVisible(boolean aFlag)
          Indicates if the "charset panel" must be visible or not
protected  void setDetailPanelVisible(boolean visible)
          Used by the arrow button to show or hide the detail panel
 void setErrorDetail(java.lang.String detail)
          Sets a detail error
 void setErrorMessage(java.lang.String message)
          Sets a message error
 void setMainTitle(java.lang.String title)
          Sets the main title
 void setVisible(boolean aFlag)
           
static java.lang.String showOpenErrorDialog(java.lang.String message, java.lang.String detail, boolean reOpenChoice)
          Shows a generic error dialog when file is opened
static void showSaveErrorDialog(java.lang.String message, java.lang.String detail)
          Shows a generic error dialog when file is saved
 void windowClosed(java.awt.event.WindowEvent e)
           
 
Methods inherited from class sears.gui.SearsJDialog
cancelAction, createEmptyBorder, createRootPane, getJButtonCancel, getJPanelButtons, hasBeenValidated, okAction, saveDialogProperties, windowActivated, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
Methods inherited from class javax.swing.JDialog
addImpl, 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, 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, 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, paint, 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

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT
this font is used for all the dialog's components


BIG_FONT

public static final java.awt.Font BIG_FONT
derived font of DEFAULT_FONT


MIDDLE_FONT

public static final java.awt.Font MIDDLE_FONT
derived font of DEFAULT_FONT


SMALL_FONT

public static final java.awt.Font SMALL_FONT
derived font of DEFAULT_FONT

Constructor Detail

ErrorDialog

public ErrorDialog()
Constructs a new instance of ErrorDialog
A preferred size is set as default

Method Detail

configureSize

protected void configureSize()
Redefines super method, add components to the dialog before compute the it size :D

Overrides:
configureSize in class SearsJDialog

setVisible

public void setVisible(boolean aFlag)
Overrides:
setVisible in class java.awt.Dialog

setDetailPanelVisible

protected void setDetailPanelVisible(boolean visible)
Used by the arrow button to show or hide the detail panel

Parameters:
visible - true for show, false for hide

setCharsetSelectionVisible

public void setCharsetSelectionVisible(boolean aFlag)
Indicates if the "charset panel" must be visible or not

Parameters:
aFlag - if true, "charset panel" will be visible.

setMainTitle

public void setMainTitle(java.lang.String title)
Sets the main title

Parameters:
title - the main title to set

setErrorMessage

public void setErrorMessage(java.lang.String message)
Sets a message error

Parameters:
message - the message error to set

setErrorDetail

public void setErrorDetail(java.lang.String detail)
Sets a detail error

Parameters:
detail - the detail error to set

appendErrorDetail

public void appendErrorDetail(java.lang.String detail)
Appends text to the actual message error

Parameters:
detail - the text to append

clearErrorDetail

public void clearErrorDetail()
Clears the error detail


getDialogName

protected java.lang.String getDialogName()
Description copied from class: SearsJDialog
Method getDialogName.
Summary:
This method return the dialog name. It will be used to save the dialog dimensions in the config file.

Specified by:
getDialogName in class SearsJDialog
Returns:
String The dialog name.

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)
Specified by:
windowClosed in interface java.awt.event.WindowListener
Overrides:
windowClosed in class SearsJDialog

showOpenErrorDialog

public static java.lang.String showOpenErrorDialog(java.lang.String message,
                                                   java.lang.String detail,
                                                   boolean reOpenChoice)
Shows a generic error dialog when file is opened

Parameters:
message - the message
detail - the error detail
reOpenChoice - if there's a way to resolve the error with a different charset
Returns:
the charset choosed by the user or null if not

showSaveErrorDialog

public static void showSaveErrorDialog(java.lang.String message,
                                       java.lang.String detail)
Shows a generic error dialog when file is saved

Parameters:
message - the message
detail - the error detail