net.sf.freecol.client.gui.panel

Class OptionsDialog

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<OptionGroup>

net.sf.freecol.client.gui.panel.OptionsDialog

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:

ClientOptionsDialog, DifficultyDialog, GameOptionsDialog, MapGeneratorOptionsDialog

public abstract class OptionsDialog
extends FreeColDialog<OptionGroup>

Dialog for changing the options of an OptionGroup.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.freecol.client.gui.panel.FreeColDialog

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
private java.lang.String	defaultFileName
private boolean	editable
private OptionGroup	group
private static java.util.logging.Logger	logger
private java.lang.String	optionGroupId
private MigPanel	optionPanel
protected MigPanel	panel
private javax.swing.JScrollPane	scrollPane
private OptionGroupUI	ui

Fields inherited from class net.sf.freecol.client.gui.panel.FreeColDialog

freeColClient, modal, options

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

Constructor and Description
OptionsDialog(FreeColClient freeColClient, javax.swing.JFrame frame, boolean editable, OptionGroup group, java.lang.String headerKey, java.lang.String defaultFileName, java.lang.String optionGroupId) The constructor that will add the items to this panel.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getDefaultFileName() Get the default name of the file to save the OptionGroup.
protected OptionGroup	getGroup() Get the option group being displayed by this dialog.
protected java.lang.String	getOptionGroupId() Get the identifier of the OptionGroup.
protected OptionGroupUI	getOptionUI() Get the option group UI controlling this dialog.
OptionGroup	getResponse() Get the response from this dialog.
protected void	initialize(javax.swing.JFrame frame) Initialize this dialog.
protected boolean	isEditable() Is this dialog editable?
protected boolean	load(java.io.File file) Load an option group from given File.
protected boolean	loadDefaultOptions() Load the option group from the default file.
private void	preparePanel(java.lang.String headerKey, OptionGroupUI ui) Load the panel.
private void	reset(OptionGroup group) Reset the group for this panel.
protected boolean	save(java.io.File file) Save an option group to a given File.
protected boolean	saveDefaultOptions() Save the option group to the default file.

Methods inherited from class net.sf.freecol.client.gui.panel.FreeColDialog

choices, getFreeColClient, getGame, getGUI, getImageLibrary, getMyPlayer, getSpecification, getValue, igc, initializeDialog, isModal, propertyChange, removeNotify, requestFocus, responded, setSubcomponentsNotOpaque, setValue, setVisible

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

editable

private final boolean editable

group

private OptionGroup group

ui

private OptionGroupUI ui

defaultFileName

private final java.lang.String defaultFileName

optionGroupId

private final java.lang.String optionGroupId

scrollPane

private javax.swing.JScrollPane scrollPane

optionPanel

private MigPanel optionPanel

panel

protected MigPanel panel

Constructor Detail

OptionsDialog

public OptionsDialog(FreeColClient freeColClient,
                     javax.swing.JFrame frame,
                     boolean editable,
                     OptionGroup group,
                     java.lang.String headerKey,
                     java.lang.String defaultFileName,
                     java.lang.String optionGroupId)

The constructor that will add the items to this panel.

Parameters:

freeColClient - The FreeColClient for the game.

frame - The owner frame.

editable - Whether the dialog is editable.

Method Detail

isEditable

protected boolean isEditable()

Is this dialog editable?

Returns:

True if the dialog is editable.

getGroup

protected OptionGroup getGroup()

Get the option group being displayed by this dialog.

Returns:

The OptionGroup.

getOptionUI

protected OptionGroupUI getOptionUI()

Get the option group UI controlling this dialog.

Returns:

The OptionGroupUI.

getDefaultFileName

protected java.lang.String getDefaultFileName()

Get the default name of the file to save the OptionGroup.

Returns:

A default file name.

getOptionGroupId

protected java.lang.String getOptionGroupId()

Get the identifier of the OptionGroup.

Returns:

The option group identifier.

preparePanel

private void preparePanel(java.lang.String headerKey,
                          OptionGroupUI ui)

Load the panel.

initialize

protected void initialize(javax.swing.JFrame frame)

Initialize this dialog.

Parameters:

frame - The owner frame.

reset

private void reset(OptionGroup group)

Reset the group for this panel.

Parameters:

group - The new OptionGroup.

load

protected boolean load(java.io.File file)

Load an option group from given File.

Parameters:

file - A File to load from.

Returns:

True if the load succeeded.

save

protected boolean save(java.io.File file)

Save an option group to a given File.

Parameters:

file - The File to save to.

Returns:

True if the save succeeded.

loadDefaultOptions

protected boolean loadDefaultOptions()

Load the option group from the default file.

Returns:

True if the options were loaded.

saveDefaultOptions

protected boolean saveDefaultOptions()

Save the option group to the default file.

Returns:

True if the options were saved.

getResponse

public OptionGroup getResponse()

Get the response from this dialog.

Overrides:

getResponse in class FreeColDialog<OptionGroup>

Returns:

The response from this dialog.