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.Color;
  import java.awt.Component;
  import java.util.List;
  
  import javax.swing.Icon;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import language.Language;
  import simulator.editmodel.EditModel;
  import simulator.editmodel.FullTextSearch;
  import ui.images.Images;
  import ui.modeleditor.ModelClientData;
  import ui.modeleditor.ModelSequences;
  import ui.modeleditor.ModelSurface;
  import ui.modeleditor.coreelements.ModelElement;
  import ui.modeleditor.coreelements.ModelElementBox;
  import ui.modeleditor.descriptionbuilder.ModelDescriptionBuilder;
  import ui.modeleditor.fastpaint.Shapes;
  
  /**
   * Verbindung von zwei Ventilen verschiedener Tanks
   * @author Alexander Herzog
   * @see ModelElementTank
   */
  public class ModelElementTankFlowBySignal extends ModelElementBox {
  	/**
  	 * Einstellungen zu diesem Fluss
  	 * @see #getFlowData()
  	 */
  	private final ModelElementTankFlowData data;
  
  	/**
  	 * Name des Signals, dass den Fluss auslst
  	 * @see #getSignalName()
  	 * @see #setSignalName(String)
  	 */
  	private String signalName;
  
  	/**
  	 * Konstruktor der Klasse <code>ModelElementTankFlowBySignal</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)
  	 */
  	public ModelElementTankFlowBySignal(final EditModel model, final ModelSurface surface) {
  		super(model,surface,Shapes.ShapeType.SHAPE_ROUNDED_RECTANGLE);
  		data=new ModelElementTankFlowData();
  		signalName="";
  	}
  
  	/**
  	 * Icon, welches im "Element hinzufgen"-Dropdown-Men angezeigt werden soll.
  	 * @return	Icon fr das Dropdown-Men
  	 */
  	@Override
  	public Icon getAddElementIcon() {
  		return Images.MODELEDITOR_ELEMENT_TANK_FLOW_BY_SIGNAL.getIcon();
  	}
  
  	/**
  	 * Tooltip fr den "Element hinzufgen"-Dropdown-Men-Eintrag.
  	 * @return Tooltip fr den "Element hinzufgen"-Dropdown-Meneintrag
  	 */
  	@Override
  	public String getToolTip() {
  		return Language.tr("Surface.TankFlowBySignal.Tooltip");
  	}
  
  	/**
  	 * 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 ModelElementTankFlowBySignal)) return false;
  
  		if (!data.equalsData(((ModelElementTankFlowBySignal)element).data)) return false;
  		if (!signalName.equals(((ModelElementTankFlowBySignal)element).signalName)) 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 ModelElementTankFlowBySignal) {
  			data.setDataFrom(((ModelElementTankFlowBySignal)element).data);
  			signalName=((ModelElementTankFlowBySignal)element).signalName;
  		}
  	}
  
  	/**
  	 * 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 ModelElementTankFlowBySignal clone(final EditModel model, final ModelSurface surface) {
  		final ModelElementTankFlowBySignal element=new ModelElementTankFlowBySignal(model,surface);
  		element.copyDataFrom(this);
  		return element;
  	}
  
  	/**
  	 * Name des Elementtyps fr die Anzeige im Kontextmen
  	 * @return	Name des Elementtyps
  	 */
  	@Override
  	public String getContextMenuElementName() {
  		return Language.tr("Surface.TankFlowBySignal.Name");
  	}
  
  	/**
  	 * 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.TankFlowBySignal.Name");
  	}
  
  	/**
  	 * Vorgabe-Hintergrundfarbe fr die Box
  	 * @see #getTypeDefaultBackgroundColor()
  	 */
  	private static final Color defaultBackgroundColor=new Color(64,127,255);
  
  	/**
  	 * Liefert die Vorgabe-Hintergrundfarbe fr die Box
  	 * @return	Vorgabe-Hintergrundfarbe fr die Box
  	 */
  	@Override
  	public Color getTypeDefaultBackgroundColor() {
  		return defaultBackgroundColor;
  	}
  
  	/**
  	 * Liefert ein <code>Runnable</code>-Objekt zurck, welches aufgerufen werden kann, wenn die Eigenschaften des Elements verndert werden sollen.
  	 * @param owner	bergeordnetes Fenster
  	 * @param readOnly	Wird dieser Parameter auf <code>true</code> gesetzt, so wird die "Ok"-Schaltflche deaktiviert
  	 * @param clientData	Kundendaten-Objekt
  	 * @param sequences	Fertigungsplne-Liste
  	 * @return	<code>Runnable</code>-Objekt zur Einstellung der Eigenschaften oder <code>null</code>, wenn das Element keine Eigenschaften besitzt
  	 */
  	@Override
  	public Runnable getProperties(final Component owner, final boolean readOnly, final ModelClientData clientData, final ModelSequences sequences) {
  		return ()->{
  			new ModelElementTankFlowBySignalDialog(owner,ModelElementTankFlowBySignal.this,readOnly);
  		};
  	}
  
  	/**
  	 * 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.TankFlowBySignal.XML.Root");
  	}
  
  	/**
  	 * 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);
  
  		data.saveToXML(doc,node);
  
  		if (signalName!=null && !signalName.isBlank()) {
  			Element sub;
  			node.appendChild(sub=doc.createElement(Language.trPrimary("Surface.TankFlowBySignal.XML.SignalName")));
  			sub.setTextContent(signalName);
  		}
  	}
  
  	/**
  	 * 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;
  
  		error=data.loadPropertyFromXML(node);
  		if (error!=null) return error;
  
  		if (Language.trAll("Surface.TankFlowBySignal.XML.SignalName",name)) {
  			signalName=content;
  			return null;
  		}
  
  		return null;
  	}
  
  	/**
  	 * Liefert den Namen des Signals, das den Fluss auslst.
  	 * @return	Name des Signals, das den Fluss auslst
  	 */
  	public String getSignalName() {
  		return signalName;
  	}
  
  	/**
  	 * Stellt den Namen des Signals, dass den Fluss auslst, ein.
  	 * @param signalName	Name des Signals, dass den Fluss auslst
  	 */
  	public void setSignalName(final String signalName) {
  		if (signalName==null) this.signalName=""; else this.signalName=signalName;
  	}
  
  	/**
  	 * Liefert die Einstellungen zu diesem Fluss
  	 * @return	Einstellungen zu diesem Fluss
  	 * @see ModelElementTankFlowData
  	 */
  	public ModelElementTankFlowData getFlowData() {
  		return data;
  	}
  
  	/**
  	 * Gibt an, ob Laufzeitdaten zu der Station whrend der Animation ausgegeben werden sollen
  	 * @return Laufzeitdaten zur Station ausgeben
  	 */
  	@Override
  	public boolean showAnimationRunData() {
  		return false;
  	}
  
  	@Override
  	public String getHelpPageName() {
  		return "ModelElementTankFlowBySignal";
  	}
  
  	/**
  	 * Erstellt eine Beschreibung fr das aktuelle Element
  	 * @param descriptionBuilder	Description-Builder, der die Beschreibungsdaten zusammenfasst
  	 */
  	@Override
  	public void buildDescription(final ModelDescriptionBuilder descriptionBuilder) {
  		super.buildDescription(descriptionBuilder);
  		if (signalName!=null && !signalName.isBlank()) descriptionBuilder.addProperty(Language.tr("ModelDescription.TankFlowBySignal.SignalName"),signalName,1000);
  		data.buildDescription(descriptionBuilder,2000);
  	}
  
  	@Override
  	public boolean setReferenceEdges(List<ModelElementEdge> connectionsIn, List<ModelElementEdge> connectionsOut) {
  		if (connectionsIn.size()>0) return false;
  		if (connectionsOut.size()>0) return false;
  
  		return false;
  	}
  
  	@Override
  	public void search(final FullTextSearch searcher) {
  		super.search(searcher);
  
  		data.search(searcher,this);
  
  		searcher.testString(this,Language.tr("Editor.DialogBase.Search.SignalToStartFlow"),signalName,newSignalName->{signalName=newSignalName;});
  	}
  }