dip.gui
Class ClientMenu

java.lang.Object
  dip.gui.ClientMenu

public class ClientMenu

extends java.lang.Object

Implements many menu methods, and constructs the menus.

This is fully internationlizable (il8n) via the il8n.properties file

Nested Class Summary

static class

ClientMenu.Item Inner class that describes and obtains menu item info from the resource file.

Field Summary

static ClientMenu.Item	EDIT
static ClientMenu.Item	EDIT_CLEAR_ALL
static ClientMenu.Item	EDIT_DELETE
static ClientMenu.Item	EDIT_EDIT_MODE
static ClientMenu.Item	EDIT_METADATA
static ClientMenu.Item	EDIT_PREFERENCES
static ClientMenu.Item	EDIT_REDO
static ClientMenu.Item	EDIT_SELECT_ALL
static ClientMenu.Item	EDIT_SELECT_NONE
static ClientMenu.Item	EDIT_UNDO
static ClientMenu.Item	FILE
static ClientMenu.Item	FILE_EXIT
static ClientMenu.Item	FILE_EXPORT
static ClientMenu.Item	FILE_EXPORT_JPG
static ClientMenu.Item	FILE_EXPORT_PDF
static ClientMenu.Item	FILE_EXPORT_PNG
static ClientMenu.Item	FILE_EXPORT_SVG
static ClientMenu.Item	FILE_IMPORT_FILE
static ClientMenu.Item	FILE_IMPORT_FLOC
static ClientMenu.Item	FILE_NEW
static ClientMenu.Item	FILE_NEW_F2F
static ClientMenu.Item	FILE_NEW_NET
static ClientMenu.Item	FILE_NEW_STD
static ClientMenu.Item	FILE_OPEN
static ClientMenu.Item	FILE_PRINT
static ClientMenu.Item	FILE_RECENT
static ClientMenu.Item	FILE_SAVE
static ClientMenu.Item	FILE_SAVEAS
static ClientMenu.Item	FILE_SAVETO
static ClientMenu.Item	HELP
static ClientMenu.Item	HELP_ABOUT
static ClientMenu.Item	HELP_CONTENTS
static ClientMenu.Item	HISTORY
static ClientMenu.Item	HISTORY_INITIAL
static ClientMenu.Item	HISTORY_LAST
static ClientMenu.Item	HISTORY_NEXT
static ClientMenu.Item	HISTORY_PREVIOUS
static ClientMenu.Item	HISTORY_SELECT
static ClientMenu.Item	ORDERS
static ClientMenu.Item	ORDERS_MULTI_INPUT
static ClientMenu.Item	ORDERS_RESOLVE
static ClientMenu.Item	ORDERS_REVALIDATE
static ClientMenu.Item	ORDERS_VAL_OPTIONS
static ClientMenu.Item	REPORTS
static ClientMenu.Item	REPORTS_MAP_INFO
static ClientMenu.Item	REPORTS_ORDER_STATS
static ClientMenu.Item	REPORTS_PREVIOUS_RESULTS
static ClientMenu.Item	REPORTS_RESULTS
static ClientMenu.Item	REPORTS_SC_HISTORY
static ClientMenu.Item	REPORTS_STATUS
static ClientMenu.Item	TOOLS
static ClientMenu.Item	VIEW
static ClientMenu.Item	VIEW_DISLODGED_UNITS
static ClientMenu.Item	VIEW_INFLUENCE
static ClientMenu.Item	VIEW_NAMES
static ClientMenu.Item	VIEW_NAMES_FULL
static ClientMenu.Item	VIEW_NAMES_NONE
static ClientMenu.Item	VIEW_NAMES_SHORT
static ClientMenu.Item	VIEW_ONLY_SELECTED
static ClientMenu.Item	VIEW_ORDERS
static ClientMenu.Item	VIEW_SELECT_MAP
static ClientMenu.Item	VIEW_SHOW_MAP
static ClientMenu.Item	VIEW_SUPPLY_CENTERS
static ClientMenu.Item	VIEW_UNITS
static ClientMenu.Item	VIEW_UNORDERED

Constructor Summary

ClientMenu(ClientFrame parent)

Method Summary

