com.zavtech.morpheus.viz.html

Class HtmlCode

java.lang.Object

com.zavtech.morpheus.viz.html.HtmlCode

public class HtmlCode
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
private StringBuilder	html
private String	indent

Constructor Summary

Constructors

Constructor and Description
HtmlCode() Constructor

Method Summary

Modifier and Type	Method and Description
File	browse() Writes the HTML code in this buffer to a temp file and opens it in default browser
File	browse(File file) Writes the HTML code in this buffer to the output file and opens it in default browser
static String	createHtml(Consumer<HtmlCode> consumer) Convenience method to generate an HTML string given a writer
void	flush(File file) Flushes the contents of the buffer to a file
HtmlCode	indent(int count) Increases the indentation for the current line by a certain number of spaces
static void	main(String[] args) Quick test to check output
HtmlCode	newElement(String name, Consumer<HtmlElement> consumer) Creates a new element with the name specified
HtmlCode	newLine() Starts a new line and indents the new line based on current indentation
String	toString()
HtmlCode	unident(int count) Removes spaces from the current indentation
HtmlCode	write(String line, Object... args) Writes formatted code string to the output buffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

indent

private String indent

html

private StringBuilder html

Constructor Detail

HtmlCode

public HtmlCode()

Constructor

Method Detail

createHtml

public static String createHtml(Consumer<HtmlCode> consumer)

Convenience method to generate an HTML string given a writer

Parameters:

consumer - the consumer to call on the writer

Returns:

the resulting html string

indent

public HtmlCode indent(int count)

Increases the indentation for the current line by a certain number of spaces

Parameters:

count - the number of spaces to indent by

Returns:

this writer

unident

public HtmlCode unident(int count)

Removes spaces from the current indentation

Parameters:

count - the number of spaces to remove

Returns:

this code refernce

newLine

public HtmlCode newLine()

Starts a new line and indents the new line based on current indentation

Returns:

this code reference

write

public HtmlCode write(String line,
                      Object... args)

Writes formatted code string to the output buffer

Parameters:

line - the formatted code String (see String.format() for details)

args - the arguments for the formatted code string

Returns:

this writer

newElement

public HtmlCode newElement(String name,
                           Consumer<HtmlElement> consumer)

Creates a new element with the name specified

Parameters:

name - the HTML element name

consumer - the consumer used to configure the element

Returns:

this writer

flush

public void flush(File file)
           throws IOException

Flushes the contents of the buffer to a file

Parameters:

file - the file to flush the HTML buffer to

Throws:

IOException - if there is an IO Exception

browse

public File browse()
            throws IOException

Writes the HTML code in this buffer to a temp file and opens it in default browser

Returns:

the file that contains generated HTML

Throws:

IOException - if there is an IO Exception

browse

public File browse(File file)
            throws IOException

Writes the HTML code in this buffer to the output file and opens it in default browser

Parameters:

file - the file to write HTML buffer to

Returns:

the same as argument file

Throws:

IOException - if there is an IO Exception

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)

Quick test to check output

Parameters:

args -