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 javax.swing.Icon;
  import javax.swing.JMenuItem;
  import javax.swing.JPopupMenu;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import language.Language;
  import mathtools.NumberTools;
  import simulator.editmodel.EditModel;
  import ui.images.Images;
  import ui.modeleditor.ModelSurface;
  import ui.modeleditor.coreelements.ModelElement;
  import ui.modeleditor.coreelements.ModelElementEdgeOut;
  
  /**
   * Diese Klasse stellt einen Eingang in ein Submodell dar.
   * @author Alexander Herzog
   * @see ModelElementSub
   */
  public class ModelElementSubIn extends ModelElementSubConnect implements ModelElementEdgeOut {
  	/**
  	 * Auslaufende Kante
  	 */
  	private ModelElementEdge connectionOut;
  
  	/** ID der auflaufenden Kante (Wird nur beim Laden und Clonen verwendet.) */
  	private int connectionOutId=-1;
  
  	/**
  	 * Konstruktor der Klasse <code>ModelElementSubConnect</code>
  	 * @param model	Modell zu dem dieses Element gehren soll (kann spter nicht mehr gendert werden)
  	 * @param surface	Zeichenflche zu dem dieses Element gehren soll (kann spter nicht mehr gendert werden)
  	 * @param connectionNr	0-basierende Nummer des Ein- bzw. Ausgangs
  	 * @param connectionStationID ID des Elements, mit dem diese Station auf der hheren Ebene verbunden sein soll
  	 */
  	public ModelElementSubIn(final EditModel model, final ModelSurface surface, int connectionNr, int connectionStationID) {
  		super(model,surface,connectionNr,connectionStationID);
  		if (connectionStationID<0) setName(Language.tr("Surface.SubConnect.NotConnected")); else setName(Language.tr("Surface.SubConnect.FromID")+"="+connectionStationID);
  	}
  
  	/**
  	 * Stellt die anzuzeigenden Daten bzgl. der Verknpfung an
  	 * @param connectionNr	0-basierende Nummer des Ein- bzw. Ausgangs
  	 * @param connectionStationID ID des Elements, mit dem diese Station auf der hheren Ebene verbunden sein soll
  	 */
  	@Override
  	public void setConnectionData(int connectionNr, int connectionStationID) {
  		super.setConnectionData(connectionNr,connectionStationID);
  		if (connectionStationID<0) setName(Language.tr("Surface.SubConnect.NotConnected")); else setName(Language.tr("Surface.SubConnect.FromID")+"="+connectionStationID);
  	}
  
  	@Override
  	public void updateName() {
  		if (connectionStationID<0) setName(Language.tr("Surface.SubConnect.NotConnected")); else setName(Language.tr("Surface.SubConnect.FromID")+"="+connectionStationID);
  	}
  
  	/**
  	 * berprft, ob das Element mit dem angegebenen Element inhaltlich identisch ist.
  	 * @param element	Element mit dem dieses Element verglichen werden soll.
  	 * @return	Gibt <code>true</code> zurck, wenn die beiden Elemente identisch sind.
  	 */
  	@Override
  	public boolean equalsModelElement(ModelElement element) {
  		if (!super.equalsModelElement(element)) return false;
  		if (!(element instanceof ModelElementSubIn)) return false;
  
  		if (connectionOut==null) {
  			if (((ModelElementSubIn)element).connectionOut!=null) return false;
  		} else {
  			if (((ModelElementSubIn)element).connectionOut==null) return false;
  			if (connectionOut.getId()!=((ModelElementSubIn)element).connectionOut.getId()) return false;
  		}
  
  		return true;
  	}
  
  	/**
  	 * bertrgt die Einstellungen von dem angegebenen Element auf dieses.
  	 * @param element	Element, von dem alle Einstellungen bernommen werden sollen
  	 */
  	@Override
  	public void copyDataFrom(ModelElement element) {
  		super.copyDataFrom(element);
  		if (element instanceof ModelElementSubIn) {
  			if (((ModelElementSubIn)element).connectionOut!=null) connectionOutId=((ModelElementSubIn)element).connectionOut.getId();
  			if (connectionStationID<0) setName(Language.tr("Surface.SubConnect.NotConnected")); else setName(Language.tr("Surface.SubConnect.FromID")+"="+connectionStationID);
  		}
  	}
  
  	/**
  	 * Erstellt eine Kopie des Elements
  	 * @param model	Modell zu dem das kopierte Element gehren soll.
  	 * @param surface	Zeichenflche zu der das kopierte Element gehren soll.
  	 * @return	Kopiertes Element
  	 */
  	@Override
  	public ModelElementSubIn clone(final EditModel model, final ModelSurface surface) {
  		final ModelElementSubIn element=new ModelElementSubIn(model,surface,connectionNr,connectionStationID);
  		element.copyDataFrom(this);
  		return element;
  	}
  
  	/**
  	 * Optionale Initialisierungen nach dem Laden bzw. Clonen.
  	 */
  	@Override
  	public void initAfterLoadOrClone() {
  		super.initAfterLoadOrClone();
  
  		ModelElement element;
  		if (connectionOutId>=0) {
  			element=surface.getById(connectionOutId);
  			if (element instanceof ModelElementEdge) connectionOut=(ModelElementEdge)element;
  			connectionOutId=-1;
  		}
  	}
  
  	/**
  	 * Tooltip fr den "Element hinzufgen"-Dropdown-Men-Eintrag.
  	 * @return Tooltip fr den "Element hinzufgen"-Dropdown-Meneintrag
  	 */
  	@Override
  	public String getToolTip() {
  		return Language.tr("Surface.SubConnect.Input")+" "+(connectionNr+1)+ " ("+((connectionStationID>=0)?(Language.tr("Surface.SubConnect.FromID.Small")+"="+connectionStationID):Language.tr("Surface.SubConnect.NotConnected"))+")";
  	}
  
  	/**
  	 * Name des Elementtyps fr die Anzeige im Kontextmen
  	 * @return	Name des Elementtyps
  	 */
  	@Override
  	public String getContextMenuElementName() {
  		return Language.tr("Surface.SubConnect.Input")+" "+(connectionNr+1)+ " ("+((connectionStationID>=0)?(Language.tr("Surface.SubConnect.FromID.Small")+"="+connectionStationID):Language.tr("Surface.SubConnect.NotConnected"))+")";
  	}
  
  	/**
  	 * Liefert die Bezeichnung des Typs des Elemente (zur Anzeige in der Element-Box)
  	 * @return	Name des Typs
  	 */
  	@Override
  	public String getTypeName() {
  		return Language.tr("Surface.SubConnect.Input")+" "+(connectionNr+1);
  	}
  
  	/**
  	 * Fgt Menpunkte zum Hinzufgen von einlaufenden und auslaufender Kante zum Kontextmen
  	 * @param popupMenu	Kontextmen zu dem die Eintrge hinzugefgt werden sollen
  	 * @param readOnly	Wird dieser Parameter auf <code>true</code> gesetzt, so knnen ber das Kontextmen keine nderungen an dem Modell vorgenommen werden
  	 * @return	Gibt <code>true</code> zurck, wenn Elemente in das Kontextmen eingefgt wurden (und ggf. ein Separator vor dem nchsten Abschnitt gesetzt werden sollte)
  	 */
  	@Override
  	protected final boolean addRemoveEdgesContextMenuItems(final JPopupMenu popupMenu, final boolean readOnly) {
  		JMenuItem item;
  		final Icon icon=Images.EDIT_EDGES_DELETE.getIcon();
  
  		if (connectionOut!=null) {
  			popupMenu.add(item=new JMenuItem(Language.tr("Surface.PopupMenu.RemoveEdgeOut")));
  			item.addActionListener(e->surface.remove(connectionOut));
  			if (icon!=null) item.setIcon(icon);
  			item.setEnabled(!readOnly);
  		}
  
  		return false;
  	}
  
  	/**
  	 * Benachrichtigt das Element, dass es aus der Surface-Liste ausgetragen wurde.
  	 */
  	@Override
  	public void removeNotify() {
  		if (connectionOut!=null) surface.remove(connectionOut);
  	}
  
  	/**
  	 * Benachrichtigt das Element, dass ein mit ihm in Verbindung stehendes Element entfernt wurde.
  	 */
  	@Override
  	public void removeConnectionNotify(final ModelElement element) {
  		if (connectionOut==element) {connectionOut=null; fireChanged();}
  	}
  
  
  	/**
  	 * Liefert den jeweiligen xml-Element-Namen fr das Modell-Element
  	 * @return	xml-Element-Namen, der diesem Modell-Element zugeordnet werden soll
  	 */
  	@Override
  	public String[] getXMLNodeNames() {
  		return Language.trAll("Surface.SubConnect.XML.Input");
  	}
  
  	/**
  	 * Speichert die Eigenschaften des Modell-Elements als Untereintrge eines xml-Knotens
  	 * @param doc	bergeordnetes xml-Dokument
  	 * @param node	bergeordneter xml-Knoten, in dessen Kindelementen die Daten des Objekts gespeichert werden sollen
  	 */
  	@Override
  	protected void addPropertiesDataToXML(final Document doc, final Element node) {
  		super.addPropertiesDataToXML(doc,node);
  
  		Element sub;
  
  		if (connectionOut!=null) {
  			node.appendChild(sub=doc.createElement(Language.trPrimary("Surface.XML.Connection")));
  			sub.setAttribute(Language.trPrimary("Surface.XML.Connection.Element"),""+connectionOut.getId());
  			sub.setAttribute(Language.trPrimary("Surface.XML.Connection.Type"),Language.trPrimary("Surface.XML.Connection.Type.Out"));
  		}
  	}
  
  	/**
  	 * Ldt eine einzelne Einstellung des Modell-Elements aus einem einzelnen xml-Element.
  	 * @param name	Name des xml-Elements
  	 * @param content	Inhalt des xml-Elements als Text
  	 * @param node	xml-Element, aus dem das Datum geladen werden soll
  	 * @return	Tritt ein Fehler auf, so wird die Fehlermeldung als String zurckgegeben. Im Erfolgsfall wird <code>null</code> zurckgegeben.
  	 */
  	@Override
  	protected String loadProperty(final String name, final String content, final Element node) {
  		String error=super.loadProperty(name,content,node);
  		if (error!=null) return error;
  
  		if (Language.trAll("Surface.XML.Connection",name)) {
  			final Integer I=NumberTools.getNotNegativeInteger(Language.trAllAttribute("Surface.XML.Connection.Element",node));
  			if (I==null) return String.format(Language.tr("Surface.XML.AttributeSubError"),Language.trPrimary("Surface.XML.Connection.Element"),name,node.getParentNode().getNodeName());
  			final String s=Language.trAllAttribute("Surface.XML.Connection.Type",node);
  			if (Language.trAll("Surface.XML.Connection.Type.Out",s)) {
  				connectionOutId=I;
  			}
  			return null;
  		}
  
  		return null;
  	}
  
  	/**
  	 * Gibt an, ob das Element momentan eine (weitere) auslaufende Kante annehmen kann.
  	 * @return	Gibt <code>true</code> zurck, wenn eine (weitere) auslaufende Kante angenommen werden kann.
  	 */
  	@Override
  	public boolean canAddEdgeOut() {
  		return connectionOut==null;
  	}
  
  	/**
  	 * Fgt eine auslaufende Kante hinzu.
  	 * @param edge	Hinzuzufgende Kante
  	 * @return	Gibt <code>true</code> zurck, wenn die auslaufende Kante hinzugefgt werden konnte.
  	 */
  	@Override
  	public boolean addEdgeOut(ModelElementEdge edge) {
  		if (connectionOut!=null) return false;
  		if (edge==null) return false;
  		connectionOut=edge;
  		connectionOutId=-1;
  		fireChanged();
  		return true;
  	}
  
  	/**
  	 * Auslaufende Kante
  	 * @return	Auslaufende Kante
  	 */
  	@Override
  	public ModelElementEdge getEdgeOut() {
  		return connectionOut;
  	}
  }
  