EquipmentColumn.java

/*
 * Copyright (c) 1998-2017 by Richard A. Wilkes. All rights reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, version 2.0. If a copy of the MPL was not distributed with
 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, version 2.0.
 */

package com.trollworks.gcs.equipment;

import com.trollworks.gcs.character.GURPSCharacter;
import com.trollworks.gcs.common.DataFile;
import com.trollworks.gcs.common.ListFile;
import com.trollworks.gcs.library.LibraryFile;
import com.trollworks.gcs.preferences.SheetPreferences;
import com.trollworks.gcs.template.Template;
import com.trollworks.gcs.widgets.outline.ListHeaderCell;
import com.trollworks.gcs.widgets.outline.ListTextCell;
import com.trollworks.gcs.widgets.outline.MultiCell;
import com.trollworks.toolkit.annotation.Localize;
import com.trollworks.toolkit.ui.widget.outline.Cell;
import com.trollworks.toolkit.ui.widget.outline.Column;
import com.trollworks.toolkit.ui.widget.outline.Outline;
import com.trollworks.toolkit.ui.widget.outline.OutlineModel;
import com.trollworks.toolkit.utility.Localization;
import com.trollworks.toolkit.utility.text.Numbers;
import com.trollworks.toolkit.utility.units.WeightUnits;
import com.trollworks.toolkit.utility.units.WeightValue;

import java.text.MessageFormat;

import javax.swing.SwingConstants;

/** Definitions for equipment columns. */
public enum EquipmentColumn {
	/** The quantity. */
	QUANTITY {
		@Override
		public String toString() {
			return QUANTITY_TITLE;
		}

		@Override
		public String getToolTip() {
			return QUANTITY_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return !(dataFile instanceof ListFile) && !(dataFile instanceof LibraryFile);
		}

		@Override
		public Object getData(Equipment equipment) {
			return new Integer(equipment.getQuantity());
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return Numbers.format(equipment.getQuantity());
		}
	},
	/** The current equipment state. */
	STATE {
		@Override
		public String toString() {
			return STATE_TITLE;
		}

		@Override
		public String getToolTip() {
			return STATE_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.CENTER, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return dataFile instanceof GURPSCharacter;
		}

		@Override
		public Object getData(Equipment equipment) {
			return equipment.getState();
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return equipment.getState().toShortName();
		}
	},
	/** The equipment name/description. */
	DESCRIPTION {
		@Override
		public String toString() {
			return DESCRIPTION_TITLE;
		}

		@Override
		public String getToolTip() {
			return DESCRIPTION_TOOLTIP;
		}

		@Override
		public String toString(GURPSCharacter character) {
			if (character != null) {
				return MessageFormat.format(DESCRIPTION_TOTALS, character.getWeightCarried().toString(), Numbers.format(character.getWealthCarried()));
			}
			return super.toString(character);
		}

		@Override
		public Cell getCell() {
			return new MultiCell();
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return true;
		}

		@Override
		public boolean isHierarchyColumn() {
			return true;
		}

		@Override
		public Object getData(Equipment equipment) {
			return getDataAsText(equipment);
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			StringBuilder builder = new StringBuilder();
			String notes = equipment.getNotes();

			builder.append(equipment.toString());
			if (notes.length() > 0) {
				builder.append(" - "); //$NON-NLS-1$
				builder.append(notes);
			}
			return builder.toString();
		}
	},
	/** The tech level. */
	TECH_LEVEL {
		@Override
		public String toString() {
			return TECH_LEVEL_TITLE;
		}

		@Override
		public String getToolTip() {
			return TECH_LEVEL_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return dataFile instanceof ListFile || dataFile instanceof LibraryFile;
		}

		@Override
		public Object getData(Equipment equipment) {
			return equipment.getTechLevel();
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return equipment.getTechLevel();
		}
	},
	/** The legality class. */
	LEGALITY_CLASS {
		@Override
		public String toString() {
			return LEGALITY_CLASS_TITLE;
		}

		@Override
		public String getToolTip() {
			return LEGALITY_CLASS_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return dataFile instanceof ListFile || dataFile instanceof LibraryFile;
		}

		@Override
		public Object getData(Equipment equipment) {
			return equipment.getLegalityClass();
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return equipment.getLegalityClass();
		}
	},
	/** The value. */
	VALUE {
		@Override
		public String toString() {
			return VALUE_TITLE;
		}

		@Override
		public String getToolTip() {
			return VALUE_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return true;
		}

		@Override
		public Object getData(Equipment equipment) {
			return new Double(equipment.getValue());
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return Numbers.format(equipment.getValue());
		}
	},
	/** The weight. */
	WEIGHT {
		@Override
		public String toString() {
			return WEIGHT_TITLE;
		}

		@Override
		public String getToolTip() {
			return WEIGHT_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return true;
		}

		@Override
		public Object getData(Equipment equipment) {
			return equipment.getWeight();
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return getDisplayWeight(equipment.getWeight());
		}
	},
	/** The value. */
	EXT_VALUE {
		@Override
		public String toString() {
			return EXT_VALUE_TITLE;
		}

		@Override
		public String getToolTip() {
			return EXT_VALUE_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return !(dataFile instanceof ListFile) && !(dataFile instanceof LibraryFile);
		}

		@Override
		public Object getData(Equipment equipment) {
			return new Double(equipment.getExtendedValue());
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return Numbers.format(equipment.getExtendedValue());
		}
	},
	/** The weight. */
	EXT_WEIGHT {
		@Override
		public String toString() {
			return EXT_WEIGHT_TITLE;
		}

		@Override
		public String getToolTip() {
			return EXT_WEIGHT_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return !(dataFile instanceof ListFile) && !(dataFile instanceof LibraryFile);
		}

		@Override
		public Object getData(Equipment equipment) {
			return equipment.getExtendedWeight();
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return getDisplayWeight(equipment.getExtendedWeight());
		}
	},
	/** The category. */
	CATEGORY {
		@Override
		public String toString() {
			return CATEGORY_TITLE;
		}

		@Override
		public String getToolTip() {
			return CATEGORY_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.LEFT, true);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return dataFile instanceof ListFile || dataFile instanceof LibraryFile;
		}

