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

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
                      extended by net.sf.freecol.client.gui.panel.ColopediaPanel
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener

public final class ColopediaPanel
extends FreeColPanel
implements javax.swing.event.TreeSelectionListener

This panel displays the Colopedia.

See Also:
Serialized Form

Nested Class Summary
static class ColopediaPanel.PanelType
           
 
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
 
Fields inherited from class net.sf.freecol.client.gui.panel.FreeColPanel
CELLBORDER, emptyMargin, LEFTCELLBORDER, TOPCELLBORDER, 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
ColopediaPanel(Canvas parent, ColopediaPanel.PanelType panelType, FreeColGameObjectType objectType)
          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.
 void appendRequiredAbilities(javax.swing.text.StyledDocument doc, BuildableType buildableType)
           
static javax.swing.JTextArea getDefaultTextArea(java.lang.String text)
          Returns a text area with standard settings suitable for use in FreeCol dialogs.
 java.lang.String getModifierAsString(Modifier modifier)
           
 java.awt.Dimension getSavedSize()
          Get the SavedSize value.
 void initialize(ColopediaPanel.PanelType panelType, FreeColGameObjectType type)
          Prepares this panel to be displayed.
 void initialize(FreeColGameObjectType type)
          Prepares this panel to be displayed.
 void selectDetail(ColopediaPanel.PanelType panelType, FreeColGameObjectType type)
           
 void setSavedSize(java.awt.Dimension newSavedSize)
          Set the SavedSize value.
 void valueChanged(javax.swing.event.TreeSelectionEvent event)
          This function analyses a tree selection event and calls the right methods to take care of building the requested unit's details.
 
Methods inherited from class net.sf.freecol.client.gui.panel.FreeColPanel
createEventForwardingMouseListener, createEventForwardingMouseMotionListener, enterPressesWhenFocused, getCanvas, getClient, getController, getDefaultHeader, getDefaultTextArea, getDefaultTextPane, getDefaultTextPane, getGame, getLibrary, getLinkButton, getModifierFormat, getMyPlayer, isEditable, requestFocus, setCancelComponent, sortModifiers
 
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
 

Constructor Detail

ColopediaPanel

public ColopediaPanel(Canvas parent,
                      ColopediaPanel.PanelType panelType,
                      FreeColGameObjectType objectType)
The constructor that will add the items to this panel.

Parameters:
parent - The parent of this panel.
Method Detail

getSavedSize

public final java.awt.Dimension getSavedSize()
Get the SavedSize value.

Returns:
a Dimension value

setSavedSize

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

Overrides:
setSavedSize in class FreeColPanel
Parameters:
newSavedSize - The new SavedSize value.

initialize

public void initialize(ColopediaPanel.PanelType panelType,
                       FreeColGameObjectType type)
Prepares this panel to be displayed.

Parameters:
panelType - - the panel type
type - - the FreeColGameObjectType of the item to be displayed

initialize

public void initialize(FreeColGameObjectType type)
Prepares this panel to be displayed.

Parameters:
type - - the FreeColGameObjectType of the item to be displayed

selectDetail

public void selectDetail(ColopediaPanel.PanelType panelType,
                         FreeColGameObjectType type)

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent event)
This function analyses a tree selection event and calls the right methods to take care of building the requested unit's details.

Specified by:
valueChanged in interface javax.swing.event.TreeSelectionListener
Parameters:
event - The incoming TreeSelectionEvent.

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.

getModifierAsString

public java.lang.String getModifierAsString(Modifier modifier)

appendRequiredAbilities

public void appendRequiredAbilities(javax.swing.text.StyledDocument doc,
                                    BuildableType buildableType)
                             throws javax.swing.text.BadLocationException
Throws:
javax.swing.text.BadLocationException

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