javax.swing.JMenuBar	getJMenuBar() Get the JMenuBar
javax.swing.JMenuItem	getMenuItem(ClientMenu.Item item) Get a JMenuItem given an Item (usually a specified constant)
Power[]	getOrderDrawingPowers() Gets which powers are selected for drawing.
boolean	getSelected(ClientMenu.Item item)
boolean	isEnabled(ClientMenu.Item item)
boolean	isVisible(ClientMenu.Item item)
javax.swing.JCheckBoxMenuItem	makeCBMenuItem(ClientMenu.Item item, boolean defaultState, boolean indent) Make a JCheckBox menu item
javax.swing.JMenu	makeMenu(ClientMenu.Item item) Make a Menu (or submenu) from an Item object.
javax.swing.JMenu	makeMenu(ClientMenu.Item item, boolean indent) Make a Menu (or submenu) from an Item object, indenting if required
javax.swing.JMenuItem	makeMenuItem(ClientMenu.Item item) Make a menu item from an Item object
javax.swing.JMenuItem	makeMenuItem(ClientMenu.Item item, boolean indent) Make a menu item from an Item object, indenting if required
void	setActionMethod(ClientMenu.Item item, java.lang.Object target, java.lang.String methodName) Set the given method (of the given target class) to be the only recipient of ActionEvents for the desired menu item.
void	setEditItemsEnabled(boolean value) This is a specialized item group that is used internally and by OrderPanel.java.
void	setEnabled(ClientMenu.Item item, boolean value)
void	setSelected(ClientMenu.Item item, boolean value)
void	setSelected(Power power, boolean value)
void	setText(ClientMenu.Item item, java.lang.String text)
void	setViewNamesNone() Set the View->Names-> menu option to "None".
void	setViewRenderItemsEnabled(boolean value) View menu rendering options This is a specialized item group that is enabled/disabled automatically by a mode change.
void	setVisible(ClientMenu.Item item, boolean value)
void	updateRecentFiles() Updates the recent file menu, if enabled.

Methods inherited from class java.lang.Object

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

Field Detail

FILE

public static final ClientMenu.Item FILE

EDIT

public static final ClientMenu.Item EDIT

ORDERS

public static final ClientMenu.Item ORDERS

HISTORY

public static final ClientMenu.Item HISTORY

VIEW

public static final ClientMenu.Item VIEW

REPORTS

public static final ClientMenu.Item REPORTS

TOOLS

public static final ClientMenu.Item TOOLS

HELP

public static final ClientMenu.Item HELP

FILE_NEW

public static final ClientMenu.Item FILE_NEW

FILE_NEW_STD

public static final ClientMenu.Item FILE_NEW_STD

FILE_NEW_F2F

public static final ClientMenu.Item FILE_NEW_F2F

FILE_NEW_NET

public static final ClientMenu.Item FILE_NEW_NET

FILE_OPEN

public static final ClientMenu.Item FILE_OPEN

FILE_RECENT

public static final ClientMenu.Item FILE_RECENT

FILE_SAVE

public static final ClientMenu.Item FILE_SAVE

FILE_SAVEAS

public static final ClientMenu.Item FILE_SAVEAS

FILE_SAVETO

public static final ClientMenu.Item FILE_SAVETO

FILE_IMPORT_FILE

public static final ClientMenu.Item FILE_IMPORT_FILE

FILE_IMPORT_FLOC

public static final ClientMenu.Item FILE_IMPORT_FLOC

FILE_EXPORT

public static final ClientMenu.Item FILE_EXPORT

FILE_PRINT

public static final ClientMenu.Item FILE_PRINT

FILE_EXIT

public static final ClientMenu.Item FILE_EXIT

FILE_EXPORT_JPG

public static final ClientMenu.Item FILE_EXPORT_JPG

FILE_EXPORT_PNG

public static final ClientMenu.Item FILE_EXPORT_PNG

FILE_EXPORT_SVG

public static final ClientMenu.Item FILE_EXPORT_SVG

FILE_EXPORT_PDF

public static final ClientMenu.Item FILE_EXPORT_PDF

EDIT_UNDO

public static final ClientMenu.Item EDIT_UNDO

EDIT_REDO

public static final ClientMenu.Item EDIT_REDO

EDIT_SELECT_ALL

public static final ClientMenu.Item EDIT_SELECT_ALL

EDIT_SELECT_NONE

public static final ClientMenu.Item EDIT_SELECT_NONE

EDIT_DELETE

public static final ClientMenu.Item EDIT_DELETE

EDIT_CLEAR_ALL

public static final ClientMenu.Item EDIT_CLEAR_ALL

EDIT_EDIT_MODE

public static final ClientMenu.Item EDIT_EDIT_MODE

EDIT_PREFERENCES

public static final ClientMenu.Item EDIT_PREFERENCES

EDIT_METADATA

public static final ClientMenu.Item EDIT_METADATA

ORDERS_VAL_OPTIONS

public static final ClientMenu.Item ORDERS_VAL_OPTIONS

ORDERS_REVALIDATE

public static final ClientMenu.Item ORDERS_REVALIDATE

ORDERS_MULTI_INPUT

public static final ClientMenu.Item ORDERS_MULTI_INPUT

ORDERS_RESOLVE

public static final ClientMenu.Item ORDERS_RESOLVE

HISTORY_PREVIOUS

public static final ClientMenu.Item HISTORY_PREVIOUS

HISTORY_NEXT

public static final ClientMenu.Item HISTORY_NEXT

HISTORY_INITIAL

public static final ClientMenu.Item HISTORY_INITIAL

HISTORY_LAST

public static final ClientMenu.Item HISTORY_LAST