		@Override
		public Object getData(Equipment equipment) {
			return getDataAsText(equipment);
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return equipment.getCategoriesAsString();
		}
	},
	/** The page reference. */
	REFERENCE {
		@Override
		public String toString() {
			return REFERENCE_TITLE;
		}

		@Override
		public String getToolTip() {
			return REFERENCE_TOOLTIP;
		}

		@Override
		public Cell getCell() {
			return new ListTextCell(SwingConstants.RIGHT, false);
		}

		@Override
		public boolean shouldDisplay(DataFile dataFile) {
			return true;
		}

		@Override
		public Object getData(Equipment equipment) {
			return getDataAsText(equipment);
		}

		@Override
		public String getDataAsText(Equipment equipment) {
			return equipment.getReference();
		}
	};

	@Localize("Equipment")
	@Localize(locale = "de", value = "Ausrüstung")
	@Localize(locale = "ru", value = "Снаряжение")
	@Localize(locale = "es", value = "Equipo")
	static String	DESCRIPTION_TITLE;
	@Localize("The name and notes describing a piece of equipment")
	@Localize(locale = "de", value = "Der Name und Anmerkungen, die den Ausrüstungsgegenstand beschreiben")
	@Localize(locale = "ru", value = "Название и заметки, описывающие снаряжения")
	@Localize(locale = "es", value = "Nombre y notas describiendo la pieza de equipo")
	static String	DESCRIPTION_TOOLTIP;
	@Localize("Equipment ({0}; ${1})")
	@Localize(locale = "de", value = "Ausrüstung ({0}; {1}$)")
	@Localize(locale = "ru", value = "Снаряжение ({0}; ${1})")
	@Localize(locale = "es", value = "Equipo ({0}; {1}$)")
	static String	DESCRIPTION_TOTALS;
	@Localize("?")
	@Localize(locale = "de", value = "?")
	@Localize(locale = "es", value = "?")
	static String	STATE_TITLE;
	@Localize("Whether this piece of equipment is carried & equipped (E), just carried (C), or not carried (-). Items that are not equipped do not apply any features they may normally contribute to the character.")
	@Localize(locale = "de", value = "Ob dieser Ausrüstungsgegenstand ausgerüstet (A), mitgeführt (M) oder nicht mitgeführt (-) ist. Gegenstände, die nicht ausgerüstet sind, haben keine Auswirkungen auf den Charakter.")
	@Localize(locale = "ru", value = "Предмет снаряжения носим и экипирован (E), только носим (C), или не переносим (-). Не экипированные предметы не добавляют никаких свойств, которыми может воспользоваться персонаж.")
	@Localize(locale = "es", value = "Indica si la pieza de equipo se porta y equipa (E), sólo se porta (P), o no se porta (-). Los objetos no equipados no aplican sus características como harían normalmente al personaje.")
	static String	STATE_TOOLTIP;
	@Localize("TL")
	@Localize(locale = "de", value = "TL")
	@Localize(locale = "ru", value = "ТУ")
	@Localize(locale = "es", value = "NT")
	static String	TECH_LEVEL_TITLE;
	@Localize("The tech level of this piece of equipment")
	@Localize(locale = "de", value = "Der Techlevel des Ausrüstungsgegenstandes")
	@Localize(locale = "ru", value = "Технологический уровень снаряжения")
	@Localize(locale = "es", value = "Nivel tecnológico de la pieza de equipo")
	static String	TECH_LEVEL_TOOLTIP;
	@Localize("LC")
	@Localize(locale = "de", value = "LK")
	@Localize(locale = "ru", value = "КЛ")
	@Localize(locale = "es", value = "NL")
	static String	LEGALITY_CLASS_TITLE;
	@Localize("The legality class of this piece of equipment")
	@Localize(locale = "de", value = "Die Legalitätsklasse des Ausrüstungsgegenstandes")
	@Localize(locale = "ru", value = "Класс легальности снаряжения")
	@Localize(locale = "es", value = "Nivel legal de la pieza de equipo")
	static String	LEGALITY_CLASS_TOOLTIP;
	@Localize("#")
	@Localize(locale = "de", value = "#")
	@Localize(locale = "es", value = "#")
	static String	QUANTITY_TITLE;
	@Localize("The quantity of this piece of equipment")
	@Localize(locale = "de", value = "Die Anzahl der Ausrüstungsgegenstände")
	@Localize(locale = "ru", value = "Количество предметов снаряжения")
	@Localize(locale = "es", value = "Cantidad de piezas de equipo")
	static String	QUANTITY_TOOLTIP;
	@Localize("$")
	@Localize(locale = "de", value = "$")
	static String	VALUE_TITLE;
	@Localize("The value of one of these pieces of equipment")
	@Localize(locale = "de", value = "Der Wert eines einzelnen Ausrüstungsgegenstandes")
	@Localize(locale = "ru", value = "Цена снаряжения")
	@Localize(locale = "es", value = "Valor unitario")
	static String	VALUE_TOOLTIP;
	@Localize("W")
	@Localize(locale = "de", value = "Gew.")
	@Localize(locale = "ru", value = "В")
	@Localize(locale = "es", value = "P")
	static String	WEIGHT_TITLE;
	@Localize("The weight of one of these pieces of equipment")
	@Localize(locale = "de", value = "Das Gewicht eines einzelnen Ausrüstungsgegenstandes")
	@Localize(locale = "ru", value = "Вес снаряжения")
	@Localize(locale = "es", value = "Peso unitario")
	static String	WEIGHT_TOOLTIP;
	@Localize("\u2211 $")
	@Localize(locale = "de", value = "\u2211 $")
	@Localize(locale = "es", value = "\u2211 $")
	static String	EXT_VALUE_TITLE;
	@Localize("The value of all of these pieces of equipment, plus the value of any contained equipment")
	@Localize(locale = "de", value = "Der Wert aller dieser Ausrüstungsgegenstände und der Wert der darin enthaltenen Ausrüstung")
	@Localize(locale = "ru", value = "Цена всего снаряжения, плюс цена любого входящего в него снаряжения")
	@Localize(locale = "es", value = "Valor de todas las piezas del equipo  más el valor de lo que contengan")
	static String	EXT_VALUE_TOOLTIP;
	@Localize("\u2211 W")
	@Localize(locale = "de", value = "\u2211 Gew.")
	@Localize(locale = "es", value = "\u2211 Peso")
	static String	EXT_WEIGHT_TITLE;
	@Localize("The weight of all of these pieces of equipment, plus the weight of any contained equipment")
	@Localize(locale = "de", value = "Das Gewicht aller dieser Ausrüstungsgegenstände und das Gewicht der darin enthaltenen Ausrüstung")
	@Localize(locale = "ru", value = "Вес всего снаряжения, плюс вес любого входящего в него снаряжения")
	@Localize(locale = "es", value = "Peso de todas las piezas del equipo más el peso de lo que contegan")
	static String	EXT_WEIGHT_TOOLTIP;
	@Localize("Category")
	@Localize(locale = "de", value = "Kategorie")
	@Localize(locale = "ru", value = "Категория")
	@Localize(locale = "es", value = "Categoría")
	static String	CATEGORY_TITLE;
	@Localize("The category or categories the equipment belongs to")
	@Localize(locale = "de", value = "Die Kategorie oder Kategorien, denen diese Ausrüstung angehört")
	@Localize(locale = "ru", value = "Категория или категории снаряжения, к которым оно принадлежит")
	@Localize(locale = "es", value = "Categoría o categorías a las que pertenece el equipo")
	static String	CATEGORY_TOOLTIP;
	@Localize("Ref")
	@Localize(locale = "de", value = "Ref.")
	@Localize(locale = "ru", value = "Ссыл")
	@Localize(locale = "es", value = "Ref.")
	static String	REFERENCE_TITLE;
	@Localize("A reference to the book and page this equipment appears on (e.g. B22 would refer to \"Basic Set\", page 22)")
	@Localize(locale = "de", value = "Eine Referenz auf das Buch und die Seite, auf der diese Ausrüstung beschrieben wird (z.B. B22 würde auf \"Basic Set\" Seite 22 verweisen).")
	@Localize(locale = "ru", value = "Ссылка на страницу и книгу, описывающая снаряжение (например B22 - книга \"Базовые правила\", страница 22)")
	@Localize(locale = "es", value = "Referencia al libro y página donde se menciona el equipo (p.e. B22 se refiere al \"Manual Básico\", página 22).")
	static String	REFERENCE_TOOLTIP;

	static {
		Localization.initialize();
	}

	/**
	 * @param character The {@link GURPSCharacter} this equipment list is associated with, or
	 *            <code>null</code>.
	 * @return The header title.
	 */
	public String toString(GURPSCharacter character) {
		return toString();
	}

	/**
	 * @param equipment The {@link Equipment} to get the data from.
	 * @return An object representing the data for this column.
	 */
	public abstract Object getData(Equipment equipment);

	/**
	 * @param equipment The {@link Equipment} to get the data from.
	 * @return Text representing the data for this column.
	 */
	public abstract String getDataAsText(Equipment equipment);

	/** @return The tooltip for the column. */
	public abstract String getToolTip();

	/** @return The {@link Cell} used to display the data. */
	public abstract Cell getCell();

	/**
	 * @param dataFile The {@link DataFile} to use.
	 * @return Whether this column should be displayed for the specified data file.
	 */
	public abstract boolean shouldDisplay(DataFile dataFile);

	/** @return Whether this column should contain the hierarchy controls. */
	@SuppressWarnings("static-method")
	public boolean isHierarchyColumn() {
		return false;
	}

	/**
	 * Adds all relevant {@link Column}s to a {@link Outline}.
	 *
	 * @param outline The {@link Outline} to use.
	 * @param dataFile The {@link DataFile} that data is being displayed for.
	 */
	public static void addColumns(Outline outline, DataFile dataFile) {
		GURPSCharacter character = dataFile instanceof GURPSCharacter ? (GURPSCharacter) dataFile : null;
		boolean sheetOrTemplate = dataFile instanceof GURPSCharacter || dataFile instanceof Template;
		OutlineModel model = outline.getModel();
		for (EquipmentColumn one : values()) {
			if (one.shouldDisplay(dataFile)) {
				Column column = new Column(one.ordinal(), one.toString(character), one.getToolTip(), one.getCell());
				column.setHeaderCell(new ListHeaderCell(sheetOrTemplate));
				model.addColumn(column);
				if (one.isHierarchyColumn()) {
					model.setHierarchyColumn(column);
				}
			}
		}
	}

	public static String getDisplayWeight(WeightValue weight) {
		WeightUnits defaultWeightUnits = SheetPreferences.getWeightUnits();
		if (SheetPreferences.areGurpsMetricRulesUsed()) {
			if (defaultWeightUnits.isMetric()) {
				weight = GURPSCharacter.convertToGurpsMetric(weight);
			} else {
				weight = GURPSCharacter.convertFromGurpsMetric(weight);
			}
		} else {
			weight = new WeightValue(weight, defaultWeightUnits);
		}
		return weight.toString();
	}
}