net.sf.freecol.client.gui.panel

Class ColopediaGameObjectTypePanel<T extends FreeColGameObjectType>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.freecol.client.gui.panel.MigPanel

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildingDetailPanel, FatherDetailPanel, GoodsDetailPanel, NationDetailPanel, NationTypeDetailPanel, ResourcesDetailPanel, TerrainDetailPanel, UnitDetailPanel

public abstract class ColopediaGameObjectTypePanel<T extends FreeColGameObjectType>
extends FreeColPanel
implements ColopediaDetailPanel<T>

This panel displays details of game objects in the Colopedia.

See Also:

Serialized Form

Nested Class Summary

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

Fields

Modifier and Type	Field and Description
private ColopediaPanel	colopediaPanel The enclosing colopedia panel.
private java.lang.String	id The specific panel id.

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

CANCEL, editable, HELP, MARGIN, OK, okButton

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructors

Constructor and Description
ColopediaGameObjectTypePanel(FreeColClient freeColClient, ColopediaPanel colopediaPanel, java.lang.String id) Create a new Colopedia game object type panel.

Method Summary

Modifier and Type	Method and Description
void	addSubTrees(javax.swing.tree.DefaultMutableTreeNode root, java.util.List<T> types) Builds a subtree including all the given objects.
void	addSubTrees(javax.swing.tree.DefaultMutableTreeNode root, java.lang.String id, java.util.List<T> types) Builds a subtree including all the given objects.
void	appendRequiredAbilities(javax.swing.text.StyledDocument doc, BuildableType buildableType)
protected javax.swing.tree.DefaultMutableTreeNode	buildItem(FreeColGameObjectType type, javax.swing.ImageIcon icon)
javax.swing.JLabel	getAbilityComponent(Ability ability)
protected javax.swing.JButton	getButton(ColopediaAction.PanelType panelType, java.lang.String text, javax.swing.ImageIcon icon)
protected javax.swing.JButton	getButton(FreeColGameObjectType type)
protected javax.swing.JButton	getButton(FreeColGameObjectType type, java.lang.String text, javax.swing.ImageIcon icon)
protected javax.swing.JButton	getGoodsButton(AbstractGoods goods)
protected javax.swing.JButton	getGoodsButton(GoodsType goodsType)
protected javax.swing.JButton	getGoodsButton(GoodsType goodsType, int amount)
protected javax.swing.JButton	getGoodsButton(GoodsType goodsType, java.lang.String text)
protected java.lang.String	getId() Get the panel id.
javax.swing.JComponent	getModifierComponent(Modifier modifier)
java.lang.String	getName() Get the name of this ColopediaDetailPanel, which is generally used to label the root node of its sub-tree.
protected javax.swing.JButton	getResourceButton(ResourceType resourceType)
protected javax.swing.JButton	getUnitButton(AbstractUnit au)
protected javax.swing.JButton	getUnitButton(UnitType unitType)
protected javax.swing.JButton	getUnitButton(UnitType unitType, java.lang.String roleId)
void	removeNotify()

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

actionPerformed, addClosingCallback, createColonyButton, getClientOptions, getFreeColClient, getGame, getGUI, getImageLibrary, getMyPlayer, getSpecification, igc, isEditable, requestFocus, setCancelComponent

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

getUIClassID

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, 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, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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

Methods inherited from interface net.sf.freecol.client.gui.panel.ColopediaDetailPanel

addSubTrees, buildDetail

Field Detail

colopediaPanel

private ColopediaPanel colopediaPanel

The enclosing colopedia panel.

id

private final java.lang.String id

The specific panel id.

Constructor Detail

ColopediaGameObjectTypePanel

public ColopediaGameObjectTypePanel(FreeColClient freeColClient,
                                    ColopediaPanel colopediaPanel,
                                    java.lang.String id)

Create a new Colopedia game object type panel.

Parameters:

freeColClient - The FreeColClient for the game.

colopediaPanel - The parent ColopediaPanel.

id - The panel type identifier.

Method Detail

getId

protected java.lang.String getId()

Get the panel id.

Returns:

The panel id, usually "colopediaAction.*".

getName

public java.lang.String getName()

Get the name of this ColopediaDetailPanel, which is generally used to label the root node of its sub-tree.

Overrides:

getName in class java.awt.Component

Returns:

The panel name.

addSubTrees

public void addSubTrees(javax.swing.tree.DefaultMutableTreeNode root,
                        java.util.List<T> types)

Builds a subtree including all the given objects.

Parameters:

root - a DefaultMutableTreeNode

types - a List of FreeColGameObjectTypes

addSubTrees

public void addSubTrees(javax.swing.tree.DefaultMutableTreeNode root,
                        java.lang.String id,
                        java.util.List<T> types)

Builds a subtree including all the given objects.

Parameters:

root - a DefaultMutableTreeNode

id - The object identifier of the new branch node.

types - a List of FreeColGameObjectTypes

buildItem

protected javax.swing.tree.DefaultMutableTreeNode buildItem(FreeColGameObjectType type,
                                                            javax.swing.ImageIcon icon)

getButton

protected javax.swing.JButton getButton(FreeColGameObjectType type,
                                        java.lang.String text,
                                        javax.swing.ImageIcon icon)

getButton

protected javax.swing.JButton getButton(ColopediaAction.PanelType panelType,
                                        java.lang.String text,
                                        javax.swing.ImageIcon icon)

getButton

protected javax.swing.JButton getButton(FreeColGameObjectType type)

getResourceButton

protected javax.swing.JButton getResourceButton(ResourceType resourceType)

getGoodsButton

protected javax.swing.JButton getGoodsButton(GoodsType goodsType)

getGoodsButton

protected javax.swing.JButton getGoodsButton(GoodsType goodsType,
                                             int amount)

getGoodsButton

protected javax.swing.JButton getGoodsButton(AbstractGoods goods)

getGoodsButton

protected javax.swing.JButton getGoodsButton(GoodsType goodsType,
                                             java.lang.String text)

getUnitButton

protected javax.swing.JButton getUnitButton(AbstractUnit au)

getUnitButton

protected javax.swing.JButton getUnitButton(UnitType unitType,
                                            java.lang.String roleId)

getUnitButton

protected javax.swing.JButton getUnitButton(UnitType unitType)

getModifierComponent

public javax.swing.JComponent getModifierComponent(Modifier modifier)

getAbilityComponent

public javax.swing.JLabel getAbilityComponent(Ability ability)

appendRequiredAbilities

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

Throws:

javax.swing.text.BadLocationException

removeNotify

public void removeNotify()

Overrides:

removeNotify in class FreeColPanel