Package megameklab.util

Class CConfig

java.lang.Object

megameklab.util.CConfig

public final class CConfig
extends Object

Class for Client's configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_BACKUP_FILE
static final String	CONFIG_DIR
static final String	CONFIG_FILE
static final String	FILE_CHOOSER_WINDOW
static final String	FILE_LAST_DIRECTORY
static final String	FILE_RECENT_PREFIX
static final String	FORCE_BUILD_WINDOW
static final String	GUI_AS_MAIN_UI_WINDOW
static final String	GUI_BA_MAIN_UI_WINDOW
static final String	GUI_BACKGROUND
static final String	GUI_BM_MAIN_UI_WINDOW
static final String	GUI_CI_MAIN_UI_WINDOW
static final String	GUI_COLOR_AMMO
static final String	GUI_COLOR_EMPTY
static final String	GUI_COLOR_EQUIPMENT
static final String	GUI_COLOR_NON_HITTABLE
static final String	GUI_COLOR_SYSTEMS
static final String	GUI_COLOR_WEAPONS
static final String	GUI_CV_MAIN_UI_WINDOW
static final String	GUI_DS_MAIN_UI_WINDOW
static final String	GUI_FOREGROUND
static final String	GUI_FULLSCREEN
static final String	GUI_HHW_MAIN_UI_WINDOW
static final String	GUI_PLAF
static final String	GUI_PM_MAIN_UI_WINDOW
static final String	GUI_SV_MAIN_UI_WINDOW
static final String	GUI_TABBED_WINDOW
static final String	GUI_WS_MAIN_UI_WINDOW
static final String	MEK_AUTO_COMPACT
static final String	MEK_AUTO_SORT
static final String	MEK_AUTOFILL
static final String	MISC_APPLICATION_EXIT_PROMPT
static final String	MISC_INCLUDE_LICENSE
static final String	MISC_MUL_OPEN_BEHAVIOUR
static final String	MISC_SKIP_SAFETY_PROMPTS
static final String	MISC_STARTUP
static final String	MISC_SUMMARY_FORMAT_TRO
static final String	NAG_EQUIPMENT_CTRL_CLICK
static final String	NAG_IMPORT_SETTINGS
static final String	PQ_ADJUSTED_BV
static final String	PQ_DAMAGE
static final String	PQ_SHOW_PILOT_DATA
static final String	PQ_SINGLE_PRINT
static final int	RECENT_FILE_COUNT
static final String	RS_ARMOR_GROUPING
static final String	RS_BOLD_TYPE
static final String	RS_COLOR
static final String	RS_CONDENSED_REFERENCE
static final String	RS_DAMAGE
static final String	RS_DAMAGE_COLOR
static final String	RS_EXPLICIT_ZERO_MOD
static final String	RS_EXTRA_PHYSICALS
static final String	RS_FANCY_PIPS
static final String	RS_FONT
static final String	RS_FRAMELESS
static final String	RS_HEAT_PROFILE
static final String	RS_HEAT_SCALE_MARKER
static final String	RS_HIT_MOD
static final String	RS_INTRINSIC_PHYSICALS
static final String	RS_MEK_NAMES
static final String	RS_MERGE_IDENTICAL_EQUIPMENT
static final String	RS_PAPER_SIZE
static final String	RS_PROGRESS_BAR
static final String	RS_REFERENCE
static final String	RS_ROW_SHADING
static final String	RS_SCALE_FACTOR
static final String	RS_SCALE_UNITS
static final String	RS_SHOW_C3BV
static final String	RS_SHOW_ERA
static final String	RS_SHOW_PILOT_DATA
static final String	RS_SHOW_QUIRKS
static final String	RS_SHOW_ROLE
static final String	RS_TAC_OPS_HEAT
static final String	RS_TAC_OPS_VEHICLE_EFFECTIVENESS
static final String	RS_WEAPONS_ORDER
static final String	TECH_EXTINCT
static final String	TECH_PROGRESSION
static final String	TECH_SHOW_FACTION
static final String	TECH_UNOFFICIAL_NO_YEAR
static final String	TECH_USE_YEAR
static final String	TECH_YEAR

