net.sf.freecol.client.gui.action
Class UnloadAction

java.lang.Object
  javax.swing.AbstractAction
      net.sf.freecol.client.gui.action.FreeColAction
          net.sf.freecol.client.gui.action.MapboardAction
              net.sf.freecol.client.gui.action.UnloadAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, Option<FreeColAction>

public class UnloadAction
extends MapboardAction

An action for unloading a unit.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.freecol.client.gui.action.FreeColAction

FreeColAction.InnerMenuKeyListener

Field Summary

static java.lang.String	id
private Unit	unit

Fields inherited from class net.sf.freecol.client.gui.action.FreeColAction

ACTION_ID, BUTTON_DISABLED_IMAGE, BUTTON_IMAGE, BUTTON_PRESSED_IMAGE, BUTTON_ROLLOVER_IMAGE, freeColClient, gui, NO_MNEMONIC

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

UnloadAction(FreeColClient freeColClient, GUI gui)
Creates an action for unloading the currently selected unit.

UnloadAction(FreeColClient freeColClient, GUI gui, Unit unit)
Creates an action for unloading the Unit provided.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Applies this action.
private Unit	getUnit()
protected boolean	shouldBeEnabled() Checks if this action should be enabled.

Methods inherited from class net.sf.freecol.client.gui.action.FreeColAction

addImageIcons, clone, getAccelerator, getFreeColClient, getId, getKeyStrokeText, getMenuKeyListener, getMnemonic, getName, getShortDescription, getValue, getXMLElementTagName, hasOrderButtons, readFromXML, readFromXMLImpl, setAccelerator, setMnemonic, setValue, toString, toXML, toXMLImpl, update

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

id

public static final java.lang.String id

See Also:

Constant Field Values

unit

private Unit unit

Constructor Detail

UnloadAction

public UnloadAction(FreeColClient freeColClient,
                    GUI gui)

Creates an action for unloading the currently selected unit.

Parameters:

freeColClient - The main controller object for the client.

gui -

UnloadAction

public UnloadAction(FreeColClient freeColClient,
                    GUI gui,
                    Unit unit)

Creates an action for unloading the Unit provided. If the Unit is null, then the currently selected unit is used instead.

Parameters:

freeColClient - The main controller object for the client.

unit - an Unit value

See Also:

MapViewer.getActiveUnit()

Method Detail

getUnit

private Unit getUnit()

shouldBeEnabled

protected boolean shouldBeEnabled()

Checks if this action should be enabled.

Overrides:

shouldBeEnabled in class MapboardAction

Returns:

true if there is a carrier active

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Applies this action.

Parameters:

e - The ActionEvent.