Package megamek.common.icons

Class Portrait

java.lang.Object

megamek.common.icons.AbstractIcon

megamek.common.icons.Portrait

All Implemented Interfaces:

Serializable

public class Portrait
extends AbstractIcon

Portrait is an implementation of AbstractIcon that contains and displays a Portrait from the Portrait Directory.

See Also:

• AbstractIcon
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_IMAGE_WIDTH
static final String	DEFAULT_PORTRAIT_FILENAME
static final String	NO_PORTRAIT_NAME
static final String	XML_TAG

Fields inherited from class megamek.common.icons.AbstractIcon

DEFAULT_ICON_FILENAME, filename, ROOT_CATEGORY

Constructor Summary

Constructors

Constructor	Description
Portrait()
Portrait(File file)	Constructs a new portrait with the given file.
Portrait(String category, String filename)

Method Summary

Modifier and Type	Method	Description
Portrait	clone()
Image	getBaseImage()	This is abstract to allow for different formats for determining the image in question
Image	getImage()
boolean	hasDefaultFilename()
static Portrait	parseFromXML(Node wn)
void	setFilename(String filename)
void	writeToXML(PrintWriter pw, int indent)

Methods inherited from class megamek.common.icons.AbstractIcon

equals, getCategory, getFilename, getImage, getImage, getImage, getImageIcon, getImageIcon, hasDefaultCategory, hashCode, isDefault, isScaled, parseNode, parseNodes, scaleAndCenter, setCategory, toString, writeBodyToXML, writeToXML

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_PORTRAIT_FILENAME

public static final String DEFAULT_PORTRAIT_FILENAME

See Also:

• Constant Field Values

NO_PORTRAIT_NAME

public static final String NO_PORTRAIT_NAME

See Also:

• Constant Field Values

XML_TAG

public static final String XML_TAG

See Also:

• Constant Field Values

DEFAULT_IMAGE_WIDTH

public static final int DEFAULT_IMAGE_WIDTH

See Also:

• Constant Field Values

Constructor Details

Portrait

public Portrait()

Portrait

public Portrait(@Nullable
 String category,
 @Nullable
 String filename)

Portrait

public Portrait(File file)

Constructs a new portrait with the given file. Even though a file is accepted, this can only be used for portraits of the directories that are parsed automatically, i.e. the MM-internal portrait dir, the user dir and the story arcs directory! This method tries to parse the filename to find the portrait. This requires replacing Windows backslashes with normal slashes in order to find the file in the way portraits are stored (see AbstractDirectory)

Parameters:

file - The File, such as a file of "Female/Aerospace Pilot/ASF_F_3.png"

Method Details

setFilename

public void setFilename(@Nullable
 String filename)

Overrides:

setFilename in class AbstractIcon

hasDefaultFilename

public boolean hasDefaultFilename()

Overrides:

hasDefaultFilename in class AbstractIcon

getImage

public Image getImage()

Overrides:

getImage in class AbstractIcon

Returns:

the current image, scaled and centered to a width of 72 pixels

getBaseImage

public Image getBaseImage()

Description copied from class: AbstractIcon

This is abstract to allow for different formats for determining the image in question

Specified by:

getBaseImage in class AbstractIcon

Returns:

the Image stored by the AbstractIcon

writeToXML

public void writeToXML(PrintWriter pw,
 int indent)

Specified by:

writeToXML in class AbstractIcon

parseFromXML

public static Portrait parseFromXML(Node wn)

clone

public Portrait clone()

Overrides:

clone in class Object