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

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by net.sf.freecol.client.gui.panel.FreeColPanel
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:
AboutPanel, BuildQueuePanel, CargoPanel, ChatPanel, ColonyPanel, ColonyPanel.TilePanel, ColopediaPanel, DumpCargoDialog, EuropePanel, FreeColDialog, IndianSettlementPanel, InfoPanel, MainPanel, MapEditorTransformPanel, NewPanel, ReportPanel, ServerListPanel, StartGamePanel, StatisticsPanel, StatusPanel, TilePanel, VictoryPanel, WorkProductionPanel

public class FreeColPanel
extends javax.swing.JPanel
implements java.awt.event.ActionListener

Superclass for all panels in FreeCol.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
static javax.swing.border.Border CELLBORDER
           
static java.awt.Insets emptyMargin
           
static javax.swing.border.Border LEFTCELLBORDER
           
static javax.swing.border.Border TOPCELLBORDER
           
static javax.swing.border.Border TOPLEFTCELLBORDER
           
 
Fields inherited from class javax.swing.JComponent
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
FreeColPanel(Canvas parent)
          Constructor.
FreeColPanel(Canvas parent, java.awt.LayoutManager layout)
          Default constructor.
 
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.
static java.awt.event.MouseListener createEventForwardingMouseListener(java.awt.Component c)
          Creates a MouseListener which forwards events to the given Component.
static java.awt.event.MouseMotionListener createEventForwardingMouseMotionListener(java.awt.Component c)
          Creates a MouseMotionListener which forwards events to the given Component.
static void enterPressesWhenFocused(javax.swing.JButton button)
          Registers enter key for a JButton.
 Canvas getCanvas()
          Get the Canvas value.
 FreeColClient getClient()
          Describe getClient method here.
 InGameController getController()
          Describe getController method here.
static javax.swing.JLabel getDefaultHeader(java.lang.String text)
          Returns the default header for panels.
static javax.swing.JTextArea getDefaultTextArea(java.lang.String text)
          Returns a text area with standard settings suitable for use in FreeCol dialogs.
static javax.swing.JTextArea getDefaultTextArea(java.lang.String text, int columns)
          Returns a text area with standard settings suitable for use in FreeCol dialogs.
static javax.swing.JTextPane getDefaultTextPane()
          Get a JTextPane with default styles.
static javax.swing.JTextPane getDefaultTextPane(java.lang.String text)
          Get a JTextPane with default styles and given text.
 Game getGame()
          Describe getGame method here.
 ImageLibrary getLibrary()
          Returns the ImageLibrary.