HISTORY_SELECT

public static final ClientMenu.Item HISTORY_SELECT

VIEW_NAMES

public static final ClientMenu.Item VIEW_NAMES

VIEW_NAMES_NONE

public static final ClientMenu.Item VIEW_NAMES_NONE

VIEW_NAMES_SHORT

public static final ClientMenu.Item VIEW_NAMES_SHORT

VIEW_NAMES_FULL

public static final ClientMenu.Item VIEW_NAMES_FULL

VIEW_ORDERS

public static final ClientMenu.Item VIEW_ORDERS

VIEW_UNITS

public static final ClientMenu.Item VIEW_UNITS

VIEW_DISLODGED_UNITS

public static final ClientMenu.Item VIEW_DISLODGED_UNITS

VIEW_SUPPLY_CENTERS

public static final ClientMenu.Item VIEW_SUPPLY_CENTERS

VIEW_ONLY_SELECTED

public static final ClientMenu.Item VIEW_ONLY_SELECTED

VIEW_UNORDERED

public static final ClientMenu.Item VIEW_UNORDERED

VIEW_INFLUENCE

public static final ClientMenu.Item VIEW_INFLUENCE

VIEW_SELECT_MAP

public static final ClientMenu.Item VIEW_SELECT_MAP

VIEW_SHOW_MAP

public static final ClientMenu.Item VIEW_SHOW_MAP

REPORTS_RESULTS

public static final ClientMenu.Item REPORTS_RESULTS

REPORTS_PREVIOUS_RESULTS

public static final ClientMenu.Item REPORTS_PREVIOUS_RESULTS

REPORTS_STATUS

public static final ClientMenu.Item REPORTS_STATUS

REPORTS_SC_HISTORY

public static final ClientMenu.Item REPORTS_SC_HISTORY

REPORTS_ORDER_STATS

public static final ClientMenu.Item REPORTS_ORDER_STATS

REPORTS_MAP_INFO

public static final ClientMenu.Item REPORTS_MAP_INFO

HELP_ABOUT

public static final ClientMenu.Item HELP_ABOUT

HELP_CONTENTS

public static final ClientMenu.Item HELP_CONTENTS

Constructor Detail

ClientMenu

public ClientMenu(ClientFrame parent)

Method Detail

makeMenu

public javax.swing.JMenu makeMenu(ClientMenu.Item item)

Make a Menu (or submenu) from an Item object.

makeMenu

public javax.swing.JMenu makeMenu(ClientMenu.Item item,
                                  boolean indent)

Make a Menu (or submenu) from an Item object, indenting if required

makeMenuItem

public javax.swing.JMenuItem makeMenuItem(ClientMenu.Item item)

Make a menu item from an Item object

makeMenuItem

public javax.swing.JMenuItem makeMenuItem(ClientMenu.Item item,
                                          boolean indent)

Make a menu item from an Item object, indenting if required

makeCBMenuItem

public javax.swing.JCheckBoxMenuItem makeCBMenuItem(ClientMenu.Item item,
                                                    boolean defaultState,
                                                    boolean indent)

Make a JCheckBox menu item

getMenuItem

public javax.swing.JMenuItem getMenuItem(ClientMenu.Item item)

Get a JMenuItem given an Item (usually a specified constant)

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()

Get the JMenuBar

isEnabled

public boolean isEnabled(ClientMenu.Item item)

setEnabled

public void setEnabled(ClientMenu.Item item,
                       boolean value)

isVisible

public boolean isVisible(ClientMenu.Item item)

setVisible

public void setVisible(ClientMenu.Item item,
                       boolean value)

setText

public void setText(ClientMenu.Item item,
                    java.lang.String text)

getSelected

public boolean getSelected(ClientMenu.Item item)

setSelected

public void setSelected(ClientMenu.Item item,
                        boolean value)

setSelected

public void setSelected(Power power,
                        boolean value)

updateRecentFiles

public void updateRecentFiles()

Updates the recent file menu, if enabled.

setEditItemsEnabled

public void setEditItemsEnabled(boolean value)

This is a specialized item group that is used internally and by OrderPanel.java.

setViewRenderItemsEnabled

public void setViewRenderItemsEnabled(boolean value)

View menu rendering options

This is a specialized item group that is enabled/disabled automatically by a mode change. However, there are/may be instances when items may need to be disabled despite the particular mode setting.

setViewNamesNone

public void setViewNamesNone()

Set the View->Names-> menu option to "None". This is needed after loading a new game because the map does not show names.

getOrderDrawingPowers

public Power[] getOrderDrawingPowers()

Gets which powers are selected for drawing. Never returns null.

setActionMethod

public void setActionMethod(ClientMenu.Item item,
                            java.lang.Object target,
                            java.lang.String methodName)

Set the given method (of the given target class) to be the only recipient of ActionEvents for the desired menu item. All methods must have zero arguments.

Null arguments are not permitted.