TheCloud/Digital
1
0
Fork 0
mirror of https://github.com/hneemann/Digital.git synced 2025-09-28 07:28:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

Removed the creation of the detailed description to the ElementHelpDialog.

Browse Source 
The ElementTypeDescription should not contain the code to create various descriptions.
It only has to provide the information needed to create the description.
This commit is contained in:
hneemann 2016-10-29 17:46:48 +02:00
parent 841b5dd759
commit aadc975ecb
2 changed files with 59 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
src/main/java/de/neemann/digital/core/element/ElementTypeDescription.java
View File

@ -200,55 +200,4 @@ public class ElementTypeDescription {
return elementFactory.create(elementAttributes);
}
/**
* Creates a detailed human readable description of this element
*
* @param elementAttributes the actual attributes of the element to describe
* @return the human readable description of this element
*/
public String getDetailedDescription(ElementAttributes elementAttributes) {
StringBuilder sb = new StringBuilder();
sb.append(getTranslatedName()).append("\n");
String descr = getDescription(elementAttributes);
if (!descr.equals(getTranslatedName()))
sb.append("\n").append(StringUtils.breakLines(getDescription(elementAttributes))).append("\n");
try {
PinDescriptions inputs = getInputDescription(elementAttributes);
sb.append("\n").append(Lang.get("elem_Help_inputs")).append(":\n");
if (inputs != null && inputs.size() > 0) {
for (PinDescription i : inputs)
appendNameAndDescription(sb, i.getName(), i.getDescription());
} else {
sb.append(" -\n");
}
} catch (NodeException e) {
e.printStackTrace();
}
PinDescriptions outputs = getOutputDescriptions(elementAttributes);
sb.append("\n").append(Lang.get("elem_Help_outputs")).append(":\n");
if (outputs != null && outputs.size() > 0) {
for (PinDescription i : outputs)
appendNameAndDescription(sb, i.getName(), i.getDescription());
} else {
sb.append(" -\n");
}
if (attributeList.size() > 0) {
sb.append("\n").append(Lang.get("elem_Help_attributes")).append(":\n");
for (Key k : attributeList) {
appendNameAndDescription(sb, k.getName(), k.getDescription());
}
}
return sb.toString();
}
private static void appendNameAndDescription(StringBuilder sb, String name, String description) {
sb.append(" ").append(name);
if (!name.equals(description))
sb.append(": ").append(description);
sb.append("\n");
}
}

62
src/main/java/de/neemann/digital/gui/components/ElementHelpDialog.java
View File

@ -1,8 +1,9 @@
package de.neemann.digital.gui.components;
import de.neemann.digital.core.element.ElementAttributes;
import de.neemann.digital.core.element.ElementTypeDescription;
import de.neemann.digital.core.NodeException;
import de.neemann.digital.core.element.*;
import de.neemann.digital.lang.Lang;
import de.neemann.gui.StringUtils;
import javax.swing.*;
import java.awt.*;
@ -29,7 +30,7 @@ public class ElementHelpDialog extends JDialog {
super(parent, Lang.get("attr_help"), true);
setDefaultCloseOperation(DISPOSE_ON_CLOSE);
final String description = elementType.getDetailedDescription(elementAttributes);
final String description = getDetailedDescription(elementType, elementAttributes);
JTextArea textfield = new JTextArea(description);
textfield.setEditable(false);
textfield.setBorder(BorderFactory.createEmptyBorder(6, 6, 6, 6));
@ -51,4 +52,59 @@ public class ElementHelpDialog extends JDialog {
setSize(r);
setLocationRelativeTo(parent);
}
/**
* Creates a detailed human readable description of this element
*
*
* @param et the element to describe
* @param elementAttributes the actual attributes of the element to describe
* @return the human readable description of this element
*/
private String getDetailedDescription(ElementTypeDescription et, ElementAttributes elementAttributes) {
StringBuilder sb = new StringBuilder();
sb.append(et.getTranslatedName()).append("\n");
String descr = et.getDescription(elementAttributes);
if (!descr.equals(et.getTranslatedName()))
sb.append("\n").append(StringUtils.breakLines(et.getDescription(elementAttributes))).append("\n");
try {
PinDescriptions inputs = et.getInputDescription(elementAttributes);
sb.append("\n").append(Lang.get("elem_Help_inputs")).append(":\n");
if (inputs != null && inputs.size() > 0) {
for (PinDescription i : inputs)
appendNameAndDescription(sb, i.getName(), i.getDescription());
} else {
sb.append(" -\n");
}
} catch (NodeException e) {
e.printStackTrace();
}
PinDescriptions outputs = et.getOutputDescriptions(elementAttributes);
sb.append("\n").append(Lang.get("elem_Help_outputs")).append(":\n");
if (outputs != null && outputs.size() > 0) {
for (PinDescription i : outputs)
appendNameAndDescription(sb, i.getName(), i.getDescription());
} else {
sb.append(" -\n");
}
if (et.getAttributeList().size() > 0) {
sb.append("\n").append(Lang.get("elem_Help_attributes")).append(":\n");
for (Key k : et.getAttributeList()) {
appendNameAndDescription(sb, k.getName(), k.getDescription());
}
}
return sb.toString();
}
private static void appendNameAndDescription(StringBuilder sb, String name, String description) {
sb.append(" ").append(name);
if (!name.equals(description))
sb.append(": ").append(description);
sb.append("\n");
}
}