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

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.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.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
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.
 Unit getCarrier()
          Get the Carrier value.
 javax.swing.JPanel getParentPanel()
          Get the ParentPanel value.
 java.lang.String getUIClassID()
           
 void initialize()
           
 boolean isActive()
           
 boolean isEditable()
          Get the Editable value.
 void propertyChange(java.beans.PropertyChangeEvent event)
           
 void remove(java.awt.Component comp)
           
 void setCarrier(Unit newCarrier)
          Set the Carrier value.
 void setEditable(boolean newEditable)
          Set the Editable value.
 void setParentPanel(javax.swing.JPanel newParentPanel)
          Set the ParentPanel value.
 
Methods inherited from class net.sf.freecol.client.gui.panel.FreeColPanel
actionPerformed, createEventForwardingMouseListener, createEventForwardingMouseMotionListener, enterPressesWhenFocused, getCanvas, getClient, getController, getDefaultHeader, getDefaultTextArea, getDefaultTextArea, getDefaultTextPane, getDefaultTextPane, getGame, getLibrary, getLinkButton, getModifierFormat, getMyPlayer, requestFocus, setCancelComponent, setSavedSize, sortModifiers
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, 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, 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

CargoPanel

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

Parameters:
parent - The parent Canvas that holds this CargoPanel.
Method Detail

getUIClassID

public java.lang.String getUIClassID()
Overrides:
getUIClassID in class javax.swing.JPanel

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.

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.

isEditable

public boolean isEditable()
Get the Editable value.

Overrides:
isEditable in class FreeColPanel
Returns:
a boolean value

setEditable

public void setEditable(boolean newEditable)
Set the Editable value.

Parameters:
newEditable - The new Editable value.

initialize

public void initialize()

isActive

public boolean isActive()

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

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)
Specified by:
propertyChange in interface java.beans.PropertyChangeListener