Method Summary

Modifier and Type	Method	Description
static void	ensureConfigFileExists()	Creates a new Config file, and directories, if it is missing.
static String	formatScale(double val, boolean showUnits)	Applies the scale factor to a value and optionally adds the unit abbreviation
static Color	getBackgroundColor(String fieldName)
static boolean	getBooleanParam(String param)
static <E extends Enum<E>> E	getEnumParam(String key, Class<E> enumClass, E defaultVal)	Return the enum value of a given config property.
static Optional<Point>	getFileChooserPosition()
static Optional<Dimension>	getFileChooserSize()
static Optional<Point>	getForceBuildPosition()
static Color	getForegroundColor(String fieldName)
static int	getIntParam(String param)	Return the int value of a given config property.
static int	getIntParam(String param, int defaultVal)	Return the int value of a given config property.
static Optional<Point>	getMainUiWindowPosition(MenuBarOwner mainUi)
static Optional<Dimension>	getMainUiWindowSize(MenuBarOwner mainUi)
static MekChassisArrangement	getMekNameArrangement()
static Optional<Dimension>	getNamedWindowSize(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
static String	getParam(String param)	Get a config value.
static String	getParam(String param, String defaultVal)	Get a config value, with a default value to be used if the value is not found.
static String	getRecentFile(int recentFileNumber)
static List<String>	getRecentFiles()
static MMLStartUp	getStartUpType()
static void	importSettings(MenuBarOwner menuBarOwner, File settingsFile)	Tries to import settings from the given properties file.
static boolean	includeLicense()
static void	load()	Loads the MegaMekLab configuration.
static void	loadConfigFile()	Loads the Config file.
static void	resetWindowPositions()
static void	saveConfig()	Write the config file out to ./data/mwconfig.txt.
static RSScale	scaleUnits()
static <E extends Enum<E>> void	setEnumParam(String key, E value)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	setMostRecentFile(String newFile)
static void	setParam(String param, String value)	Set a config value.
static void	writeFileChooserSettings(JDialog dialog)
static void	writeForceBuildPosition(JFrame frame)
static void	writeMainUiWindowSettings(MenuBarOwner mainUi)
static void	writeNamedWindowSize(String name, Window component)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_DIR

public static final String CONFIG_DIR

See Also:

• Constant Field Values

CONFIG_FILE

public static final String CONFIG_FILE

See Also:

• Constant Field Values

CONFIG_BACKUP_FILE

public static final String CONFIG_BACKUP_FILE

See Also:

• Constant Field Values

MISC_STARTUP

public static final String MISC_STARTUP

See Also:

• Constant Field Values

MISC_SUMMARY_FORMAT_TRO

public static final String MISC_SUMMARY_FORMAT_TRO

See Also:

• Constant Field Values

MISC_SKIP_SAFETY_PROMPTS

public static final String MISC_SKIP_SAFETY_PROMPTS

See Also:

• Constant Field Values

MISC_APPLICATION_EXIT_PROMPT

public static final String MISC_APPLICATION_EXIT_PROMPT

See Also:

• Constant Field Values

MISC_MUL_OPEN_BEHAVIOUR

public static final String MISC_MUL_OPEN_BEHAVIOUR

See Also:

• Constant Field Values

MISC_INCLUDE_LICENSE

public static final String MISC_INCLUDE_LICENSE

See Also:

• Constant Field Values

GUI_PLAF

public static final String GUI_PLAF

See Also:

• Constant Field Values

GUI_COLOR_WEAPONS

public static final String GUI_COLOR_WEAPONS

See Also:

• Constant Field Values

GUI_COLOR_AMMO

public static final String GUI_COLOR_AMMO

See Also:

• Constant Field Values

GUI_COLOR_EQUIPMENT

public static final String GUI_COLOR_EQUIPMENT

See Also:

• Constant Field Values

GUI_COLOR_SYSTEMS

public static final String GUI_COLOR_SYSTEMS

See Also:

• Constant Field Values

GUI_COLOR_EMPTY

public static final String GUI_COLOR_EMPTY

See Also:

• Constant Field Values

GUI_COLOR_NON_HITTABLE

public static final String GUI_COLOR_NON_HITTABLE

See Also:

• Constant Field Values

GUI_FOREGROUND

public static final String GUI_FOREGROUND

See Also:

• Constant Field Values

GUI_BACKGROUND

public static final String GUI_BACKGROUND

See Also:

• Constant Field Values

GUI_FULLSCREEN

public static final String GUI_FULLSCREEN

See Also:

• Constant Field Values

GUI_BM_MAIN_UI_WINDOW

public static final String GUI_BM_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_CV_MAIN_UI_WINDOW

public static final String GUI_CV_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_AS_MAIN_UI_WINDOW

public static final String GUI_AS_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_SV_MAIN_UI_WINDOW

public static final String GUI_SV_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_PM_MAIN_UI_WINDOW

public static final String GUI_PM_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_BA_MAIN_UI_WINDOW

public static final String GUI_BA_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_CI_MAIN_UI_WINDOW

public static final String GUI_CI_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_DS_MAIN_UI_WINDOW

public static final String GUI_DS_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_WS_MAIN_UI_WINDOW

public static final String GUI_WS_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_HHW_MAIN_UI_WINDOW

public static final String GUI_HHW_MAIN_UI_WINDOW

See Also:

• Constant Field Values

GUI_TABBED_WINDOW

public static final String GUI_TABBED_WINDOW

See Also:

• Constant Field Values

RECENT_FILE_COUNT

public static final int RECENT_FILE_COUNT

See Also:

• Constant Field Values

FILE_RECENT_PREFIX

public static final String FILE_RECENT_PREFIX

See Also:

• Constant Field Values

FILE_LAST_DIRECTORY

public static final String FILE_LAST_DIRECTORY

See Also:

• Constant Field Values

FILE_CHOOSER_WINDOW

public static final String FILE_CHOOSER_WINDOW

See Also:

• Constant Field Values

FORCE_BUILD_WINDOW

public static final String FORCE_BUILD_WINDOW

See Also:

• Constant Field Values

TECH_PROGRESSION

public static final String TECH_PROGRESSION

See Also:

• Constant Field Values

TECH_USE_YEAR

public static final String TECH_USE_YEAR

See Also:

• Constant Field Values

TECH_YEAR

public static final String TECH_YEAR

See Also:

• Constant Field Values

TECH_SHOW_FACTION

public static final String TECH_SHOW_FACTION

See Also:

• Constant Field Values

TECH_EXTINCT

public static final String TECH_EXTINCT

See Also:

• Constant Field Values

TECH_UNOFFICIAL_NO_YEAR

public static final String TECH_UNOFFICIAL_NO_YEAR

See Also:

• Constant Field Values

RS_PAPER_SIZE

public static final String RS_PAPER_SIZE

See Also:

• Constant Field Values

RS_COLOR

public static final String RS_COLOR

See Also:

• Constant Field Values

RS_HEAT_SCALE_MARKER

public static final String RS_HEAT_SCALE_MARKER

See Also:

• Constant Field Values

RS_ROW_SHADING

public static final String RS_ROW_SHADING

See Also:

• Constant Field Values

RS_FONT

public static final String RS_FONT

See Also:

• Constant Field Values

RS_PROGRESS_BAR

public static final String RS_PROGRESS_BAR

See Also:

• Constant Field Values

RS_SHOW_QUIRKS

public static final String RS_SHOW_QUIRKS

See Also:

• Constant Field Values

RS_SHOW_C3BV

public static final String RS_SHOW_C3BV

See Also:

• Constant Field Values

RS_SHOW_PILOT_DATA

public static final String RS_SHOW_PILOT_DATA

See Also:

• Constant Field Values

RS_SHOW_ERA

public static final String RS_SHOW_ERA

See Also:

• Constant Field Values

RS_SHOW_ROLE

public static final String RS_SHOW_ROLE

See Also:

• Constant Field Values

RS_HEAT_PROFILE

public static final String RS_HEAT_PROFILE

See Also:

• Constant Field Values

RS_TAC_OPS_HEAT

public static final String RS_TAC_OPS_HEAT

See Also:

• Constant Field Values

RS_REFERENCE

public static final String RS_REFERENCE

See Also:

• Constant Field Values

RS_CONDENSED_REFERENCE

public static final String RS_CONDENSED_REFERENCE

See Also:

• Constant Field Values

RS_SCALE_FACTOR

public static final String RS_SCALE_FACTOR

See Also:

• Constant Field Values

RS_SCALE_UNITS

public static final String RS_SCALE_UNITS

See Also:

• Constant Field Values

RS_MEK_NAMES

public static final String RS_MEK_NAMES

See Also:

• Constant Field Values

RS_ARMOR_GROUPING

public static final String RS_ARMOR_GROUPING

See Also:

• Constant Field Values

RS_FRAMELESS

public static final String RS_FRAMELESS

See Also:

• Constant Field Values

RS_BOLD_TYPE

public static final String RS_BOLD_TYPE

See Also:

• Constant Field Values

RS_DAMAGE

public static final String RS_DAMAGE

See Also:

• Constant Field Values

RS_DAMAGE_COLOR

public static final String RS_DAMAGE_COLOR

See Also:

• Constant Field Values

RS_WEAPONS_ORDER

public static final String RS_WEAPONS_ORDER

See Also:

• Constant Field Values

RS_MERGE_IDENTICAL_EQUIPMENT

public static final String RS_MERGE_IDENTICAL_EQUIPMENT

See Also:

• Constant Field Values

RS_HIT_MOD

public static final String RS_HIT_MOD

See Also:

• Constant Field Values

RS_INTRINSIC_PHYSICALS

public static final String RS_INTRINSIC_PHYSICALS

See Also:

• Constant Field Values

RS_EXPLICIT_ZERO_MOD

public static final String RS_EXPLICIT_ZERO_MOD

See Also:

• Constant Field Values

RS_EXTRA_PHYSICALS

public static final String RS_EXTRA_PHYSICALS

See Also:

• Constant Field Values

RS_FANCY_PIPS

public static final String RS_FANCY_PIPS

See Also:

• Constant Field Values

RS_TAC_OPS_VEHICLE_EFFECTIVENESS

public static final String RS_TAC_OPS_VEHICLE_EFFECTIVENESS

See Also:

• Constant Field Values

NAG_EQUIPMENT_CTRL_CLICK

public static final String NAG_EQUIPMENT_CTRL_CLICK

See Also:

• Constant Field Values

NAG_IMPORT_SETTINGS

public static final String NAG_IMPORT_SETTINGS

See Also:

• Constant Field Values

MEK_AUTOFILL

public static final String MEK_AUTOFILL

See Also:

• Constant Field Values

MEK_AUTO_SORT

public static final String MEK_AUTO_SORT

See Also:

• Constant Field Values

MEK_AUTO_COMPACT

public static final String MEK_AUTO_COMPACT

See Also:

• Constant Field Values

PQ_SINGLE_PRINT

public static final String PQ_SINGLE_PRINT

See Also:

• Constant Field Values

PQ_ADJUSTED_BV

public static final String PQ_ADJUSTED_BV

See Also:

• Constant Field Values

PQ_DAMAGE

public static final String PQ_DAMAGE

See Also:

• Constant Field Values

PQ_SHOW_PILOT_DATA

public static final String PQ_SHOW_PILOT_DATA

See Also:

• Constant Field Values

Method Details

load

public static void load()

Loads the MegaMekLab configuration.

importSettings

public static void importSettings(MenuBarOwner menuBarOwner,
 File settingsFile)

Tries to import settings from the given properties file. When successful, also applies some of the settings and shows a popup message.

Parameters:

menuBarOwner - The MenuBar owner frame calling this

settingsFile - The file (should always be megameklab.properties in another MML install)

loadConfigFile

public static void loadConfigFile()

Loads the Config file.

ensureConfigFileExists

public static void ensureConfigFileExists()

Creates a new Config file, and directories, if it is missing.

getParam

public static String getParam(String param,
 String defaultVal)

Get a config value, with a default value to be used if the value is not found.

Parameters:

param - The key

defaultVal - The value to return if the entry is not found

Returns:

The value associated with the key

getParam

public static String getParam(String param)

Get a config value.

Parameters:

param - The key

Returns:

The value associated with the key. If not found, an empty String is returned

setParam

public static void setParam(String param,
 String value)

Set a config value.

Parameters:

param - the name of the parameter

value - the value to set the parameter to

getIntParam

public static int getIntParam(String param,
 int defaultVal)

Return the int value of a given config property. Return the provided default value if the property is a non-number.

Parameters:

param - The parameter name

defaultVal - The value to return if the property does not exist or is not a valid string representation of the integer

Returns:

The integer value of the property

getIntParam

public static int getIntParam(String param)

Return the int value of a given config property. Return a 0 if the property is a non-number.

Parameters:

param - The parameter name

Returns:

The integer value of the property

getEnumParam

public static <E extends Enum<E>> E getEnumParam(String key,
 Class<E> enumClass,
 E defaultVal)

Return the enum value of a given config property.

setEnumParam

@Deprecated(since="0.51.0",
            forRemoval=true)
public static <E extends Enum<E>> void setEnumParam(String key,
 E value)

Deprecated, for removal: This API element is subject to removal in a future version.

Set a config value to the name of the enum.

Parameters:

key - the name of the parameter

value - the value to set the parameter to

getBooleanParam

public static boolean getBooleanParam(String param)

Parameters:

param - the parameter's name

Returns:

the boolean value of a given config property. Return a false if the property does not exist.

saveConfig

public static void saveConfig()

Write the config file out to ./data/mwconfig.txt.

getForegroundColor

public static Color getForegroundColor(String fieldName)

getBackgroundColor

public static Color getBackgroundColor(String fieldName)

setMostRecentFile

public static void setMostRecentFile(String newFile)

getRecentFiles

public static List<String> getRecentFiles()

scaleUnits

public static RSScale scaleUnits()

Returns:

The currently selected scale units for record sheet printing

formatScale

public static String formatScale(double val,
 boolean showUnits)

Applies the scale factor to a value and optionally adds the unit abbreviation

Parameters:

val - The base distance (standard hexes)

showUnits - Whether to append the unit abbreviation

Returns:

A String representation of the scaled value

getFileChooserSize

public static Optional<Dimension> getFileChooserSize()

getFileChooserPosition

public static Optional<Point> getFileChooserPosition()

writeFileChooserSettings

public static void writeFileChooserSettings(JDialog dialog)

getForceBuildPosition

public static Optional<Point> getForceBuildPosition()

writeForceBuildPosition

public static void writeForceBuildPosition(JFrame frame)

getMainUiWindowSize

public static Optional<Dimension> getMainUiWindowSize(MenuBarOwner mainUi)

getMainUiWindowPosition

public static Optional<Point> getMainUiWindowPosition(MenuBarOwner mainUi)

getNamedWindowSize

@Deprecated(since="0.51.0",
            forRemoval=true)
public static Optional<Dimension> getNamedWindowSize(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

writeMainUiWindowSettings

public static void writeMainUiWindowSettings(MenuBarOwner mainUi)

writeNamedWindowSize

@Deprecated(since="0.51.0",
            forRemoval=true)
public static void writeNamedWindowSize(String name,
 Window component)

Deprecated, for removal: This API element is subject to removal in a future version.

getRecentFile

public static String getRecentFile(int recentFileNumber)

getStartUpType

public static MMLStartUp getStartUpType()

getMekNameArrangement

public static MekChassisArrangement getMekNameArrangement()

includeLicense

public static boolean includeLicense()

resetWindowPositions

public static void resetWindowPositions()