net.sf.freecol.client.gui.panel

Class FreeColDialog<T>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

net.sf.freecol.client.gui.panel.FreeColDialog<T>

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

CaptureGoodsDialog, ChooseFoundingFatherDialog, ConfirmDeclarationDialog, DumpCargoDialog, EditSettlementDialog, FreeColChoiceDialog, FreeColConfirmDialog, FreeColInputDialog, LoadDialog, MonarchDialog, NegotiationDialog, OptionsDialog, ParametersDialog, SaveDialog, ScaleMapSizeDialog, SelectDestinationDialog

public class FreeColDialog<T>
extends javax.swing.JDialog
implements java.beans.PropertyChangeListener

Superclass for all dialogs in FreeCol.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FreeColDialog.DialogType

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, java.awt.Window.Type

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

Fields

Modifier and Type	Field and Description
protected FreeColClient	freeColClient The enclosing client.
private static java.util.logging.Logger	logger
protected boolean	modal Is this dialog modal?
protected java.util.List<ChoiceItem<T>>	options The options to choose from.
private javax.swing.JOptionPane	pane The JOptionPane to embed in this dialog.

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

Constructors

Modifier	Constructor and Description
protected	FreeColDialog(FreeColClient freeColClient, javax.swing.JFrame frame) Protected constructor for the subclass panels.
	FreeColDialog(FreeColClient freeColClient, javax.swing.JFrame frame, FreeColDialog.DialogType type, boolean modal, java.lang.Object obj, javax.swing.ImageIcon icon, java.util.List<ChoiceItem<T>> options) Full constructor for canvas to build a dialog in one hit (supplying the getResponse() implementation).

Method Summary

Modifier and Type	Method and Description
static <T> java.util.List<ChoiceItem<T>>	choices() Create a list of choices.
protected FreeColClient	getFreeColClient() Get the FreeColClient.
protected Game	getGame() Get the game.
protected SwingGUI	getGUI() Get the GUI.
protected ImageLibrary	getImageLibrary() Get the Image library.
protected Player	getMyPlayer() Get the player.
T	getResponse() Get the response from this dialog.
protected Specification	getSpecification() Gets the specification.
protected java.lang.Object	getValue() Get the response that was set by JOptionPane.setValue(java.lang.Object) and clean up the dialog.
protected InGameController	igc() Get the client controller.
protected void	initializeDialog(javax.swing.JFrame frame, FreeColDialog.DialogType type, boolean modal, java.lang.Object obj, javax.swing.ImageIcon icon, java.util.List<ChoiceItem<T>> options) Complete the initialization.
boolean	isModal() Is this a modal dialog?
private static void	iterateOverOpaqueLayersComponents(javax.swing.JComponent j)
void	propertyChange(java.beans.PropertyChangeEvent e)
void	removeNotify()
void	requestFocus()
boolean	responded() Has this dialog been given a response.
private int	selectDefault(java.util.List<ChoiceItem<T>> options) Select the default option from the supplied options.
private java.lang.Object[]	selectOptions() Collect the enabled options and return as an array so as to be able to pass to the JOptionPane constructor.
private static void	setOpaqueLayerRecursive(java.awt.Component opaqueComponent)
static void	setSubcomponentsNotOpaque(javax.swing.JComponent j)
protected void	setValue(java.lang.Object value) Set the value of this dialog.
void	setVisible(boolean val)

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, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

logger

private static final java.util.logging.Logger logger

freeColClient

protected final FreeColClient freeColClient

The enclosing client.

modal

protected boolean modal

Is this dialog modal?

options

protected java.util.List<ChoiceItem<T>> options

The options to choose from.

pane

private javax.swing.JOptionPane pane

The JOptionPane to embed in this dialog.

Constructor Detail

FreeColDialog

protected FreeColDialog(FreeColClient freeColClient,
                        javax.swing.JFrame frame)

Protected constructor for the subclass panels.

Parameters:

freeColClient - The FreeColClient for the game.

