/**
* 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.menu;
import java.util.logging.Logger;
import org.freecolandroid.repackaged.java.awt.Graphics;
import org.freecolandroid.repackaged.java.awt.Graphics2D;
import org.freecolandroid.repackaged.java.awt.RenderingHints;
import org.freecolandroid.repackaged.java.awt.event.KeyEvent;
import org.freecolandroid.repackaged.java.awt.geom.Rectangle2D;
import org.freecolandroid.repackaged.javax.swing.ButtonGroup;
import org.freecolandroid.repackaged.javax.swing.JMenu;
import net.sf.freecol.FreeCol;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.gui.GUI;
import net.sf.freecol.client.gui.action.*;
import net.sf.freecol.client.gui.action.DisplayTileTextAction.DisplayText;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.client.gui.menu.DebugMenu;
import net.sf.freecol.common.model.StringTemplate;
import net.sf.freecol.common.model.TileImprovementType;
/**
* This is the menu bar used in-game.
*
* <br><br>
*
* The menu bar that is displayed on the top left corner of the
* <code>Canvas</code>.
*
* @see MapEditorMenuBar
*/
public class InGameMenuBar extends FreeColMenuBar {
@SuppressWarnings("unused")
private static final Logger logger = Logger.getLogger(InGameMenuBar.class.getName());
/**
* Creates a new <code>FreeColMenuBar</code>. This menu bar will include
* all of the submenus and items.
*
* @param f The main controller.
* @param gui
*/
public InGameMenuBar(FreeColClient f, GUI gui) {
// TODO: FreeColClient should not have to be passed in to this class.
// This is only a menu bar, it doesn't need
// a reference to the main controller. The only reason it has one now is
// because DebugMenu needs it. And DebugMenu
// needs it because it is using inner classes for ActionListeners and
// those inner classes use the reference.
// If those inner classes were in seperate classes, when they were
// created, they could use the FreeColClient
// reference of the ActionManger. So DebugMenu needs to be refactored to
// remove inner classes so that this
// MenuBar can lose its unnecessary reference to the main controller.
// See FreeColMenuTest.
//
// Okay, I lied.. the update() and paintComponent() methods in this
// MenuBar use freeColClient, too. But so what.
// Move those to another class too. :)
super(f, gui);
reset();
}
/**
* Resets this menu bar.
*/
public void reset() {
removeAll();
buildGameMenu();
buildViewMenu();
buildOrdersMenu();
buildReportMenu();
buildColopediaMenu();
// --> Debug
if (FreeCol.isInDebugMode()) {
add(new DebugMenu(freeColClient, gui));
}
update();
}
private void buildGameMenu() {
// --> Game
JMenu menu = new JMenu(Messages.message("menuBar.game"));
menu.setOpaque(false);
menu.setMnemonic(KeyEvent.VK_G);
menu.add(getMenuItem(NewAction.id));
menu.add(getMenuItem(OpenAction.id));
menu.add(getMenuItem(SaveAction.id));
menu.addSeparator();
menu.add(getMenuItem(PreferencesAction.id));
menu.add(getMenuItem(ReconnectAction.id));
menu.addSeparator();
menu.add(getMenuItem(ChatAction.id));
menu.add(getMenuItem(DeclareIndependenceAction.id));
menu.add(getMenuItem(EndTurnAction.id));
menu.addSeparator();
menu.add(getMenuItem(ShowMainAction.id));
menu.add(getMenuItem(ReportHighScoresAction.id));
menu.add(getMenuItem(RetireAction.id));
menu.add(getMenuItem(SaveAndQuitAction.id));
menu.add(getMenuItem(QuitAction.id));
add(menu);
}
private void buildViewMenu() {
// --> View
JMenu menu = new JMenu(Messages.message("menuBar.view"));
menu.setOpaque(false);
menu.setMnemonic(KeyEvent.VK_V);
menu.add(getCheckBoxMenuItem(MapControlsAction.id));
menu.add(getCheckBoxMenuItem(DisplayGridAction.id));
menu.add(getCheckBoxMenuItem(DisplayBordersAction.id));
menu.add(getMenuItem(ToggleViewModeAction.id));
menu.addSeparator();
ButtonGroup group = new ButtonGroup();
for (DisplayText type : DisplayText.values()) {
menu.add(getRadioButtonMenuItem(DisplayTileTextAction.id + type, group));
}
menu.addSeparator();
menu.add(getMenuItem(ZoomInAction.id));
menu.add(getMenuItem(ZoomOutAction.id));
menu.add(getMenuItem(CenterAction.id));
menu.add(getMenuItem(TilePopupAction.id));
menu.addSeparator();
menu.add(getMenuItem(EuropeAction.id));
menu.add(getMenuItem(TradeRouteAction.id));
menu.add(getMenuItem(FindSettlementAction.id));
add(menu);
}
private void buildOrdersMenu() {
// --> Orders
JMenu menu = new JMenu(Messages.message("menuBar.orders"));
menu.setOpaque(false);
menu.setMnemonic(KeyEvent.VK_O);
menu.add(getMenuItem(SentryAction.id));
menu.add(getMenuItem(FortifyAction.id));
menu.addSeparator();
menu.add(getMenuItem(GotoAction.id));
menu.add(getMenuItem(GotoTileAction.id));
menu.add(getMenuItem(ExecuteGotoOrdersAction.id));
menu.add(getMenuItem(AssignTradeRouteAction.id));
menu.addSeparator();
menu.add(getMenuItem(BuildColonyAction.id));
// Insert all Improvements here:
for (TileImprovementType type : freeColClient.getGame().getSpecification()
.getTileImprovementTypeList()) {
if (!type.isNatural()) {
menu.add(getMenuItem(type.getShortId() + "Action"));
}
}
menu.addSeparator();
menu.add(getMenuItem(LoadAction.id));
menu.add(getMenuItem(UnloadAction.id));
menu.addSeparator();
menu.add(getMenuItem(WaitAction.id));
menu.add(getMenuItem(SkipUnitAction.id));
menu.add(getMenuItem(ChangeAction.id));
menu.addSeparator();
menu.add(getMenuItem(ClearOrdersAction.id));
menu.add(getMenuItem(RenameAction.id));
menu.add(getMenuItem(DisbandUnitAction.id));
add(menu);
}
private void buildReportMenu() {
// --> Report
JMenu menu = new JMenu(Messages.message("menuBar.report"));
menu.setOpaque(false);
menu.setMnemonic(KeyEvent.VK_R);
menu.add(getMenuItem(ReportReligionAction.id));
menu.add(getMenuItem(ReportLabourAction.id));
menu.add(getMenuItem(ReportColonyAction.id));
menu.add(getMenuItem(ReportForeignAction.id));
menu.add(getMenuItem(ReportIndianAction.id));
menu.add(getMenuItem(ReportContinentalCongressAction.id));
menu.add(getMenuItem(ReportMilitaryAction.id));
menu.add(getMenuItem(ReportNavalAction.id));
menu.add(getMenuItem(ReportTradeAction.id));
menu.add(getMenuItem(ReportTurnAction.id));
menu.add(getMenuItem(ReportRequirementsAction.id));
menu.add(getMenuItem(ReportCargoAction.id));
menu.add(getMenuItem(ReportExplorationAction.id));
menu.add(getMenuItem(ReportHistoryAction.id));
menu.add(getMenuItem(ReportProductionAction.id));
menu.add(getMenuItem(ReportEducationAction.id));
menu.add(getMenuItem(ShowDifficultyAction.id));
menu.add(getMenuItem(ShowGameOptionsAction.id));
menu.add(getMenuItem(ShowMapGeneratorOptionsAction.id));
add(menu);
}
/**
* Paints information about gold, tax and year.
*/
@Override
public void paintComponent(Graphics g) {
super.paintComponent(g);
if (freeColClient != null && freeColClient.getMyPlayer() != null) {
Graphics2D g2d = (Graphics2D) g;
g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
RenderingHints.VALUE_ANTIALIAS_ON);
g2d.setRenderingHint(RenderingHints.KEY_RENDERING,
RenderingHints.VALUE_RENDER_QUALITY);
final int gold = freeColClient.getMyPlayer().getGold();
String displayString =
Messages.message(StringTemplate.template("menuBar.statusLine")
.addAmount("%gold%", gold)
.addAmount("%tax%", freeColClient.getMyPlayer().getTax())
.addAmount("%score%", freeColClient.getMyPlayer().getScore())
.addStringTemplate("%year%", freeColClient.getGame().getTurn().getLabel()));
Rectangle2D displayStringBounds = g2d.getFontMetrics().getStringBounds(displayString, g);
int y = 15 + getInsets().top;
g2d.drawString(displayString, getWidth() - 10 - (int) displayStringBounds.getWidth(), y);
}
}
}