soc.client
Class NotifyDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  soc.client.AskDialog
                      soc.client.NotifyDialog

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible

 class NotifyDialog
extends AskDialog

This is a generic dialog to popup a message to the player, with one button. Asynchronously returns, and then the dialog sticks around not affecting anything, until the user dismisses it. At that point it only disappears. A callback can be added later if needed.

Since:

1.1.06

Author:

Jeremy D Monin <jeremy@nand.net>

Nested Class Summary

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 static SOCStringManager

strings i18n text strings

Fields inherited from class soc.client.AskDialog

choice1But, choice2But, choice3But, choiceDefault, didReqFocus, isMsgMultiLine, msg, padH, padW, pBtns, pcli, pi, wantH, wantW

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

protected

NotifyDialog(SOCPlayerClient.GameAwtDisplay cli, java.awt.Frame gamePI, java.lang.String promptText, java.lang.String btnText, boolean hasDefault) Creates a new NotifyDialog.

Method Summary

void	button1Chosen() React to the button.
void	button2Chosen() Required stub; there is no button 2 in this dialog.
static void	createAndShow(SOCPlayerClient.GameAwtDisplay cli, java.awt.Frame gamePI, java.lang.String promptText, java.lang.String btnText, boolean hasDefault) Creates and shows a new NotifyDialog.
void	windowCloseChosen() React to the dialog window closed by user.

Methods inherited from class soc.client.AskDialog

actionPerformed, button3Chosen, checkSizeAndFocus, firstLine, getParentFrame, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, run, styleAsDefault, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.awt.Dialog

addNotify, getAccessibleContext, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, paramString, 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, processWindowEvent, 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, addImpl, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, getGraphics, 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, 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

strings

private static final SOCStringManager strings

i18n text strings

Constructor Detail

NotifyDialog

protected NotifyDialog(SOCPlayerClient.GameAwtDisplay cli,
                       java.awt.Frame gamePI,
                       java.lang.String promptText,
                       java.lang.String btnText,
                       boolean hasDefault)

Creates a new NotifyDialog.

Parameters:

cli - Player client interface

gamePI - Current game's player interface, or another Frame for our parent window, or null to look for cli's Frame as parent

promptText - Prompt text appearing above button; also used for the dialog title (if multiple lines, first line is title)

btnText - Button text

hasDefault - Button is default (responds to Enter)

Throws:

java.lang.IllegalArgumentException - If cli or btnText is null

Method Detail

createAndShow

public static void createAndShow(SOCPlayerClient.GameAwtDisplay cli,
                                 java.awt.Frame gamePI,
                                 java.lang.String promptText,
                                 java.lang.String btnText,
                                 boolean hasDefault)
                          throws java.lang.IllegalArgumentException

Creates and shows a new NotifyDialog. Calls EventQueue.invokeLater(Runnable) to ensure it displays from the proper thread.

Parameters:

cli - Player client interface

gamePI - Current game's player interface, or another Frame for our parent window, or null to look for cli's Frame as parent

promptText - Prompt text appearing above button; also used for the dialog title (if multiple lines, first line is title)

btnText - Button text, or null for "OK"

hasDefault - Button is default (responds to Enter)

Throws:

java.lang.IllegalArgumentException - If cli, promptText, or btnText is null

button1Chosen

public void button1Chosen()

React to the button. (AskDialog will dismiss the dialog)

Specified by:

button1Chosen in class AskDialog

button2Chosen

public void button2Chosen()

Required stub; there is no button 2 in this dialog.

Specified by:

button2Chosen in class AskDialog

windowCloseChosen

public void windowCloseChosen()

React to the dialog window closed by user. (Nothing to do)

Specified by:

windowCloseChosen in class AskDialog