HtmlTag (openCypher Grammar Developer Tools 1.0.0-M15 API)

java.lang.Object
- org.opencypher.tools.io.HtmlTag

All Implemented Interfaces:: AutoCloseable

public final class HtmlTag
extends Object
implements AutoCloseable

Tiny DSL for generating HTML. Usage:


 try ( HtmlTag.Html html = HtmlTag.html( outputPath ) ) {
     html.head( title -> "My Page" );
     try ( HtmlTag body = html.body() ) {
         body.tag("h1")                  // opens a new <h1> tag
             .text("Welcome to My Page") // adds text content to the tag
             .close();                   // closes the </h1> tag
         body.text("This is a very neat page.");
         body.p();
         body.text("You should come back when there is more content.");
         body.br();
         body.text("Until then, here is a picture of a cat for you to look at:");
         body.tag("img", src -> "http://thecatapi.com/api/images/get?format=src&type=gif");
         body.p();
         body.tag("b").text("To do:").close();
         try ( HtmlTag list = body.tag("ul") ) {
             list.tag("li").text("Find cuter cat").close();
             list.tag("li").text("???").close();
             list.tag("li").text("Profit!").close();
         }
     }
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HtmlTag.Attribute<T>

static class HtmlTag.Html

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HtmlTag.Attribute<T>`
`static class`	`HtmlTag.Html`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HtmlTag.Attribute<Void>`	`attr(String attribute, String value)` Generate html tag attributes for use in .
`void`	`br()`
`void`	`close()`
`static HtmlTag.Attribute<HtmlTag>`	`head(HtmlTag.Attribute<HtmlTag> tag, HtmlTag.Attribute<Void>... attributes)` Generate html tags for use in `<head>`.
`static HtmlTag.Attribute<HtmlTag>`	`head(String tag, Consumer<HtmlTag> content, HtmlTag.Attribute<Void>... attributes)` Generate html tags for use in `<head>`.
`static HtmlTag.Html`	`html(Output output)`
`static HtmlTag.Html`	`html(Path file)`
`static HtmlTag.Attribute<HtmlTag>`	`meta(String name, String value)` Generate meta tags for use in `<head>`.
`Output`	`output()` Unsafe access to the underlying `Output`.
`void`	`p()`
`HtmlTag`	`tag(String tag, HtmlTag.Attribute<Void>... attributes)`
`HtmlTag`	`text(String text)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - html
```
public static HtmlTag.Html html(Path file)
```
  - html
```
public static HtmlTag.Html html(Output output)
```
  - tag
```
@SafeVarargs
public final HtmlTag tag(String tag,
                                      HtmlTag.Attribute<Void>... attributes)
```
  - text
```
public HtmlTag text(String text)
```
  - p
```
public void p()
```
  - br
```
public void br()
```
  - attr
```
public static HtmlTag.Attribute<Void> attr(String attribute,
                                           String value)
```
    Generate html tag attributes for use in . This is an alternative to body.tag( "img", src -> imgUri ), allowing the use of the API on earlier builds of the JDK as body.tag( "img", attr( "src", imgUri ) ).
    
    Parameters:
    
    attribute - the name of the attribute.
    
    value - the value of the attribute.
    
    Returns:
    
    an object that generates the attribute.
  - meta
```
public static HtmlTag.Attribute<HtmlTag> meta(String name,
                                              String value)
```
    Generate meta tags for use in <head>.
    
    Parameters:
    
    name - the name of the meta attribute.
    
    value - the value of the meta attribute.
    
    Returns:
    
    an object that generates the tag in the head.
  - head
```
public static HtmlTag.Attribute<HtmlTag> head(HtmlTag.Attribute<HtmlTag> tag,
                                              HtmlTag.Attribute<Void>... attributes)
```
    Generate html tags for use in <head>. Allows adding attributes to a head tag.
    
    Parameters:
    
    tag - the name and contents of the head tag.
    
    attributes - the attributes of the head tag.
    
    Returns:
    
    an object that generates the tag in the head.
  - head
```
@SafeVarargs
public static HtmlTag.Attribute<HtmlTag> head(String tag,
                                                           Consumer<HtmlTag> content,
                                                           HtmlTag.Attribute<Void>... attributes)
```
    Generate html tags for use in <head>. This is an alternative to html.head( title -> "my title" ), allowing the use of the API on earlier builds of the JDK as html.head( head( "title", title -> title.text( "my title" ) ) ).
    
    Parameters:
    
    tag - the name of the head tag.
    
    content - generator for the content of the head tag.
    
    attributes - the attributes of the head tag.
    
    Returns:
    
    an object that generates the tag in the head.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - output
```
public Output output()
```
    Unsafe access to the underlying Output. This provides direct access to the underlying Output and should be used carefully, since its use might result in invalid HTML.
    
    Returns:
    
    the underlying Output

Class HtmlTag

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

html

html

tag

text

p

br

attr

meta

head

head

close

output