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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ColonyPanel.ColonyCargoPanel, EuropePanel.EuropeCargoPanel

public class CargoPanel
extends FreeColPanel
implements java.beans.PropertyChangeListener

A panel that holds units and goods that represent Units and cargo that are on board the currently selected ship.

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

private javax.swing.border.TitledBorder	border
private Unit	carrier The carrier that contains cargo.
private DefaultTransferHandler	defaultTransferHandler
private static java.util.logging.Logger	logger
private javax.swing.JPanel	parentPanel
private java.awt.event.MouseListener	pressListener

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

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

Fields inherited from class javax.swing.JComponent

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

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

CargoPanel(Canvas parent, boolean withTitle)
Creates this CargoPanel.

Method Summary

java.awt.Component	add(java.awt.Component comp, boolean editState) Adds a component to this CargoPanel and makes sure that the unit or good that the component represents gets modified so that it is on board the currently selected ship.
void	addPropertyChangeListeners()
void	cleanup() Clean up this CargoPanel.
Unit	getCarrier() Get the Carrier value.
javax.swing.JPanel	getParentPanel() Get the ParentPanel value.
java.lang.String	getUIClassID()
void	initialize() Initialize this CargoPanel.
boolean	isActive() Whether this panel is active.
void	propertyChange(java.beans.PropertyChangeEvent event)
void	remove(java.awt.Component comp)
void	removePropertyChangeListeners()
void	setCarrier(Unit newCarrier) Set the Carrier value.
void	setParentPanel(javax.swing.JPanel newParentPanel) Set the ParentPanel value.
void	update() Update this CargoPanel.
private void	updateTitle() Update the title of this CargoPanel.

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

actionPerformed, addClosingCallback, createColonyButton, createEventForwardingMouseListener, createEventForwardingMouseMotionListener, enterPressesWhenFocused, getCanvas, getClientOptions, getController, getDefaultHeader, getDefaultTextArea, getDefaultTextArea, getDefaultTextPane, getDefaultTextPane, getFreeColClient, getGame, 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, 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, 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static java.util.logging.Logger logger

carrier

private Unit carrier

The carrier that contains cargo.

defaultTransferHandler

private final DefaultTransferHandler defaultTransferHandler

pressListener

private final java.awt.event.MouseListener pressListener

border

private final javax.swing.border.TitledBorder border

parentPanel

private javax.swing.JPanel parentPanel

Constructor Detail

CargoPanel

public CargoPanel(Canvas parent,
                  boolean withTitle)

Creates this CargoPanel.

Parameters:

parent - The parent Canvas that holds this CargoPanel

withTitle - boolean

Method Detail

getParentPanel

public final javax.swing.JPanel getParentPanel()

Get the ParentPanel value.

Returns:

a JPanel value

setParentPanel

public final void setParentPanel(javax.swing.JPanel newParentPanel)

Set the ParentPanel value.

Parameters:

newParentPanel - The new ParentPanel value.

isActive

public boolean isActive()

Whether this panel is active.

Returns:

boolean true == active

getCarrier

public Unit getCarrier()

Get the Carrier value.

Returns:

an Unit value

setCarrier

public void setCarrier(Unit newCarrier)

Set the Carrier value.

Parameters:

newCarrier - The new Carrier value.

initialize

public void initialize()

Initialize this CargoPanel.

cleanup

public void cleanup()

Clean up this CargoPanel.

update

public void update()

Update this CargoPanel.

updateTitle

private void updateTitle()

Update the title of this CargoPanel.

add

public java.awt.Component add(java.awt.Component comp,
                              boolean editState)

Adds a component to this CargoPanel and makes sure that the unit or good that the component represents gets modified so that it is on board the currently selected ship.

Parameters:

comp - The component to add to this CargoPanel.

editState - Must be set to 'true' if the state of the component that is added (which should be a dropped component representing a Unit or good) should be changed so that the underlying unit or goods are on board the currently selected ship.

Returns:

The component argument.

remove

public void remove(java.awt.Component comp)

Overrides:

remove in class java.awt.Container

addPropertyChangeListeners

public void addPropertyChangeListeners()

removePropertyChangeListeners

public void removePropertyChangeListeners()

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

getUIClassID

public java.lang.String getUIClassID()

Overrides:

getUIClassID in class javax.swing.JPanel