Help.java

gehe zur Dokumentation dieser Datei

package de.lathanda.eos.config;
 
import java.text.MessageFormat;
import java.util.Collection;
import java.util.TreeMap;
 
public class Help {
    private TreeMap<String, HelpPage> pages = new TreeMap<>();
    public Help(String id, String label, String tooltip, String description, Collection<LangModule> modules, TreeMap<String, LangClass> classes, Collection<LangHelp> helpEntries) {
        HelpPage page = new HelpPage();
        page.id      = id;
        page.pid     = null;
        page.title   = label;
        page.tooltip = tooltip;
        page.html    = MessageFormat.format(BODY,  label, description);
        pages.put(page.id,  page);
        for(LangModule lm: modules) {
            HelpPage pagem = new HelpPage();
            pagem.id      = lm.id;
            pagem.title   = lm.label;
            pagem.tooltip = lm.tooltip;
            pagem.pid     = id;
            pagem.html    = MessageFormat.format(BODY,  lm.label, lm.description);
            pages.put(pagem.id,  pagem);
        }
        for (LangHelp lh: helpEntries) {
            HelpPage pageh = new HelpPage();
            pageh.id      = lh.id;
            pageh.title   = lh.title;
            pageh.tooltip = lh.tooltip;
            pageh.pid     = lh.pid;
            pageh.html    = MessageFormat.format(BODY,  lh.title, lh.description);
            pages.put(pageh.id,  pageh);
            
        }
        for (LangClass lc : classes.values()) {
            HelpPage pagec = new HelpPage();
            pagec.id = lc.id;
            pagec.pid = id;
            pagec.title = lc.label;
            pagec.tooltip = lc.tooltip;
            StringBuilder usage= new StringBuilder();
            for (LangClass lcu : classes.values()) {
                for(LangMethod lm:lcu.methods.values()) {
                    if (lm.uses(lc.id)) {
                        usage.append(MessageFormat.format(USAGE, lcu.id, lm.getFullSignature()));
                    }
                    
                }
                for(LangProperty lp:lcu.properties.values()) {
                    if (lp.uses(lc.id)) {
                        usage.append(MessageFormat.format(USAGE, lcu.id, lp.getFullSignature()));
                    }                   
                }
            }
            String pcls = lc.pid;
            StringBuilder inherited = new StringBuilder();
            while (lc.pid != null && !lc.pid.isEmpty()) {
                if (!inherited.isEmpty()) {
                    inherited.append(", ");
                }
                inherited.append(MessageFormat.format(LINK, pcls, classes.get(pcls).label));                
            }
            StringBuilder methods = new StringBuilder();
            for(LangMethod lm:lc.methods.values()) {
                methods.append(MessageFormat.format(METHOD,lm.getFullSignature(), lm.description));
                for(LangParameter lpa:lm.parameters) {
                    methods.append(MessageFormat.format(PARAMETER, lpa.name, lpa.type, classes.get(lpa.type).label, lpa.description));
                }
            }
            StringBuilder properties = new StringBuilder();
            for(LangProperty lp:lc.properties.values()) {
                properties.append(MessageFormat.format(PROPERTY, lp.label, lp.type, classes.get(lp.type).label, lp.description));
            }
            pagec.html = MessageFormat.format(CLASS_BODY, 
                lc.label, 
                MessageFormat.format(INHERITED, inherited), 
                lc.description, 
                MessageFormat.format(METHODS, methods), 
                MessageFormat.format(PROPERTIES, properties), 
                MessageFormat.format(USAGES, lc.label, usage.toString())
            );
            
        }
        
    }
    public TreeMap<String, HelpPage> getHelpPages() {
        return pages;
    }
    public HelpPage getHelpPage(String id) {
        return pages.get(id);
    }
    public static class HelpPage {
        public String html;
        public String tooltip;
        public String id;
        public String title;
        public String pid;      
    }
    private final static String BODY          = "<html><head>{0}</head><body><h1>{0}</h1>{1}</body></html>";
    private final static String CLASS_BODY    = "<html><head>{0}</head><body><h1>{0}</h1>{1}{2}{3}{4}</body></html>";
    private final static String INHERITED     = "<p>Die Klasse {0} besitzt alle Methoden und Attribute der Klassen {1}.</p>";
    private final static String USAGES        = "<p>{0} wird verwendet von </p><p><ul>{1}</ul></p>";
    private final static String METHODS       = "<h2>Methoden</h2><p>{0}</p>";
    private final static String METHOD        = "<h3>{0}</h3><p>{1}</p>";
    private final static String PARAMETER     = "<h4>{0}:<a href=\"{1}\">{2}</a></h4><p>{3}</p>";
    private final static String PROPERTIES    = "<h2>Attribute</h2><p>{0}</p>";
    private final static String PROPERTY      = "<h3>{0}:<a href=\"{1}\">{2}</a></h3><p>{3}</p>";
    private final static String USAGE         = "<li><a href=\"{0}\">{1}</a></li>";
    private final static String LINK          = "<a href=\"{0}\">{1}</a>"; 
}