Package megamek.client.ui.widget

Class SkinXMLHandler

java.lang.Object

megamek.client.ui.widget.SkinXMLHandler

public class SkinXMLHandler
extends Object

This class reads in an XML file that specifies different aspects of the visual skin for MegaMek.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ArmorTabActive
static final String	ArmorTabIdle
static final String	BACKGROUND_IMAGE
static final String	BackgroundTile
static final String	BL_CORNER
static final String	BORDER
static final String	BOTTOM_LINE
static final String	BottomLeftCorner
static final String	BottomLine
static final String	BottomRightCorner
static final String	BR_CORNER
static final String	CornerActive
static final String	CornerIdle
static String	defaultSkinXML	The file name for the default Skin XML file, found in the config dir.
static final String	EDGE
static final String	EDGE_ICON
static final String	EDGE_NAME
static final String	ExtrasTabIdle
static final String	ExtraTabActive
static final String	FONT_COLOR
static final String	FONT_NAME
static final String	FONT_SIZE
static final String	GeneralTabActive
static final String	GeneralTabIdle
static final String	ICON
static final String	LEFT_LINE
static final String	LeftLine
static final String	MekOutline
static String	NAME
static final String	NO_BORDER
static final String	PilotTabActive
static final String	PilotTabIdle
static final String	PLAIN
static final String	RIGHT_LINE
static final String	RightLine
static final String	SHOULD_BOLD
static final String	SHOW_SCROLL_BARS
static String	SKIN_FOOTER
static String	SKIN_HEADER
static final String	SystemsTabActive
static final String	SystemsTabIdle
static final String	TILE_BACKGROUND
static final String	TILED
static final String	TL_CORNER
static final String	TOP_LINE
static final String	TopLeftCorner
static final String	TopLine
static final String	TopRightCorner
static final String	TR_CORNER
static String	UI_ELEMENT
static final String	WeaponsTabActive
static final String	WeaponsTabIdle

Constructor Summary

Constructors

Constructor	Description
SkinXMLHandler()

Method Summary

Modifier and Type	Method	Description
static void	addNewComp(String component)	Adds a new component to the SkinSpecs map.
static SkinSpecification	getSkin(String component)
static SkinSpecification	getSkin(String component, boolean defaultToPlain)
static SkinSpecification	getSkin(String component, boolean defaultToPlain, boolean isBtn)	Get a SkinSpecification for a given component.
static Set<String>	getSkinnedComponents()	Returns the list of components that have SkinSpecifications.
static UnitDisplaySkinSpecification	getUnitDisplaySkin()
static boolean	initSkinXMLHandler()	Initializes using the default skin file.
static boolean	initSkinXMLHandler(String filename)	Initializes using the supplied skin file.
static void	removeComp(String component)	Remove the specified component from the SkinSpecs map.
static boolean	validSkinSpecFile(String fileName)	Checks whether the given path points to a file that is a valid skin specification.
static void	writeSkinToFile(String filename)	Writes the current skin to the specified XML file.

Methods inherited from class java.lang.Object

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

Field Details

SKIN_FOOTER

public static String SKIN_FOOTER

SKIN_HEADER

public static String SKIN_HEADER

defaultSkinXML

public static String defaultSkinXML

The file name for the default Skin XML file, found in the config dir.

UI_ELEMENT

public static String UI_ELEMENT

NAME

public static String NAME

FONT_COLOR

public static final String FONT_COLOR

See Also:

• Constant Field Values

BORDER

public static final String BORDER

See Also:

• Constant Field Values

PLAIN

public static final String PLAIN

See Also:

• Constant Field Values

NO_BORDER

public static final String NO_BORDER

See Also:

• Constant Field Values

TILE_BACKGROUND

public static final String TILE_BACKGROUND

See Also:

• Constant Field Values

TR_CORNER

public static final String TR_CORNER

See Also:

• Constant Field Values

TL_CORNER

public static final String TL_CORNER

See Also:

• Constant Field Values

BR_CORNER

public static final String BR_CORNER

See Also:

• Constant Field Values

BL_CORNER

public static final String BL_CORNER

See Also:

• Constant Field Values

EDGE

public static final String EDGE

See Also:

• Constant Field Values

EDGE_NAME

public static final String EDGE_NAME

See Also:

• Constant Field Values

EDGE_ICON

public static final String EDGE_ICON

See Also:

• Constant Field Values

ICON

public static final String ICON

See Also:

• Constant Field Values

