Interface CharacterInfoTab

code/src/java/pcgen/gui2/tabs/CharacterInfoTab.java:57–123

This interface must be implemented by all tabs that display character information: summary tab, classes tab, abilities tab, inventory tab, etc.... The goal of this class is to create a separation of UI models and the UI components that use them. By doing this, knowledge of the CharacterFacade can be

 * that would occur to any state would be in a call to {@code storeModels}.
 */
public interface CharacterInfoTab
{

	/**
	 * This gives the CharacterInfoTab a chance to store the models that it will
	 * use for a given character into a Hashtable. This returned Hashtable will
	 * be used as arguments in storeModels(Hashtable) and
	 * restoreModels(Hashtable).
	 * <p>
	 * Note: Character tabs implementing this method should <b>NOT</b> make any
	 * changes to its UI components, this method is purely meant to create
	 * models and making changes to the UI components could produce undesirable
	 * side effects.
	 *
	 * @param character the character that this state is for.
	 * @return a ModelMap containing the UI models created for this character
	 */
	public ModelMap createModels(CharacterFacade character);

	/**
	 * This restores this character tab to a state that contains the models for
	 * some given character. The models in question were created during the call
	 * to {@code createModels(CharacterFacade)} When this is called the tab
	 * should attach the models contained within this state to the UI components
	 * of this tab.
	 *
	 * @param models a ModelMap containing the models for this character
	 */
	public void restoreModels(ModelMap models);

	/**
	 * This is called to save any character specific info that might have
	 * changed since {@code restoreModels} was called. Implementors might
	 * also use this method to detach non swappable models from the UI
	 * components, i.e. listeners.
	 *
	 * @param models a ModelMap that contains the models for some character
	 */
	public void storeModels(ModelMap models);

	/**
	 * This returns an Action that will be used by the InfoTabbedPane to render
	 * the tab's title. Any changes in the Action's properties will be
	 * immediately rendered onto the tab's title space.
	 *
	 * @return an Action for the tab title
	 */
	public TabTitle getTabTitle();

	public static class ModelMap
	{

		private final HashMap<Object, Object> classMap = new HashMap<>();

		public <T> T get(Class<T> key)
		{
			return (T) classMap.get(key);
		}