Package VASSAL.launch

Class ModuleManagerWindow.ModuleInfo

java.lang.Object

VASSAL.launch.ModuleManagerWindow.ModuleInfo

All Implemented Interfaces:

Comparable<VASSAL.launch.ModuleManagerWindow.AbstractInfo>

Enclosing class:

ModuleManagerWindow

public class ModuleManagerWindow.ModuleInfo
extends Object

Module Node User Information

Field Summary

Fields

Modifier and Type	Field	Description
protected Icon	closedIcon
protected String	error
protected File	file
protected VASSAL.launch.ModuleManagerWindow.MyTreeNode	node
protected Icon	openIcon
protected boolean	valid

Constructor Summary

Constructors

Constructor	Description
ModuleInfo(File f)
ModuleInfo(String s)	Initialise ModuleInfo based on a saved preference string.

Method Summary

Modifier and Type	Method	Description
void	addFolder(File f)
JPopupMenu	buildPopup(int row)
void	cleanupTileCache()
int	compareTo(VASSAL.launch.ModuleManagerWindow.AbstractInfo info)
String	encode()	Encode any information which needs to be recorded in the Preference entry for this module:- - Path to Module File - Paths to any child Save Game Folders
String	getComments()
String	getError()
List<VASSAL.launch.ModuleManagerWindow.ExtensionInfo>	getExtensions()
ExtensionsManager	getExtensionsManager()
File	getFile()
SortedSet<File>	getFolders()
Icon	getIcon(boolean expanded)
String	getLastSaved()
String	getLocalizedDescription()
String	getModuleName()
String	getSortKey()	Return a String used to sort different types of AbstractInfo's that are children of the same parent.
String	getToolTipText()
Color	getTreeCellFgColor()	Return the color of the text used to display the name in column 1.
VASSAL.launch.ModuleManagerWindow.MyTreeNode	getTreeNode()
String	getValueAt(int column)
String	getVassalVersion()
String	getVersion()
boolean	isInUse()
protected boolean	isModuleTooNew()
boolean	isValid()
protected void	loadMetaData()
void	play()
void	refresh()	Refresh this module and all children
void	refreshChildren()
void	removeFolder(File f)
void	setError(String s)
void	setFile(File f)
void	setIcon(Icon i)
void	setIcon(Icon open, Icon closed)
void	setTreeNode(VASSAL.launch.ModuleManagerWindow.MyTreeNode n)
void	setValid(boolean b)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

file

protected File file

openIcon

protected Icon openIcon

closedIcon

protected Icon closedIcon

valid

protected boolean valid

error

protected String error

node

protected VASSAL.launch.ModuleManagerWindow.MyTreeNode node

Constructor Details

ModuleInfo

public ModuleInfo(File f)

ModuleInfo

public ModuleInfo(String s)

Initialise ModuleInfo based on a saved preference string. See encode().

Parameters:

s - Preference String

Method Details

loadMetaData

protected void loadMetaData()

isModuleTooNew

protected boolean isModuleTooNew()

getVassalVersion

public String getVassalVersion()

getLastSaved

public String getLastSaved()

refresh

public void refresh()

Refresh this module and all children

encode

public String encode()

Encode any information which needs to be recorded in the Preference entry for this module:- - Path to Module File - Paths to any child Save Game Folders

Returns:

encoded data

getExtensionsManager

public ExtensionsManager getExtensionsManager()

addFolder

public void addFolder(File f)

removeFolder

public void removeFolder(File f)

getFolders

public SortedSet<File> getFolders()

getExtensions

public List<VASSAL.launch.ModuleManagerWindow.ExtensionInfo> getExtensions()

play

public void play()

buildPopup

public JPopupMenu buildPopup(int row)

cleanupTileCache

public void cleanupTileCache()

isInUse

public boolean isInUse()

getVersion

public String getVersion()

getLocalizedDescription

public String getLocalizedDescription()

getModuleName

public String getModuleName()

toString

public String toString()

getValueAt

public String getValueAt(int column)

getSortKey

public String getSortKey()

Return a String used to sort different types of AbstractInfo's that are children of the same parent.

Returns:

sort key

getTreeCellFgColor

public Color getTreeCellFgColor()

Return the color of the text used to display the name in column 1. Over-ride this to change color depending on item state.

Returns:

cell text color

getFile

public File getFile()

setFile

public void setFile(File f)

getToolTipText

public String getToolTipText()

compareTo

public int compareTo(VASSAL.launch.ModuleManagerWindow.AbstractInfo info)

Specified by:

compareTo in interface Comparable<VASSAL.launch.ModuleManagerWindow.AbstractInfo>

getIcon

public Icon getIcon(boolean expanded)

setIcon

public void setIcon(Icon i)

setIcon

public void setIcon(Icon open,
 Icon closed)

setValid

public void setValid(boolean b)

isValid

public boolean isValid()

setError

public void setError(String s)

getError

public String getError()

getComments

public String getComments()

getTreeNode

public VASSAL.launch.ModuleManagerWindow.MyTreeNode getTreeNode()

setTreeNode

public void setTreeNode(VASSAL.launch.ModuleManagerWindow.MyTreeNode n)

refreshChildren

public void refreshChildren()