frame - The owner frame.

FreeColDialog

public FreeColDialog(FreeColClient freeColClient,
                     javax.swing.JFrame frame,
                     FreeColDialog.DialogType type,
                     boolean modal,
                     java.lang.Object obj,
                     javax.swing.ImageIcon icon,
                     java.util.List<ChoiceItem<T>> options)

Full constructor for canvas to build a dialog in one hit (supplying the getResponse() implementation). Much of this was extracted from the source for JOptionPane.createDialog. We needed a way to control modality.

Parameters:

freeColClient - The FreeColClient for the game.

frame - The owner frame.

type - The DialogType to create.

modal - Should this dialog be modal?

obj - The main object that explains the choice for the user, usually just a string, but may be more complex.

icon - An optional icon to display.

options - A list of options to choose from.

Method Detail

selectDefault

private int selectDefault(java.util.List<ChoiceItem<T>> options)

Select the default option from the supplied options.

Parameters:

options - A list of options to choose from.

Returns:

The option to select initially.

selectOptions

private java.lang.Object[] selectOptions()

Collect the enabled options and return as an array so as to be able to pass to the JOptionPane constructor.

Returns:

An array of enabled options.

initializeDialog

protected final void initializeDialog(javax.swing.JFrame frame,
                                      FreeColDialog.DialogType type,
                                      boolean modal,
                                      java.lang.Object obj,
                                      javax.swing.ImageIcon icon,
                                      java.util.List<ChoiceItem<T>> options)

Complete the initialization. Useful for subclasses that need to construct a non-trivial object to display in the JOptionPane.

Parameters:

frame - The owner frame.

type - The DialogType to create.

modal - Should this dialog be modal?

obj - The main object that explains the choice for the user, usually just a string, but may be more complex.

icon - An optional icon to display.

options - A list of options to choose from.

setSubcomponentsNotOpaque

public static void setSubcomponentsNotOpaque(javax.swing.JComponent j)

iterateOverOpaqueLayersComponents

private static void iterateOverOpaqueLayersComponents(javax.swing.JComponent j)

setOpaqueLayerRecursive

private static void setOpaqueLayerRecursive(java.awt.Component opaqueComponent)

getFreeColClient

protected FreeColClient getFreeColClient()

Get the FreeColClient.

Returns:

The FreeColClient.

getGUI

protected SwingGUI getGUI()

Get the GUI.

Returns:

The GUI.

igc

protected InGameController igc()

Get the client controller.

Returns:

The client InGameController.

getImageLibrary

protected ImageLibrary getImageLibrary()

Get the Image library.

Returns:

The ImageLibrary.

getGame

protected Game getGame()

Get the game.

Returns:

The Game.

getSpecification

protected Specification getSpecification()

Gets the specification.

Returns:

The specification from the game.

getMyPlayer

protected Player getMyPlayer()

Get the player.

Returns:

The current Player.

getValue

protected java.lang.Object getValue()

Get the response that was set by JOptionPane.setValue(java.lang.Object) and clean up the dialog. Used by implementors of getResponse().

Returns:

The pane value.

setValue

protected void setValue(java.lang.Object value)

Set the value of this dialog.

Parameters:

value - The new value.

responded

public boolean responded()

Has this dialog been given a response.

Returns:

True if the dialog has a response.

getResponse

public T getResponse()

Get the response from this dialog.

Returns:

The response from this dialog.

isModal

public boolean isModal()

Is this a modal dialog?

Overrides:

isModal in class java.awt.Dialog

Returns:

True if this is a modal dialog.

choices

public static <T> java.util.List<ChoiceItem<T>> choices()

Create a list of choices.

Returns:

An empty list of choices.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setVisible

public void setVisible(boolean val)

Overrides:

setVisible in class java.awt.Dialog

removeNotify

public void removeNotify()

Overrides:

removeNotify in class java.awt.Window

requestFocus

public void requestFocus()

Overrides:

requestFocus in class java.awt.Component