/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.client.gui.panel;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Set;
import java.util.logging.Logger;
import org.freecolandroid.repackaged.java.awt.Cursor;
import org.freecolandroid.repackaged.java.awt.Dimension;
import org.freecolandroid.repackaged.java.awt.GraphicsEnvironment;
import org.freecolandroid.repackaged.java.awt.Image;
import org.freecolandroid.repackaged.java.awt.MediaTracker;
import org.freecolandroid.repackaged.java.awt.Point;
import org.freecolandroid.repackaged.java.awt.Toolkit;
import org.freecolandroid.repackaged.java.awt.datatransfer.DataFlavor;
import org.freecolandroid.repackaged.java.awt.datatransfer.Transferable;
import org.freecolandroid.repackaged.java.awt.dnd.DragGestureEvent;
import org.freecolandroid.repackaged.java.awt.dnd.DragGestureListener;
import org.freecolandroid.repackaged.java.awt.dnd.DragGestureRecognizer;
import org.freecolandroid.repackaged.java.awt.dnd.DragSource;
import org.freecolandroid.repackaged.java.awt.dnd.DragSourceContext;
import org.freecolandroid.repackaged.java.awt.dnd.DragSourceDragEvent;
import org.freecolandroid.repackaged.java.awt.dnd.DragSourceDropEvent;
import org.freecolandroid.repackaged.java.awt.dnd.DragSourceEvent;
import org.freecolandroid.repackaged.java.awt.dnd.DragSourceListener;
import org.freecolandroid.repackaged.java.awt.event.InputEvent;
import org.freecolandroid.repackaged.java.awt.event.MouseEvent;
import org.freecolandroid.repackaged.javax.swing.ImageIcon;
import org.freecolandroid.repackaged.javax.swing.JComponent;
import org.freecolandroid.repackaged.javax.swing.JLabel;
import org.freecolandroid.repackaged.javax.swing.JPanel;
import org.freecolandroid.repackaged.javax.swing.TransferHandler;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.gui.GUI;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.common.model.Ability;
import net.sf.freecol.common.model.AbstractGoods;
import net.sf.freecol.common.model.EquipmentType;
import net.sf.freecol.common.model.Goods;
import net.sf.freecol.common.model.GoodsContainer;
import net.sf.freecol.common.model.GoodsLocation;
import net.sf.freecol.common.model.GoodsType;
import net.sf.freecol.common.model.HighSeas;
import net.sf.freecol.common.model.Modifier;
import net.sf.freecol.common.model.StringTemplate;
import net.sf.freecol.common.model.Unit;
/**
* The transferhandler that is capable of creating ImageSelection objects.
* Those ImageSelection objects are Transferable. The DefaultTransferHandler
* should be attached to JPanels or custom JLabels.
*/
public final class DefaultTransferHandler extends TransferHandler {
private static Logger logger = Logger.getLogger(DefaultTransferHandler.class.getName());
public static final DataFlavor flavor = new DataFlavor(ImageSelection.class, "ImageSelection");
private final FreeColPanel parentPanel;
private FreeColClient freeColClient;
private GUI gui;
/**
* The constructor to use.
* @param freeColClient
* @param canvas The <code>Canvas</code>.
* @param parentPanel The layered pane that holds all kinds of information.
*/
public DefaultTransferHandler(FreeColClient freeColClient, GUI gui, FreeColPanel parentPanel) {
this.freeColClient = freeColClient;
this.gui = gui;
this.parentPanel = parentPanel;
}
/**
* Returns the action that can be done to an ImageSelection on the given component.
* @return The action that can be done to an ImageSelection on the given component.
*/
public int getSourceActions(JComponent comp) {
return COPY_OR_MOVE;
}
/**
* Returns 'true' if the given component can import a selection of the
* flavor that is indicated by the second parameter, 'false' otherwise.
* @param comp The component that needs to be checked.
* @param flavor The flavor that needs to be checked for.
* @return 'true' if the given component can import a selection of the
* flavor that is indicated by the second parameter, 'false' otherwise.
*/
public boolean canImport(JComponent comp, DataFlavor[] flavor) {
if (!(comp instanceof UnitLabel) &&
!(comp instanceof GoodsLabel) &&
!(comp instanceof MarketLabel) &&
!(comp instanceof JPanel) &&
!(comp instanceof JLabel)) {
return false;
}
for (int i = 0; i < flavor.length; i++) {
if (flavor[i].equals(DefaultTransferHandler.flavor)) {
return true;
}
}
return false;
}
/**
* Creates a Transferable (an ImageSelection to be precise) of the
* data that is represented by the given component and returns that
* object.
* @param comp The component to create a Transferable of.
* @return The resulting Transferable (an ImageSelection object).
*/
public Transferable createTransferable(JComponent comp) {
if (comp instanceof UnitLabel) {
return new ImageSelection((UnitLabel)comp);
} else if (comp instanceof GoodsLabel) {
return new ImageSelection((GoodsLabel)comp);
} else if (comp instanceof MarketLabel) {
return new ImageSelection((MarketLabel)comp);
}
return null;
}
/**
* Imports the data represented by the given Transferable into
* the given component. Returns 'true' on success, 'false' otherwise.
* @param comp The component to import the data to.
* @param t The Transferable that holds the data.
* @return 'true' on success, 'false' otherwise.
*/
public boolean importData(JComponent comp, Transferable t) {
try {
JLabel data;
/*
This variable is used to temporarily keep the old selected unit,
while moving cargo from one carrier to another:
*/
UnitLabel oldSelectedUnit = null;
// Check flavor.
if (t.isDataFlavorSupported(DefaultTransferHandler.flavor)) {
data = (JLabel)t.getTransferData(DefaultTransferHandler.flavor);
} else {
logger.warning("Data flavor is not supported!");
return false;
}
// Do not allow a transferable to be dropped upon itself:
if (comp == data) {
return false;
}
// Make sure we don't drop onto other Labels.
if (comp instanceof UnitLabel) {
UnitLabel unitLabel = (UnitLabel) comp;
/**
* If the unit/cargo is dropped on a carrier in port
* (EuropePanel.InPortPanel), then the ship is
* selected and the unit is added to its cargo. If the
* unit is not a carrier, but can be equipped, and the
* goods can be converted to equipment, equip the unit.
*
* If not, assume that the user wished to drop the
* unit/cargo on the panel below.
*/
if (unitLabel.getUnit().isCarrier()
&& unitLabel.getParent() instanceof EuropePanel.InPortPanel) {
if (data instanceof UnitLabel
&& ((UnitLabel) data).getUnit().isOnCarrier()
|| data instanceof GoodsLabel
&& ((GoodsLabel) data).getGoods().getLocation() instanceof Unit) {
oldSelectedUnit = ((EuropePanel) parentPanel).getSelectedUnitLabel();
}
((EuropePanel) parentPanel).setSelectedUnitLabel(unitLabel);
comp = ((EuropePanel) parentPanel).getCargoPanel();
} else if (unitLabel.getUnit().isCarrier()
&& unitLabel.getParent() instanceof ColonyPanel.InPortPanel) {
if (data instanceof UnitLabel
&& ((UnitLabel) data).getUnit().isOnCarrier()
|| data instanceof GoodsLabel
&& ((GoodsLabel) data).getGoods().getLocation() instanceof Unit) {
oldSelectedUnit = ((ColonyPanel) parentPanel).getSelectedUnitLabel();
}
((ColonyPanel) parentPanel).setSelectedUnitLabel(unitLabel);
comp = ((ColonyPanel) parentPanel).getCargoPanel();
} else if (unitLabel.canUnitBeEquipedWith(data)) {
// don't do anything before partial amount has been checked
} else {
try {
comp = (JComponent)comp.getParent();
} catch (ClassCastException e) {
return false;
}
// This is because we use an extra panel for
// layout in this particular case; may find a
// better solution later.
try {
if ((JComponent)comp.getParent() instanceof ColonyPanel.BuildingsPanel.ASingleBuildingPanel) {
comp = (JComponent)comp.getParent();
}
} catch (ClassCastException e) {}
}
} else if ((comp instanceof GoodsLabel) || (comp instanceof MarketLabel)) {
try {
comp = (JComponent)comp.getParent();
} catch (ClassCastException e) {
return false;
}
}
// t is already in comp:
if (data.getParent() == comp) {
return false;
}
if (data instanceof UnitLabel) {
// Check if the unit can be dragged to comp.
Unit unit = ((UnitLabel)data).getUnit();
if (unit.isUnderRepair()) {
return false;
}
if (unit.getLocation() instanceof HighSeas
&& !(comp instanceof EuropePanel.DestinationPanel)) {
return false;
}
if (!unit.isNaval()
&& (comp instanceof EuropePanel.InPortPanel
|| comp instanceof ColonyPanel.InPortPanel
|| comp instanceof EuropePanel.DestinationPanel)) {
return false;
}
if (comp instanceof EuropePanel.MarketPanel || comp instanceof ColonyPanel.WarehousePanel) {
return false;
}
if (unit.isNaval() && (comp instanceof EuropePanel.DocksPanel
|| comp instanceof ColonyPanel.OutsideColonyPanel
|| comp instanceof ColonyPanel.BuildingsPanel.ASingleBuildingPanel
|| comp instanceof ColonyPanel.TilePanel.ASingleTilePanel
|| comp instanceof CargoPanel)) {
return false;
}
if (comp instanceof JLabel) {
logger.warning("Oops, I thought we didn't have to write this part.");
return true;
} else if (comp instanceof JPanel) {
// Do this in the 'add'-methods instead:
//data.getParent().remove(data);
if (comp instanceof EuropePanel.DestinationPanel) {
((EuropePanel.DestinationPanel)comp).add(data, true);
} else if (comp instanceof EuropePanel.DocksPanel) {
((EuropePanel.DocksPanel)comp).add(data, true);
} else if (comp instanceof ColonyPanel.BuildingsPanel.ASingleBuildingPanel) {
((ColonyPanel.BuildingsPanel.ASingleBuildingPanel) comp).add(data, true);
} else if (comp instanceof ColonyPanel.OutsideColonyPanel) {
ColonyPanel.OutsideColonyPanel outside = ((ColonyPanel.OutsideColonyPanel) comp);
if (outside.getColony().canReducePopulation()) {
outside.add(data, true);
} else {
String message = "";
Set<Modifier> modifierSet = outside.getColony().getFeatureContainer()
.getModifierSet("model.modifier.minimumColonySize");
for (Modifier modifier : modifierSet) {
message += Messages.message(StringTemplate.template("colonyPanel.minimumColonySize")
.addName("%object%", modifier.getSource()))
+ "\n";
}
gui.showInformationMessage(message);
}
} else if (comp instanceof CargoPanel) {
((CargoPanel)comp).add(data, true);
} else if (comp instanceof ColonyPanel.TilePanel.ASingleTilePanel) {
((ColonyPanel.TilePanel.ASingleTilePanel)comp).add(data, true);
} else {
logger.warning("The receiving component is of an invalid type.");
return false;
}
// Update unit selection
// new unit selection has already been taken cared of
//if this unit was moved to ToAmericaPanel
if (oldSelectedUnit != null) {
if ((oldSelectedUnit).getParent() instanceof EuropePanel.InPortPanel) {
((EuropePanel) parentPanel).setSelectedUnit(oldSelectedUnit.getUnit());
} else {
((ColonyPanel) parentPanel).setSelectedUnit(oldSelectedUnit.getUnit());
}
}
comp.revalidate();
return true;
}
} else if (data instanceof GoodsLabel) {
// Check if the goods can be dragged to comp.
GoodsLabel label = (GoodsLabel)data;
// Import the data.
if (label.isPartialChosen()) {
Goods goods = label.getGoods();
int defaultAmount = -1;
if (goods.getLocation() instanceof GoodsLocation) {
GoodsLocation loc = (GoodsLocation)goods.getLocation();
if (goods.getAmount() > loc.getGoodsCapacity()) {
// If over capacity, favour the amount that would
// correct the problem.
defaultAmount = Math.min(goods.getAmount()
- loc.getGoodsCapacity(),
GoodsContainer.CARGO_SIZE);
}
}
int amount = getAmount(label.getGoods().getType(),
label.getGoods().getAmount(), defaultAmount, false);
if (amount <= 0) return false;
label.getGoods().setAmount(amount);
} else if (label.getGoods().getAmount() > GoodsContainer.CARGO_SIZE) {
label.getGoods().setAmount(GoodsContainer.CARGO_SIZE);
}
/*
if (!(comp instanceof ColonyPanel.WarehousePanel ||
comp instanceof CargoPanel ||
comp instanceof EuropePanel.MarketPanel) ||
(comp instanceof CargoPanel && !((CargoPanel) comp).isActive())) {
return false;
}
*/
if (comp instanceof UnitLabel) {
UnitLabel unitLabel = ((UnitLabel) comp);
Unit unit = unitLabel.getUnit();
if (unit.hasAbility(Ability.CAN_BE_EQUIPPED)) {
Goods goods = label.getGoods();
for (EquipmentType equipment : freeColClient.getGame().getSpecification()
.getEquipmentTypeList()) {
if (unit.canBeEquippedWith(equipment) && equipment.getGoodsRequired().size() == 1) {
AbstractGoods requiredGoods = equipment.getGoodsRequired().get(0);
if (requiredGoods.getType().equals(goods.getType())
&& requiredGoods.getAmount() <= goods.getAmount()) {
int amount = Math.min(goods.getAmount() / requiredGoods.getAmount(),
equipment.getMaximumCount());
freeColClient.getInGameController()
.equipUnit(unit, equipment, amount);
unitLabel.updateIcon();
return true;
}
}
}
}
return false;
} else if (comp instanceof JLabel) {
logger.warning("Oops, I thought we didn't have to write this part.");
return true;
} else if (comp instanceof JPanel) {
//data.getParent().remove(data);
if (comp instanceof ColonyPanel.WarehousePanel) {
((ColonyPanel.WarehousePanel)comp).add(data, true);
} else if (comp instanceof CargoPanel) {
((CargoPanel)comp).add(data, true);
} else if (comp instanceof EuropePanel.MarketPanel) {
((EuropePanel.MarketPanel)comp).add(data, true);
} else {
logger.warning("The receiving component is of an invalid type.");
return false;
}
comp.revalidate();
if (oldSelectedUnit != null) {
if (oldSelectedUnit.getParent() instanceof EuropePanel.InPortPanel) {
((EuropePanel) parentPanel).setSelectedUnit(oldSelectedUnit.getUnit());
} else {
((ColonyPanel) parentPanel).setSelectedUnit(oldSelectedUnit.getUnit());
}
}
return true;
}
} else if (data instanceof MarketLabel) {
// Check if the unit can be dragged to comp.
MarketLabel label = ((MarketLabel)data);
// Import the data.
if (label.isPartialChosen()) {
int amount = getAmount(label.getType(), label.getAmount(), -1, true);
if (amount <= 0) {
return false;
}
label.setAmount(amount);
}
if (comp instanceof UnitLabel) {
UnitLabel unitLabel = (UnitLabel) comp;
Unit unit = unitLabel.getUnit();
if (unit.hasAbility(Ability.CAN_BE_EQUIPPED)) {
for (EquipmentType equipment : freeColClient.getGame().getSpecification()
.getEquipmentTypeList()) {
if (unit.canBeEquippedWith(equipment) && equipment.getGoodsRequired().size() == 1) {
AbstractGoods requiredGoods = equipment.getGoodsRequired().get(0);
if (requiredGoods.getType().equals(label.getType())
&& requiredGoods.getAmount() <= label.getAmount()) {
int amount = Math.min(label.getAmount() / requiredGoods.getAmount(),
equipment.getMaximumCount());
freeColClient.getInGameController()
.equipUnit(unit, equipment, amount);
unitLabel.updateIcon();
return true;
}
}
}
}
return false;
} else if (comp instanceof JLabel) {
logger.warning("Oops, I thought we didn't have to write this part.");
return true;
} else if (comp instanceof JPanel) {
// Be not removing MarketLabels from their home. -sjm
//data.getParent().remove(data);
if (comp instanceof CargoPanel) {
((CargoPanel)comp).add(data, true);
} else {
logger.warning("The receiving component is of an invalid type.");
return false;
}
comp.revalidate();
return true;
}
}
logger.warning("The dragged component is of an invalid type.");
} catch (Exception e) {
// TODO: Suggest a reconnect.
StringWriter sw = new StringWriter();
e.printStackTrace(new PrintWriter(sw));
logger.warning(sw.toString());
}
return false;
}
/**
* Displays an input dialog box where the user should specify a goods transfer amount.
*/
private int getAmount(GoodsType goodsType, int available, int defaultAmount, boolean needToPay) {
return gui.showSelectAmountDialog(goodsType, available, defaultAmount, needToPay);
}
/*__________________________________________________
Methods/inner-classes below have been copied from
TransferHandler in order to allow partial loading.
--------------------------------------------------
*/
private static FreeColDragGestureRecognizer recognizer = null;
public void exportAsDrag(JComponent comp, InputEvent e, int action) {
int srcActions = getSourceActions(comp);
int dragAction = srcActions & action;
if (!(e instanceof MouseEvent)) {
dragAction = NONE;
}
if (dragAction != NONE && !GraphicsEnvironment.isHeadless()) {
if (recognizer == null) {
recognizer = new FreeColDragGestureRecognizer(new FreeColDragHandler());
}
recognizer.gestured(comp, (MouseEvent) e , srcActions, dragAction);
} else {
exportDone(comp, null, NONE);
}
}
/**
* This is the default drag handler for drag and drop operations that
* use the <code>TransferHandler</code>.
*/
private static class FreeColDragHandler implements DragGestureListener, DragSourceListener {
private boolean scrolls;
// --- DragGestureListener methods -----------------------------------
/**
* A Drag gesture has been recognized.
*/
public void dragGestureRecognized(DragGestureEvent dge) {
JComponent c = (JComponent) dge.getComponent();
DefaultTransferHandler th = (DefaultTransferHandler) c.getTransferHandler();
Transferable t = th.createTransferable(c);
if (t != null) {
scrolls = c.getAutoscrolls();
c.setAutoscrolls(false);
try {
if (c instanceof JLabel && ((JLabel) c).getIcon() instanceof ImageIcon) {
Toolkit tk = Toolkit.getDefaultToolkit();
ImageIcon imageIcon = ((ImageIcon) ((JLabel) c).getIcon());
Dimension bestSize = tk.getBestCursorSize(imageIcon.getIconWidth(), imageIcon.getIconHeight());
if (bestSize.width == 0 || bestSize.height == 0) {
dge.startDrag(null, t, this);
return;
}
Image image;
if (bestSize.width > bestSize.height) {
bestSize.height = (int) ((((double) bestSize.width) / ((double) imageIcon.getIconWidth())) * imageIcon.getIconHeight());
} else {
bestSize.width = (int) ((((double) bestSize.height) / ((double) imageIcon.getIconHeight())) * imageIcon.getIconWidth());
}
image = imageIcon.getImage().getScaledInstance(bestSize.width, bestSize.height, Image.SCALE_DEFAULT);
/*
We have to use a MediaTracker to ensure that the
image has been scaled before we use it.
*/
MediaTracker mt = new MediaTracker(c);
mt.addImage(image, 0, bestSize.width, bestSize.height);
try {
mt.waitForID(0);
} catch (InterruptedException e) {
dge.startDrag(null, t, this);
return;
}
Point point = new Point(bestSize.width / 2, bestSize.height / 2);
Cursor cursor;
try {
cursor = tk.createCustomCursor(image, point, "freeColDragIcon");
} catch (RuntimeException re) {
cursor = null;
}
//Point point = new Point(0, 0);
dge.startDrag(cursor, t, this);
} else {
dge.startDrag(null, t, this);
}
return;
} catch (RuntimeException re) {
c.setAutoscrolls(scrolls);
}
}
th.exportDone(c, null, NONE);
}
// --- DragSourceListener methods -----------------------------------
/**
* as the hotspot enters a platform dependent drop site.
*/
public void dragEnter(DragSourceDragEvent dsde) {
}
/**
* as the hotspot moves over a platform dependent drop site.
*/
public void dragOver(DragSourceDragEvent dsde) {
}
/**
* as the hotspot exits a platform dependent drop site.
*/
public void dragExit(DragSourceEvent dsde) {
}
/**
* as the operation completes.
*/
public void dragDropEnd(DragSourceDropEvent dsde) {
DragSourceContext dsc = dsde.getDragSourceContext();
JComponent c = (JComponent)dsc.getComponent();
if (dsde.getDropSuccess()) {
((DefaultTransferHandler) c.getTransferHandler()).exportDone(c, dsc.getTransferable(), dsde.getDropAction());
} else {
((DefaultTransferHandler) c.getTransferHandler()).exportDone(c, null, NONE);
}
c.setAutoscrolls(scrolls);
}
public void dropActionChanged(DragSourceDragEvent dsde) {
DragSourceContext dsc = dsde.getDragSourceContext();
JComponent comp = (JComponent)dsc.getComponent();
updatePartialChosen(comp, dsde.getUserAction() == MOVE);
}
private void updatePartialChosen(JComponent comp, boolean partialChosen) {
if (comp instanceof GoodsLabel) {
((GoodsLabel) comp).setPartialChosen(partialChosen);
} else if (comp instanceof MarketLabel) {
((MarketLabel) comp).setPartialChosen(partialChosen);
}
}
}
private static class FreeColDragGestureRecognizer extends DragGestureRecognizer {
FreeColDragGestureRecognizer(DragGestureListener dgl) {
super(DragSource.getDefaultDragSource(), null, NONE, dgl);
}
void gestured(JComponent c, MouseEvent e, int srcActions, int action) {
setComponent(c);
setSourceActions(srcActions);
appendEvent(e);
fireDragGestureRecognized(action, e.getPoint());
}
/**
* register this DragGestureRecognizer's Listeners with the Component.
*/
protected void registerListeners() {
}
/**
* unregister this DragGestureRecognizer's Listeners with the Component.
*
* subclasses must override this method
*/
protected void unregisterListeners() {
}
}
}