/**
* 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.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.freecolandroid.repackaged.java.awt.Dimension;
import org.freecolandroid.repackaged.javax.swing.JButton;
import org.freecolandroid.repackaged.javax.swing.JComponent;
import org.freecolandroid.repackaged.javax.swing.JLabel;
import org.freecolandroid.repackaged.javax.swing.JSeparator;
import net.miginfocom.swing.MigLayout;
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.AbstractUnit;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.StringTemplate;
import net.sf.freecol.common.model.TypeCountMap;
import net.sf.freecol.common.model.Unit;
import net.sf.freecol.common.model.Unit.Role;
import net.sf.freecol.common.model.UnitType;
/**
* This panel displays the Military Report.
*/
public final class ReportMilitaryPanel extends ReportPanel {
/*
* In the future, we should consider all possible combinations of
* military equipment, rather than fixed roles.
public static final Comparator<EquipmentType> equipmentTypeComparator =
new Comparator<EquipmentType>() {
public int compare(EquipmentType type1, EquipmentType type2) {
return type2.getId().compareTo(type1.getId());
}
};
public class EquippedUnitType {
private final UnitType unitType;
private final List<EquipmentType> equipment;
public EquippedUnitType(UnitType unitType, List<EquipmentType> equipment) {
this.unitType = unitType;
this.equipment = new ArrayList<EquipmentType>(equipment);
Collections.sort(this.equipment, equipmentTypeComparator);
}
}
private Map<EquippedUnitType, Integer> unitMap;
*/
private List<String> colonyNames;
private List<String> otherNames;
/**
* Records the number of units of each type.
*/
private TypeCountMap<UnitType> soldiers = new TypeCountMap<UnitType>();
private TypeCountMap<UnitType> dragoons = new TypeCountMap<UnitType>();
private TypeCountMap<UnitType> scouts = new TypeCountMap<UnitType>();
private TypeCountMap<UnitType> others = new TypeCountMap<UnitType>();
private Map<String, ArrayList<Unit>> locations;
/**
* The constructor that will add the items to this panel.
* @param freeColClient
* @param gui The parent of this panel.
*/
public ReportMilitaryPanel(FreeColClient freeColClient, GUI gui) {
super(freeColClient, gui, Messages.message("reportMilitaryAction.name"));
gatherData();
Player player = getMyPlayer();
reportPanel.setLayout(new MigLayout("fillx, wrap 12", "", ""));
reportPanel.add(new JLabel(Messages.message(player.getNation().getRefNation().getId() + ".name")),
"span, split 2");
reportPanel.add(new JSeparator(JSeparator.HORIZONTAL), "growx");
List<AbstractUnit> refUnits = getController().getREFUnits();
if (refUnits != null) {
for (AbstractUnit unit : refUnits) {
if (!unit.getUnitType(getSpecification()).hasAbility(Ability.NAVAL_UNIT)) {
reportPanel.add(createUnitTypeLabel(unit), "sg");
}
}
}
reportPanel.add(localizedLabel(StringTemplate.template("report.military.forces")
.addStringTemplate("%nation%", player.getNationName())),
"newline, span, split 2");
reportPanel.add(new JSeparator(JSeparator.HORIZONTAL), "growx");
List<AbstractUnit> units = new ArrayList<AbstractUnit>();
List<AbstractUnit> scoutUnits = new ArrayList<AbstractUnit>();
List<AbstractUnit> dragoonUnits = new ArrayList<AbstractUnit>();
List<AbstractUnit> soldierUnits = new ArrayList<AbstractUnit>();
for (UnitType unitType : getSpecification().getUnitTypeList()) {
if (unitType.isAvailableTo(player) &&
!unitType.hasAbility(Ability.NAVAL_UNIT) &&
(unitType.hasAbility(Ability.EXPERT_SOLDIER) ||
unitType.getOffence() > 0)) {
if (unitType.hasAbility("model.ability.canBeEquipped")) {
scoutUnits.add(new AbstractUnit(unitType, Role.SCOUT, scouts.getCount(unitType)));
dragoonUnits.add(new AbstractUnit(unitType, Role.DRAGOON, dragoons.getCount(unitType)));
soldierUnits.add(new AbstractUnit(unitType, Role.SOLDIER, soldiers.getCount(unitType)));
} else {
units.add(new AbstractUnit(unitType, Role.DEFAULT, others.getCount(unitType)));
}
}
}
UnitType defaultType = getSpecification().getDefaultUnitType();
dragoonUnits.add(new AbstractUnit(defaultType, Role.DRAGOON, dragoons.getCount(defaultType)));
soldierUnits.add(new AbstractUnit(defaultType, Role.SOLDIER, soldiers.getCount(defaultType)));
scoutUnits.add(new AbstractUnit(defaultType, Role.SCOUT, scouts.getCount(defaultType)));
units.addAll(dragoonUnits);
units.addAll(soldierUnits);
units.addAll(scoutUnits);
for (AbstractUnit unit : units) {
reportPanel.add(createUnitTypeLabel(unit), "sg");
}
reportPanel.add(new JSeparator(JSeparator.HORIZONTAL), "newline, span, growx, wrap 40");
// colonies first, sorted according to user preferences
for (String locationName : colonyNames) {
handleLocation(locationName, true);
}
// Europe next
if (player.getEurope() != null) {
String europeName = Messages.message(player.getEurope().getNameKey());
handleLocation(europeName, true);
otherNames.remove(europeName);
}
// finally all other locations, sorted alphabetically
Collections.sort(otherNames);
for (String locationName : otherNames) {
handleLocation(locationName, false);
}
revalidate();
repaint();
}
@Override
public Dimension getMinimumSize() {
return new Dimension(750, 600);
}
@Override
public Dimension getPreferredSize() {
return getMinimumSize();
}
private void gatherData() {
Player player = getMyPlayer();
locations = new HashMap<String, ArrayList<Unit>>();
List<Colony> colonies = getSortedColonies();
colonyNames = new ArrayList<String>();
for (Colony colony : colonies) {
colonyNames.add(colony.getName());
}
otherNames = new ArrayList<String>();
if (player.getEurope() != null) {
otherNames.add(Messages.message(player.getEurope().getNameKey()));
}
UnitType defaultType = getSpecification().getDefaultUnitType();
for (Unit unit : player.getUnits()) {
if (unit.isOffensiveUnit() && !unit.isNaval()) {
UnitType unitType = defaultType;
if (unit.getType().getOffence() > 0 ||
unit.hasAbility(Ability.EXPERT_SOLDIER)) {
unitType = unit.getType();
}
switch(unit.getRole()) {
case DRAGOON:
dragoons.incrementCount(unitType, 1);
break;
case SOLDIER:
soldiers.incrementCount(unitType, 1);
break;
default:
others.incrementCount(unitType, 1);
}
} else {
continue;
}
String locationName = getLocationNameFor(unit);
ArrayList<Unit> unitList = locations.get(locationName);
if (unitList == null) {
unitList = new ArrayList<Unit>();
locations.put(locationName, unitList);
}
unitList.add(unit);
if (!(colonyNames.contains(locationName) || otherNames.contains(locationName))) {
otherNames.add(locationName);
}
}
}
private void handleLocation(String location, boolean makeButton) {
List<Unit> unitList = locations.get(location);
JComponent component;
if (makeButton) {
JButton button = FreeColPanel.getLinkButton(location, null, location);
button.addActionListener(this);
component = button;
} else {
component = new JLabel(location);
}
reportPanel.add(component, "newline, span, split 2");
reportPanel.add(new JSeparator(JSeparator.HORIZONTAL), "growx");
if (unitList == null) {
reportPanel.add(new JLabel(Messages.message("none")), "sg");
} else {
Collections.sort(unitList, ReportPanel.getUnitTypeComparator());
for (Unit unit : unitList) {
UnitLabel unitLabel = new UnitLabel(getFreeColClient(), unit, getGUI(), true);
if (unit.getDestination() != null) {
String destination = Messages.message(unit.getDestination().getLocationNameFor(getMyPlayer()));
unitLabel.setToolTipText("<html>" + unitLabel.getToolTipText() + "<br>" +
Messages.message(StringTemplate.template("goingTo")
.addName("%location%", destination))
+ "</html>");
}
reportPanel.add(unitLabel, "sg");
}
}
}
}