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

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.sf.freecol.client.gui.panel.FreeColPanel
                      net.sf.freecol.client.gui.panel.FreeColDialog<OptionGroup>
                          net.sf.freecol.client.gui.panel.OptionsDialog

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

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.FreeColFileFilter

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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 java.util.List<javax.swing.JButton>	buttons
protected static javax.swing.filechooser.FileFilter[]	filters
private OptionGroup	group
private javax.swing.JButton	load
protected static java.lang.String	LOAD
private static java.util.logging.Logger	logger
private javax.swing.JPanel	optionPanel
private javax.swing.JButton	reset
private static java.lang.String	RESET
protected javax.swing.JButton	save
private static java.lang.String	SAVE
private OptionGroupUI	ui

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

CANCEL, cancelButton

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

bigHeaderFont, BORDER_COLOR, CELLBORDER, COLUMNS, defaultFont, editable, emptyMargin, HELP, LEFTCELLBORDER, LINK_COLOR, margin, mediumHeaderFont, modifierFormat, OK, okButton, smallHeaderFont, styleContext, TOPCELLBORDER, TOPLEFTCELLBORDER, WARNING_COLOR

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

OptionsDialog(FreeColClient freeColClient, GUI gui, boolean editable)
The constructor that will add the items to this panel.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) This function analyses an event and calls the right methods to take care of the user's requests.
protected java.util.List<javax.swing.JButton>	getButtons()
abstract java.lang.String	getDefaultFileName() Returns the default name of the file to save the OptionGroup.
protected OptionGroup	getGroup()
java.awt.Dimension	getMinimumSize()
abstract java.lang.String	getOptionGroupId() Returns the ID of the OptionGroup.
protected OptionGroupUI	getOptionUI()
java.awt.Dimension	getPreferredSize()
protected void	initialize(OptionGroup group, java.lang.String header, java.awt.Component component)
protected boolean	isGroupEditable()
protected void	load(java.io.File file) Load OptionGroup from given File.
protected boolean	loadCustomOptions() Load custom OptionGroup from default file.
protected void	updateUI(OptionGroup group)

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

createChoiceDialog, createConfirmDialog, createConfirmDialog, createInputDialog, createLoadDialog, createMapSizeDialog, createSaveDialog, getFGOFileFilter, getFSGFileFilter, getGameOptionsFileFilter, getResponse, initialize, resetResponse, setResponse

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

addClosingCallback, createColonyButton, enterPressesWhenFocused, getCanvas, getClientOptions, getController, getDefaultHeader, getDefaultTextArea, getDefaultTextArea, getDefaultTextPane, getDefaultTextPane, getElectionTurns, getFreeColClient, getGame, getGUI, getLibrary, getLinkButton, getModifierFormat, getMyPlayer, getSavedPosition, getSavedSize, getSortedColonies, getSpecification, isEditable, localizedLabel, localizedLabel, notifyClose, requestFocus, restoreSavedSize, restoreSavedSize, setCancelComponent, setEditable, sortModifiers

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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

RESET

private static final java.lang.String RESET

See Also:

Constant Field Values

SAVE

private static final java.lang.String SAVE

See Also:

Constant Field Values

LOAD

protected static final java.lang.String LOAD

See Also:

Constant Field Values

ui

private OptionGroupUI ui

group

private OptionGroup group

reset

private javax.swing.JButton reset

load

private javax.swing.JButton load

save

protected javax.swing.JButton save

optionPanel

private javax.swing.JPanel optionPanel

buttons

private java.util.List<javax.swing.JButton> buttons

filters

protected static final javax.swing.filechooser.FileFilter[] filters

Constructor Detail

OptionsDialog

public OptionsDialog(FreeColClient freeColClient,
                     GUI gui,
                     boolean editable)

The constructor that will add the items to this panel.

Parameters:

freeColClient -

parent - Canvas The parent of this panel

editable - boolean

Method Detail

initialize

protected void initialize(OptionGroup group,
                          java.lang.String header,
                          java.awt.Component component)

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getOptionUI

protected OptionGroupUI getOptionUI()

isGroupEditable

protected boolean isGroupEditable()

getButtons

protected java.util.List<javax.swing.JButton> getButtons()

updateUI

protected void updateUI(OptionGroup group)

getGroup

protected OptionGroup getGroup()

getDefaultFileName

public abstract java.lang.String getDefaultFileName()

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

Returns:

String

getOptionGroupId

public abstract java.lang.String getOptionGroupId()

Returns the ID of the OptionGroup.

Returns:

String

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

This function analyses an event and calls the right methods to take care of the user's requests.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FreeColDialog<OptionGroup>

Parameters:

event - ActionEvent, the incoming action event

load

protected void load(java.io.File file)

Load OptionGroup from given File.

Parameters:

file - a File value

loadCustomOptions

protected boolean loadCustomOptions()

Load custom OptionGroup from default file.

Returns:

true if custom options were loaded