content: /**
   * Copyright 2020 Alexander Herzog
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package ui.modeleditor.elements;
  
  import java.awt.event.ActionEvent;
  import java.awt.event.ActionListener;
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.swing.Icon;
  import javax.swing.table.TableCellEditor;
  
  import language.Language;
  import simulator.editmodel.EditModel;
  import systemtools.BaseDialog;
  import tools.JTableExt;
  import tools.JTableExtAbstractTableModel;
  import ui.images.Images;
  import ui.modeleditor.ModelSurface;
  
  /**
   * Diese Tabelle erlaubt die Konfiguration der in einem
   * {@link ModelElementUserStatistic}-Element zu erfassenden
   * Kenngren.
   * @author Alexander Herzog
   * @see ModelElementUserStatistic
   * @see ModelElementUserStatisticDialog
   */
  public class UserStatisticTableModel extends JTableExtAbstractTableModel {
  	/**
  	 * Serialisierungs-ID der Klasse
  	 * @see Serializable
  	 */
  	private static final long serialVersionUID = -5314140428056671403L;
  
  	/** Hilfe-Callback */
  	private final Runnable help;
  	/** Nur-Lese-Status */
  	private final boolean readOnly;
  	/** ID der aktuellen Station */
  	private final int id;
  	/** Bezeichner fr die Kenngren */
  	private final List<String> keys;
  	/** Handelt es sich jeweils um Zeitangaben (<code>true</code>) oder Zahlen (<code>false</code>) */
  	private final List<Boolean> isTime;
  	/** Zu erfassende Kenngren-Ausdrcke */
  	private final List<String> expressions;
  	/** Handelt es sich jeweils um diskrete Werte (<code>false</code>) oder eine kontinuierliche Erfassung (<code>true</code>) */
  	private final List<Boolean> isContinuous;
  	/** Gesamtes Modell (fr den Expression-Builder) */
  	private final EditModel model;
  	/** Haupt-Zeichenflche (fr den Expression-Builder) */
  	private final ModelSurface surface;
  	/** Zugehrige Tabelle (um das Update der Tabelle veranlassen zu knnen, wenn sich die Daten verndert haben) */
  	private final JTableExt table;
  
  	/**
  	 * Konstruktor der Klasse
  	 * @param table	Zugehrige Tabelle (um das Update der Tabelle veranlassen zu knnen, wenn sich die Daten verndert haben)
  	 * @param help	Hilfe-Callback
  	 * @param id	ID der aktuellen Station
  	 * @param keys	Bezeichner fr die Kenngren
  	 * @param isTime	Handelt es sich jeweils im Zeitangaben (<code>true</code>) oder Zahlen (<code>false</code>)?
  	 * @param expressions	Zu erfassende Kenngren-Ausdrcke
  	 * @param isContinuous	Handelt es sich jeweils um diskrete Werte (<code>false</code>) oder eine kontinuierliche Erfassung (<code>true</code>)?
  	 * @param model	Gesamtes Modell (fr den Expression-Builder)
  	 * @param surface	Haupt-Zeichenflche (fr den Expression-Builder)
  	 * @param readOnly	Nur-Lese-Status
  	 */
  	public UserStatisticTableModel(final JTableExt table, final Runnable help, final int id, final List<String> keys, final List<Boolean> isTime, final List<String> expressions, final List<Boolean> isContinuous, final EditModel model, final ModelSurface surface, final boolean readOnly) {
  		super();
  		this.help=help;
  		this.readOnly=readOnly;
  		this.table=table;
  		this.id=id;
  		this.keys=new ArrayList<>(); this.keys.addAll(keys);
  		this.isTime=new ArrayList<>(); this.isTime.addAll(isTime);
  		this.expressions=new ArrayList<>(); this.expressions.addAll(expressions);
  		this.isContinuous=new ArrayList<>(); this.isContinuous.addAll(isContinuous);
  		this.model=model;
  		this.surface=surface;
  		updateTable();
  	}
  
  	/**
  	 * Liefert die neue Liste mit den Bezeichnern fr die Kenngren.
  	 * @return	Neue Liste mit den Bezeichnern fr die Kenngren
  	 */
  	public List<String> getKeys() {
  		return keys;
  	}
  
  	/**
  	 * Liefert die Informationen ob es sich bei den Kenngren um Zeitangaben oder um Zahlen handelt.
  	 * @return	Neue Liste mit den Informationen ob es sich bei den Kenngren um Zeitangaben (<code>true</code>) oder um Zahlen (<code>false</code>) handelt
  	 */
  	public List<Boolean> getIsTime() {
  		return isTime;
  	}
  
  	/**
  	 * Liefert die Informationen ob es sich bei den Kenngren um diskrete Werte (<code>false</code>) oder eine kontinuierliche Erfassung (<code>true</code>) handelt
  	 * @return	Neue Liste mit den Informationen ob es sich bei den Kenngren um diskrete Werte (<code>false</code>) oder eine kontinuierliche Erfassung (<code>true</code>) handelt
  	 */
  	public List<Boolean> getIsContinuous() {
  		return isContinuous;
  	}
  
  	/**
  	 * Liefert die neue Liste mit den Rechenausdrcken zur Erhebung der Kenngren.
  	 * @return	Neue Liste mit den Rechenausdrcken zur Erhebung der Kenngren
  	 */
  	public List<String> getExpressions() {
  		return expressions;
  	}
  
  	/**
  	 * Aktualisiert die Tabellendarstellung
  	 */
  	private void updateTable() {
  		fireTableDataChanged();
  		TableCellEditor cellEditor=table.getCellEditor();
  		if (cellEditor!=null) cellEditor.stopCellEditing();
  	}
  
  	@Override
  	public int getRowCount() {
  		return keys.size()+1;
  	}
  
  	@Override
  	public int getColumnCount() {
  		return 2;
  	}
  
  	@Override
  	public Object getValueAt(final int rowIndex, final int columnIndex) {
  		if (rowIndex==keys.size()) {
  			switch (columnIndex) {
  			case 0: return "";
  			case 1:	return makeButtonPanel(new String[]{Language.tr("Surface.UserStatistic.Table.Add")},new Icon[]{Images.EDIT_ADD.getIcon()},new ActionListener[]{new TableButtonListener(ActionIndex.ACTION_ADD)});
  			}
  		}
  
  		switch (columnIndex) {
  		case 0:
  			return makePanelIcon(keys.get(rowIndex),Images.MODELEDITOR_ELEMENT_USER_STATISTICS.getIcon());
  		case 1:
  			final List<Icon> icons=new ArrayList<>();
  			final List<String> hints=new ArrayList<>();
  			final List<ActionListener> listeners=new ArrayList<>();
  			icons.add(Images.GENERAL_SETUP.getIcon());
  			hints.add(Language.tr("Surface.UserStatistic.Table.Edit"));
  			listeners.add(new TableButtonListener(rowIndex,ActionIndex.ACTION_EDIT));
  			icons.add(Images.EDIT_DELETE.getIcon());
  			hints.add(Language.tr("Surface.UserStatistic.Table.Delete"));
  			listeners.add(new TableButtonListener(rowIndex,ActionIndex.ACTION_DELETE));
  			if (rowIndex>0) {
  				icons.add(Images.ARROW_UP.getIcon());
  				hints.add(Language.tr("Surface.UserStatistic.Table.MoveUp"));
  				listeners.add(new TableButtonListener(rowIndex,ActionIndex.ACTION_UP));
  			}
  			if (rowIndex<keys.size()-1) {
  				icons.add(Images.ARROW_DOWN.getIcon());
  				hints.add(Language.tr("Surface.UserStatistic.Table.MoveDown"));
  				listeners.add(new TableButtonListener(rowIndex,ActionIndex.ACTION_DOWN));
  			}
  			return makeEditPanelSmallBorder(expressions.get(rowIndex),icons.toArray(Icon[]::new),hints.toArray(String[]::new),listeners.toArray(ActionListener[]::new));
  		}
  		return null;
  	}
  
  	@Override
  	public final boolean isCellEditable(int rowIndex, int columnIndex) {
  		return !readOnly;
  	}
  
  	@Override
  	public String getColumnName(int column) {
  		switch (column) {
  		case 0: return Language.tr("Surface.UserStatistic.Table.HeaderKey");
  		case 1: return Language.tr("Surface.UserStatistic.Table.HeaderExpression");
  		default: return super.getColumnName(column);
  		}
  	}
  
  	/**
  	 * Stellt dasselbe Format bei allen Schlssel eines Namens (in dieser Tabelle) identisch ein
  	 * @param key	Name des Schlssels
  	 * @param isTime	Neues Format
  	 * @param isContinuous	Handelt es sich jeweils um diskrete Werte (<code>false</code>) oder eine kontinuierliche Erfassung (<code>true</code>)?
  	 */
  	private void updateFormats(final String key, final boolean isTime, final boolean isContinuous) {
  		for (int i=0;i<keys.size();i++) if (keys.get(i).equals(key)) {
  			this.isTime.set(i,isTime);
  			this.isContinuous.set(i,isContinuous);
  		}
  	}
  
  	/**
  	 * Im {@link TableButtonListener} auszufhrende Aktion.
  	 * @see	TableButtonListener
  	 */
  	private enum ActionIndex {
  		/** Eintrag hinzufgen */
  		ACTION_ADD,
  		/** Eintrag in der Liste nach oben verschieben */
  		ACTION_UP,
  		/** Eintrag in der Liste nach unten verschieben */
  		ACTION_DOWN,
  		/** Eintrag lschen */
  		ACTION_DELETE,
  		/** Eintrag bearbeiten */
  		ACTION_EDIT
  	}
  
  	/**
  	 * Reagiert auf Klicks auf die Schaltflchen in den Tabellenzellen
  	 */
  	private class TableButtonListener implements ActionListener {
  		/** Zeile */
  		final int row;
  		/** Auszufhrende Aktion */
  		final ActionIndex actionIndex;
  
  		/**
  		 * Konstruktor der Klasse
  		 * @param row	Zeile
  		 * @param actionIndex	Auszufhrende Aktion
  		 */
  		public TableButtonListener(final int row, final ActionIndex actionIndex) {
  			this.row=row;
  			this.actionIndex=actionIndex;
  		}
  
  		/**
  		 * Konstruktor der Klasse<br>
  		 * Als Zeilenindex wird 0 angenommen.
  		 * @param actionIndex	Auszufhrende Aktion
  		 */
  		public TableButtonListener(final ActionIndex actionIndex) {
  			this(0,actionIndex);
  		}
  
  		@Override
  		public void actionPerformed(ActionEvent e) {
  			if (readOnly) return;
  			UserStatisticTableModelDialog dialog;
  			String s;
  			boolean b;
  			switch (actionIndex) {
  			case ACTION_ADD:
  				dialog=new UserStatisticTableModelDialog(table,help,id,"",true,"",false,model,surface);
  				if (dialog.getClosedBy()==BaseDialog.CLOSED_BY_OK) {
  					keys.add(dialog.getKey());
  					isTime.add(dialog.getIsTime());
  					expressions.add(dialog.getExpression());
  					isContinuous.add(dialog.getIsContinuous());
  					updateFormats(dialog.getKey(),dialog.getIsTime(),dialog.getIsContinuous());
  					updateTable();
  				}
  				break;
  			case ACTION_UP:
  				if (row>0) {
  					s=keys.get(row-1);
  					keys.set(row-1,keys.get(row));
  					keys.set(row,s);
  					b=isTime.get(row-1);
  					isTime.set(row-1,isTime.get(row));
  					isTime.set(row,b);
  					s=expressions.get(row-1);
  					expressions.set(row-1,expressions.get(row));
  					expressions.set(row,s);
  				}
  				updateTable();
  				break;
  			case ACTION_DOWN:
  				if (row<keys.size()-1) {
  					s=keys.get(row+1);
  					keys.set(row+1,keys.get(row));
  					keys.set(row,s);
  					b=isTime.get(row+1);
  					isTime.set(row+1,isTime.get(row));
  					isTime.set(row,b);
  					s=expressions.get(row+1);
  					expressions.set(row+1,expressions.get(row));
  					expressions.set(row,s);
  				}
  				updateTable();
  				break;
  			case ACTION_DELETE:
  				keys.remove(row);
  				isTime.remove(row);
  				expressions.remove(row);
  				updateTable();
  				break;
  			case ACTION_EDIT:
  				dialog=new UserStatisticTableModelDialog(table,help,id,keys.get(row),isTime.get(row),expressions.get(row),isContinuous.get(row),model,surface);
  				if (dialog.getClosedBy()==BaseDialog.CLOSED_BY_OK) {
  					keys.set(row,dialog.getKey());
  					isTime.set(row,dialog.getIsTime());
  					expressions.set(row,dialog.getExpression());
  					isContinuous.set(row,dialog.getIsContinuous());
  					updateFormats(dialog.getKey(),dialog.getIsTime(),dialog.getIsContinuous());
  					updateTable();
  				}
  				break;
  			}
  		}
  	}
  }
  