TILED

public static final String TILED

See Also:

• Constant Field Values

TOP_LINE

public static final String TOP_LINE

See Also:

• Constant Field Values

BOTTOM_LINE

public static final String BOTTOM_LINE

See Also:

• Constant Field Values

RIGHT_LINE

public static final String RIGHT_LINE

See Also:

• Constant Field Values

LEFT_LINE

public static final String LEFT_LINE

See Also:

• Constant Field Values

BACKGROUND_IMAGE

public static final String BACKGROUND_IMAGE

See Also:

• Constant Field Values

SHOW_SCROLL_BARS

public static final String SHOW_SCROLL_BARS

See Also:

• Constant Field Values

SHOULD_BOLD

public static final String SHOULD_BOLD

See Also:

• Constant Field Values

FONT_NAME

public static final String FONT_NAME

See Also:

• Constant Field Values

FONT_SIZE

public static final String FONT_SIZE

See Also:

• Constant Field Values

GeneralTabIdle

public static final String GeneralTabIdle

See Also:

• Constant Field Values

PilotTabIdle

public static final String PilotTabIdle

See Also:

• Constant Field Values

ArmorTabIdle

public static final String ArmorTabIdle

See Also:

• Constant Field Values

SystemsTabIdle

public static final String SystemsTabIdle

See Also:

• Constant Field Values

WeaponsTabIdle

public static final String WeaponsTabIdle

See Also:

• Constant Field Values

ExtrasTabIdle

public static final String ExtrasTabIdle

See Also:

• Constant Field Values

GeneralTabActive

public static final String GeneralTabActive

See Also:

• Constant Field Values

PilotTabActive

public static final String PilotTabActive

See Also:

• Constant Field Values

ArmorTabActive

public static final String ArmorTabActive

See Also:

• Constant Field Values

SystemsTabActive

public static final String SystemsTabActive

See Also:

• Constant Field Values

WeaponsTabActive

public static final String WeaponsTabActive

See Also:

• Constant Field Values

ExtraTabActive

public static final String ExtraTabActive

See Also:

• Constant Field Values

CornerIdle

public static final String CornerIdle

See Also:

• Constant Field Values

CornerActive

public static final String CornerActive

See Also:

• Constant Field Values

BackgroundTile

public static final String BackgroundTile

See Also:

• Constant Field Values

TopLine

public static final String TopLine

See Also:

• Constant Field Values

BottomLine

public static final String BottomLine

See Also:

• Constant Field Values

LeftLine

public static final String LeftLine

See Also:

• Constant Field Values

RightLine

public static final String RightLine

See Also:

• Constant Field Values

TopLeftCorner

public static final String TopLeftCorner

See Also:

• Constant Field Values

BottomLeftCorner

public static final String BottomLeftCorner

See Also:

• Constant Field Values

TopRightCorner

public static final String TopRightCorner

See Also:

• Constant Field Values

BottomRightCorner

public static final String BottomRightCorner

See Also:

• Constant Field Values

MekOutline

public static final String MekOutline

See Also:

• Constant Field Values

Constructor Details

SkinXMLHandler

public SkinXMLHandler()

Method Details

validSkinSpecFile

public static boolean validSkinSpecFile(String fileName)

Checks whether the given path points to a file that is a valid skin specification.

initSkinXMLHandler

public static boolean initSkinXMLHandler()

Initializes using the default skin file.

initSkinXMLHandler

public static boolean initSkinXMLHandler(@Nullable
 String filename)

Initializes using the supplied skin file.

writeSkinToFile

public static void writeSkinToFile(String filename)

Writes the current skin to the specified XML file.

getSkin

public static SkinSpecification getSkin(String component)

getSkin

public static SkinSpecification getSkin(String component,
 boolean defaultToPlain)

getSkinnedComponents

public static Set<String> getSkinnedComponents()

Returns the list of components that have SkinSpecifications.

getSkin

public static SkinSpecification getSkin(String component,
 boolean defaultToPlain,
 boolean isBtn)

Get a SkinSpecification for a given component.

Parameters:

component - The name of the component to get skin info for.

defaultToPlain - Determines if a default component should be used if no match, or a plain component

getUnitDisplaySkin

public static UnitDisplaySkinSpecification getUnitDisplaySkin()

addNewComp

public static void addNewComp(String component)

Adds a new component to the SkinSpecs map.

removeComp

public static void removeComp(String component)

Remove the specified component from the SkinSpecs map.