com.zavtech.morpheus.viz.html.HtmlCode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of morpheus-viz Show documentation
Visualization components for the Morpheus data science library
The newest version!
/**
 * Copyright (C) 2014-2017 Xavier Witdouck
 *
 * 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 com.zavtech.morpheus.viz.html;

import java.awt.*;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.function.Consumer;

import com.zavtech.morpheus.util.IO;

/**
 * A convenience API for programmatically creating simple HTML pages in the absence of a template engine such as Freemarker.
 *
 * @author Xavier Witdouck
 *
 * This is open source software released under the Apache 2.0 License
 */
public class HtmlCode {

    private String indent = "";
    private StringBuilder html = new StringBuilder();

    /**
     * Constructor
     */
    public HtmlCode() {
        super();
    }

    /**
     * Convenience method to generate an HTML string given a writer
     * @param consumer  the consumer to call on the writer
     * @return          the resulting html string
     */
    public static String createHtml(Consumer consumer) {
        final HtmlCode writer = new HtmlCode();
        consumer.accept(writer);
        return writer.toString().trim();
    }


    /**
     * Increases the indentation for the current line by a certain number of spaces
     * @param count     the number of spaces to indent by
     * @return          this writer
     */
    public HtmlCode indent(int count) {
        final StringBuilder indentation = new StringBuilder(indent);
        for (int i=0; i consumer) {
        final HtmlElement element = new HtmlElement(name, this);
        consumer.accept(element);
        element.close();
        return this;
    }

    /**
     * Flushes the contents of the buffer to a file
     * @param file      the file to flush the HTML buffer to
     * @throws IOException  if there is an IO Exception
     */
    public void flush(File file) throws IOException {
        try (BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(file))) {
            bos.write(html.toString().getBytes());
        }
    }


    /**
     * Writes the HTML code in this buffer to a temp file and opens it in default browser
     * @return      the file that contains generated HTML
     * @throws IOException  if there is an IO Exception
     */
    public File browse() throws IOException {
        return browse(File.createTempFile("chart_", ".html"));
    }

    /**
     * Writes the HTML code in this buffer to the output file and opens it in default browser
     * @param file      the file to write HTML buffer to
     * @return          the same as argument file
     * @throws IOException  if there is an IO Exception
     */
    public File browse(File file) throws IOException {
        IO.writeText(html.toString(), file);
        Desktop.getDesktop().browse(file.toURI());
        return file;
    }


    @Override
    public String toString() {
        return html.toString();
    }

    /**
     * Quick test to check output
     * @param args
     */
    public static void main(String[] args) {
        final HtmlCode htmlCode = new HtmlCode();
        htmlCode.newElement("html", html -> {
            html.newElement("head", head -> {
                head.newElement("title", title -> title.text("This is a test page"));
                head.newElement("script", script -> {
                    script.newAttribute("type", "text/javascript");
                    script.newAttribute("src", "https://www.gstatic.com/charts/loader.js");
                });
                head.newElement("script", script -> {
                    script.newAttribute("type", "text/javascript");
                    script.text("var x = 20;\nvar y = 45;\nvar z = 2323;");
                });
            });
            html.newElement("body", body -> {
                body.newElement("p", p -> p.text("Hello World!"));
                body.newElement("table", table -> {
                    table.newElement("thead", head -> {
                        head.newElement("tr", row -> {
                            row.newElement("td", td -> td.text("Column-0"));
                            row.newElement("td", td -> td.text("Column-1"));
                            row.newElement("td", td -> td.text("Column-2"));
                            row.newElement("td", td -> td.text("Column-3"));
                            row.newElement("td", td -> td.text("Column-4"));
                        });
                    });
                    for (int i=0; i<10; ++i) {
                        table.newElement("tr", row -> {
                            row.newElement("td", td -> td.text(String.valueOf(Math.random())));
                            row.newElement("td", td -> td.text(String.valueOf(Math.random())));
                            row.newElement("td", td -> td.text(String.valueOf(Math.random())));
                            row.newElement("td", td -> td.text(String.valueOf(Math.random())));
                            row.newElement("td", td -> td.text(String.valueOf(Math.random())));
                        });
                    }
                });
            });
        });
        System.out.println(htmlCode.toString());
    }

}