InGameMenuBar.java
| Index Score | ||
|---|---|---|
![]() |
![]() |
net.sf.freecol.client.gui |
![]() |
![]() |
FreeCol |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
/**
* Copyright (C) 2002-2007 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;
import java.awt.Graphics;
import java.awt.event.KeyEvent;
import java.awt.geom.Rectangle2D;
import java.util.logging.Logger;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import net.sf.freecol.FreeCol;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.gui.action.AboutAction;
import net.sf.freecol.client.gui.action.AssignTradeRouteAction;
import net.sf.freecol.client.gui.action.BuildColonyAction;
import net.sf.freecol.client.gui.action.ChangeAction;
import net.sf.freecol.client.gui.action.ChangeWindowedModeAction;
import net.sf.freecol.client.gui.action.ChatAction;
import net.sf.freecol.client.gui.action.ClearOrdersAction;
import net.sf.freecol.client.gui.action.ColopediaBuildingAction;
import net.sf.freecol.client.gui.action.ColopediaFatherAction;
import net.sf.freecol.client.gui.action.ColopediaGoodsAction;
import net.sf.freecol.client.gui.action.ColopediaNationAction;
import net.sf.freecol.client.gui.action.ColopediaNationTypeAction;
import net.sf.freecol.client.gui.action.ColopediaSkillAction;
import net.sf.freecol.client.gui.action.ColopediaTerrainAction;
import net.sf.freecol.client.gui.action.ColopediaUnitAction;
import net.sf.freecol.client.gui.action.DeclareIndependenceAction;
import net.sf.freecol.client.gui.action.DisbandUnitAction;
import net.sf.freecol.client.gui.action.DisplayGridAction;
import net.sf.freecol.client.gui.action.DisplayTileNamesAction;
import net.sf.freecol.client.gui.action.DisplayTileOwnersAction;
import net.sf.freecol.client.gui.action.DisplayRegionAction;
import net.sf.freecol.client.gui.action.EndTurnAction;
import net.sf.freecol.client.gui.action.EuropeAction;
import net.sf.freecol.client.gui.action.ExecuteGotoOrdersAction;
import net.sf.freecol.client.gui.action.FortifyAction;
import net.sf.freecol.client.gui.action.GotoAction;
import net.sf.freecol.client.gui.action.ImprovementActionType;
import net.sf.freecol.client.gui.action.MapControlsAction;
import net.sf.freecol.client.gui.action.NewAction;
import net.sf.freecol.client.gui.action.OpenAction;
import net.sf.freecol.client.gui.action.PreferencesAction;
import net.sf.freecol.client.gui.action.QuitAction;
import net.sf.freecol.client.gui.action.ReconnectAction;
import net.sf.freecol.client.gui.action.RenameAction;
import net.sf.freecol.client.gui.action.ReportCargoAction;
import net.sf.freecol.client.gui.action.ReportColonyAction;
import net.sf.freecol.client.gui.action.ReportContinentalCongressAction;
import net.sf.freecol.client.gui.action.ReportExplorationAction;
import net.sf.freecol.client.gui.action.ReportForeignAction;
import net.sf.freecol.client.gui.action.ReportIndianAction;
import net.sf.freecol.client.gui.action.ReportLabourAction;
import net.sf.freecol.client.gui.action.ReportMilitaryAction;
import net.sf.freecol.client.gui.action.ReportNavalAction;
import net.sf.freecol.client.gui.action.ReportReligionAction;
import net.sf.freecol.client.gui.action.ReportRequirementsAction;
import net.sf.freecol.client.gui.action.ReportTradeAction;
import net.sf.freecol.client.gui.action.ReportTurnAction;
import net.sf.freecol.client.gui.action.SaveAction;
import net.sf.freecol.client.gui.action.SentryAction;
import net.sf.freecol.client.gui.action.ShowMainAction;
import net.sf.freecol.client.gui.action.SkipUnitAction;
import net.sf.freecol.client.gui.action.ToggleViewModeAction;
import net.sf.freecol.client.gui.action.TradeRouteAction;
import net.sf.freecol.client.gui.action.UnloadAction;
import net.sf.freecol.client.gui.action.WaitAction;
import net.sf.freecol.client.gui.action.ZoomInAction;
import net.sf.freecol.client.gui.action.ZoomOutAction;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.client.gui.menu.DebugMenu;
/**
* 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 Canvas#setJMenuBar
* @see MapEditorMenuBar
*/
public class InGameMenuBar extends FreeColMenuBar {
@SuppressWarnings("unused")
private static final Logger logger = Logger.getLogger(InGameMenuBar.class.getName());
public static final int UNIT_ORDER_WAIT = 0;
public static final int UNIT_ORDER_FORTIFY = 1;
public static final int UNIT_ORDER_SENTRY = 2;
public static final int UNIT_ORDER_CLEAR_ORDERS = 3;
public static final int UNIT_ORDER_BUILD_COL = 5;
/*
public static final int UNIT_ORDER_PLOW = 6;
public static final int UNIT_ORDER_BUILD_ROAD = 7;
*/
public static final int UNIT_ORDER_SKIP = 9;
public static final int UNIT_ORDER_DISBAND = 11;
private JMenuItem reportsTradeMenuItem = null;
/**
* Creates a new <code>FreeColMenuBar</code>. This menu bar will include
* all of the submenus and items.
*
* @param f The main controller.
*/
public InGameMenuBar(FreeColClient f) {
// 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);
reset();
}
/**
* Resets this menu bar.
*/
public void reset() {
removeAll();
buildGameMenu();
buildViewMenu();
buildOrdersMenu();
buildReportMenu();
buildColopediaMenu();
// --> Debug
if (FreeCol.isInDebugMode()) {
add(new DebugMenu(freeColClient));
}
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(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(DisplayTileNamesAction.id));
menu.add(getCheckBoxMenuItem(DisplayTileOwnersAction.id));
menu.add(getCheckBoxMenuItem(DisplayRegionAction.id));
menu.add(getCheckBoxMenuItem(DisplayGridAction.id));
menu.add(getMenuItem(ToggleViewModeAction.id));
menu.add(getCheckBoxMenuItem(ChangeWindowedModeAction.id));
menu.addSeparator();
menu.add(getMenuItem(ZoomInAction.id));
menu.add(getMenuItem(ZoomOutAction.id));
menu.addSeparator();
menu.add(getMenuItem(EuropeAction.id));
menu.add(getMenuItem(TradeRouteAction.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(WaitAction.id));
menu.add(getMenuItem(SentryAction.id));
menu.add(getMenuItem(FortifyAction.id));
menu.add(getMenuItem(GotoAction.id));
menu.add(getMenuItem(AssignTradeRouteAction.id));
menu.addSeparator();
menu.add(getMenuItem(BuildColonyAction.id));
// Insert all Improvements here:
for (ImprovementActionType iaType : FreeCol.getSpecification().getImprovementActionTypeList()) {
menu.add(getMenuItem(iaType.getId()));
}
/* Depreciated
menu.add(getMenuItem(PlowAction.id));
menu.add(getMenuItem(BuildRoadAction.id));
*/
menu.add(getMenuItem(UnloadAction.id));
menu.addSeparator();
menu.add(getMenuItem(ExecuteGotoOrdersAction.id));
menu.add(getMenuItem(SkipUnitAction.id));
menu.add(getMenuItem(ChangeAction.id));
menu.add(getMenuItem(ClearOrdersAction.id));
menu.addSeparator();
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(ReportCargoAction.id));
menu.add(getMenuItem(ReportTradeAction.id));
menu.add(getMenuItem(ReportTurnAction.id));
menu.add(getMenuItem(ReportRequirementsAction.id));
menu.add(getMenuItem(ReportExplorationAction.id));
add(menu);
}
public JMenuItem getReportsTradeMenuItem() {
return reportsTradeMenuItem;
}
private void buildColopediaMenu() {
// --> Colopedia
JMenu menu = new JMenu(Messages.message("menuBar.colopedia"));
menu.setOpaque(false);
menu.setMnemonic(KeyEvent.VK_C);
menu.add(getMenuItem(ColopediaTerrainAction.id));
menu.add(getMenuItem(ColopediaUnitAction.id));
menu.add(getMenuItem(ColopediaGoodsAction.id));
menu.add(getMenuItem(ColopediaSkillAction.id));
menu.add(getMenuItem(ColopediaBuildingAction.id));
menu.add(getMenuItem(ColopediaFatherAction.id));
menu.add(getMenuItem(ColopediaNationAction.id));
menu.add(getMenuItem(ColopediaNationTypeAction.id));
menu.addSeparator();
menu.add(getMenuItem(AboutAction.id));
add(menu);
}
/**
* Paints information about gold, tax and year.
*/
public void paintComponent(Graphics g) {
super.paintComponent(g);
String displayString = Messages.message("menuBar.statusLine",
"%gold%", Integer.toString(freeColClient.getMyPlayer().getGold()),
"%tax%", Integer.toString(freeColClient.getMyPlayer().getTax()),
"%score%", Integer.toString(freeColClient.getMyPlayer().getScore()),
"%year%", freeColClient.getGame().getTurn().toString());
Rectangle2D displayStringBounds = g.getFontMetrics().getStringBounds(displayString, g);
int y = 15 + getInsets().top;
g.drawString(displayString, getWidth() - 10 - (int) displayStringBounds.getWidth(), y);
}
}
The table below shows all metrics for InGameMenuBar.java.




