net.sf.freecol.client.gui.panel

Class ReportUnitPanel

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

net.sf.freecol.client.gui.panel.ReportUnitPanel

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:

ReportCargoPanel, ReportMilitaryPanel, ReportNavalPanel

public abstract class ReportUnitPanel
extends ReportPanel

This panel displays a unit Report.

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 java.util.Map<Colony,java.util.List<Unit>>	inColonies Units in colonies.
private java.util.List<Unit>	inEurope Units in Europe.
private java.util.Map<java.lang.String,java.util.List<Unit>>	inLocations Units in other locations.
private boolean	showColonies Whether to show colonies even if no selected units are present.
private java.util.Map<java.lang.String,TypeCountMap<UnitType>>	units Records the number of units of each type.

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

header, logger, reportPanel, scrollPane

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
ReportUnitPanel(FreeColClient freeColClient, java.lang.String key, boolean showColonies) The constructor that will add the items to this panel.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addOwnUnits() Add a section for specific unit types owned by the player.
protected abstract void	addREFUnits() Add a section for the REF.
protected void	addUnit(Unit unit, java.lang.String key)
protected abstract void	gatherData() Gather the overall unit data, mostly by calling addUnit() above.
protected int	getCount(java.lang.String key, UnitType type)
protected javax.swing.JButton	getUnitButton(Unit unit)
protected void	handleLocation(Location location, java.lang.String locationName, java.util.List<Unit> unitList)
protected void	incrementCount(java.lang.String key, UnitType type, int number)

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

actionPerformed, createUnitTypeLabel, getLocationLabelFor, initialize, removeNotify, setMainComponent

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

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

Field Detail

inEurope

private final java.util.List<Unit> inEurope

Units in Europe.

inColonies

private final java.util.Map<Colony,java.util.List<Unit>> inColonies

Units in colonies.

inLocations

private final java.util.Map<java.lang.String,java.util.List<Unit>> inLocations

Units in other locations.

units

private final java.util.Map<java.lang.String,TypeCountMap<UnitType>> units

Records the number of units of each type.

showColonies

private boolean showColonies

Whether to show colonies even if no selected units are present.

Constructor Detail

ReportUnitPanel

public ReportUnitPanel(FreeColClient freeColClient,
                       java.lang.String key,
                       boolean showColonies)

The constructor that will add the items to this panel.

Parameters:

freeColClient - The FreeColClient for the game.

key - the report name key

showColonies - Whether to show colonies with no selected units.

Method Detail

getCount

protected int getCount(java.lang.String key,
                       UnitType type)

incrementCount

protected void incrementCount(java.lang.String key,
                              UnitType type,
                              int number)

addUnit

protected void addUnit(Unit unit,
                       java.lang.String key)

handleLocation

protected void handleLocation(Location location,
                              java.lang.String locationName,
                              java.util.List<Unit> unitList)

getUnitButton

protected javax.swing.JButton getUnitButton(Unit unit)

gatherData

protected abstract void gatherData()

Gather the overall unit data, mostly by calling addUnit() above.

addREFUnits

protected abstract void addREFUnits()

Add a section for the REF.

addOwnUnits

protected abstract void addOwnUnits()

Add a section for specific unit types owned by the player.