static javax.swing.JButton getLinkButton(java.lang.String text, javax.swing.Icon icon, java.lang.String action)
          Return a button suitable for linking to another panel (e.g.
static java.text.DecimalFormat getModifierFormat()
          Returns the default modifier value format.
 Player getMyPlayer()
          Describe getMyPlayer method here.
 boolean isEditable()
          Checks if this panel is editable
 void requestFocus()
          The OK button requests focus.
 void setCancelComponent(javax.swing.AbstractButton cancelButton)
          Make the given button the CANCEL button.
 void setSavedSize(java.awt.Dimension newSavedSize)
          Set the SavedSize value.
 java.util.Set<Modifier> sortModifiers(java.util.Set<Modifier> result)
          Sort the given modifiers according to type.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

emptyMargin

public static final java.awt.Insets emptyMargin

TOPCELLBORDER

public static final javax.swing.border.Border TOPCELLBORDER

CELLBORDER

public static final javax.swing.border.Border CELLBORDER

LEFTCELLBORDER

public static final javax.swing.border.Border LEFTCELLBORDER

TOPLEFTCELLBORDER

public static final javax.swing.border.Border TOPLEFTCELLBORDER
Constructor Detail

FreeColPanel

public FreeColPanel(Canvas parent)
Constructor.


FreeColPanel

public FreeColPanel(Canvas parent,
                    java.awt.LayoutManager layout)
Default constructor.

Parameters:
parent - The Canvas all panels belong to.
layout - The LayoutManager to be used.
Method Detail

setSavedSize

public void setSavedSize(java.awt.Dimension newSavedSize)
Set the SavedSize value.

Parameters:
newSavedSize - The new SavedSize value.

getCanvas

public final Canvas getCanvas()
Get the Canvas value.

Returns:
a Canvas value

getLibrary

public ImageLibrary getLibrary()
Returns the ImageLibrary.

Returns:
the ImageLibrary.

getClient

public FreeColClient getClient()
Describe getClient method here.

Returns:
a FreeColClient value

getGame

public Game getGame()
Describe getGame method here.

Returns:
a Game value

getController

public InGameController getController()
Describe getController method here.

Returns:
an InGameController value

getMyPlayer

public Player getMyPlayer()
Describe getMyPlayer method here.

Returns:
a Player value

isEditable

public boolean isEditable()
Checks if this panel is editable


requestFocus

public void requestFocus()
The OK button requests focus.

Overrides:
requestFocus in class javax.swing.JComponent

getDefaultTextPane

public static javax.swing.JTextPane getDefaultTextPane()
Get a JTextPane with default styles.

Returns:
a JTextPane value

getDefaultTextPane

public static javax.swing.JTextPane getDefaultTextPane(java.lang.String text)
Get a JTextPane with default styles and given text.

Parameters:
text - a String value
Returns:
a JTextPane value

getDefaultTextArea

public static javax.swing.JTextArea getDefaultTextArea(java.lang.String text)
Returns a text area with standard settings suitable for use in FreeCol dialogs.

Parameters:
text - The text to display in the text area.
Returns:
a text area with standard settings suitable for use in FreeCol dialogs.

getDefaultTextArea

public static javax.swing.JTextArea getDefaultTextArea(java.lang.String text,
                                                       int columns)
Returns a text area with standard settings suitable for use in FreeCol dialogs.

Parameters:
text - The text to display in the text area.
columns - an int value
Returns:
a text area with standard settings suitable for use in FreeCol dialogs.

getLinkButton

public static javax.swing.JButton getLinkButton(java.lang.String text,
                                                javax.swing.Icon icon,
                                                java.lang.String action)
Return a button suitable for linking to another panel (e.g. ColopediaPanel).

Parameters:
text - a String value
icon - an Icon value
action - a String value
Returns:
a JButton value

getDefaultHeader

public static javax.swing.JLabel getDefaultHeader(java.lang.String text)
Returns the default header for panels.

Parameters:
text - a String value
Returns:
a JLabel value

setCancelComponent

public void setCancelComponent(javax.swing.AbstractButton cancelButton)
Make the given button the CANCEL button.

Parameters:
cancelButton - an AbstractButton value

enterPressesWhenFocused

public static void enterPressesWhenFocused(javax.swing.JButton button)
Registers enter key for a JButton.

Parameters:
button -

getModifierFormat

public static final java.text.DecimalFormat getModifierFormat()
Returns the default modifier value format.

Returns:
a DecimalFormat value

sortModifiers

public java.util.Set<Modifier> sortModifiers(java.util.Set<Modifier> result)
Sort the given modifiers according to type.

Returns:
a sorted Set of Modifiers

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
Parameters:
event - The incoming ActionEvent.

createEventForwardingMouseListener

public static java.awt.event.MouseListener createEventForwardingMouseListener(java.awt.Component c)
Creates a MouseListener which forwards events to the given Component.

Parameters:
c - The Component the events should be forwarded to.

createEventForwardingMouseMotionListener

public static java.awt.event.MouseMotionListener createEventForwardingMouseMotionListener(java.awt.Component c)
Creates a MouseMotionListener which forwards events to the given Component.

Parameters:
c - The Component the events should be forwarded to.