AQHtmlWriter (OpenAPI)

All Superinterfaces:: AQDataWriter, java.lang.AutoCloseable, java.io.Closeable

public interface AQHtmlWriter
extends AQDataWriter

This interface provides a set of convenient methods for generating HTML output. An object implementing this interface can be obtained by calling aqua.io.newHtmlWriter().

Example:

 var d = aqua.data.newDataSet( [ 'column1','column2','column3' ] );
 d.addRowWithValues("a","b","<html>");
 d.addRowWithValues("1","2","3");

 var w = aqua.io.newHtmlWriter();
 w.setTitle("Example");
 w.setTableStyle("width:50%;");
 w.setRowStyle("background-color:#808080;");

 w.write("Table");
 w.write(d);

 print(w.toHtml());
 w.saveToFile('c:/test.html','utf-8');

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this writer and releases any system resources associated with it.
`void`	`saveToFile(java.lang.String filename)` Save the generated HTML to a file using UTF-8 encoding.
`void`	`saveToFile(java.lang.String filename, java.lang.String encoding)` Save the generated HTML to a file using the specified encoding.
`void`	`setCellStyle(java.lang.String style)` Sets the style of subsequent table cells (<TD> elements).
`void`	`setEmbeddedStyleSheet(java.lang.String styleSheet)` Sets embedded style sheet.
`void`	`setRowStyle(java.lang.String style)` Sets the style of subsequent table rows (<TR> elements).
`void`	`setTableStyle(java.lang.String style)` Sets the style of subsequent <TABLE> element.
`void`	`setTitle(java.lang.String title)` Sets document <TITLE> tag.
`java.lang.String`	`toHtml()` Returns generated HTML.
`void`	`writeLink(java.lang.String text, java.lang.String url)` Writes a hyperlink (<A HREF> element).
`void`	`writeText(java.lang.String text)` Writes arbitrary text.

Methods inherited from interface com.aquafold.openapi.io.AQDataWriter
setColumnStructure, write, write, write, write, writeColumnNames

- Method Detail
  - setTitle
```
void setTitle(java.lang.String title)
```
    Sets document <TITLE> tag.
    
    Parameters:
    
    title - Document title.
  - setEmbeddedStyleSheet
```
void setEmbeddedStyleSheet(java.lang.String styleSheet)
```
    Sets embedded style sheet. Embedded style is the style attached to one specific document. The style information is specified as a content of the <STYLE> element inside the <HEAD> element and will apply to the entire document.
    
    Parameters:
    
    styleSheet - the style sheet
  - setTableStyle
```
void setTableStyle(java.lang.String style)
```
    Sets the style of subsequent <TABLE> element.
    
    Parameters:
    
    style - the style
  - setRowStyle
```
void setRowStyle(java.lang.String style)
```
    Sets the style of subsequent table rows (<TR> elements).
    
    Parameters:
    
    style - the style
  - setCellStyle
```
void setCellStyle(java.lang.String style)
```
    Sets the style of subsequent table cells (<TD> elements).
    
    Parameters:
    
    style - the style
  - writeText
```
void writeText(java.lang.String text)
        throws java.lang.Exception
```
    Writes arbitrary text. This method is not intended for writing HTML tags, as any symbols that may be interpreted as part of HTML syntax will be escaped. For writing HTML tags use AQDataWriter.write(Object) method.
    
    Parameters:
    
    text - Text to be written.
    
    Throws:
    
    java.lang.Exception - On error
  - writeLink
```
void writeLink(java.lang.String text,
               java.lang.String url)
        throws java.lang.Exception
```
    Writes a hyperlink (<A HREF> element).
    
    Parameters:
    
    text - User-visible text.
    
    url - Link URL.
    
    Throws:
    
    java.lang.Exception - On error
  - toHtml
```
java.lang.String toHtml()
```
    Returns generated HTML.
    
    Returns:
    
    The HTML
  - saveToFile
```
void saveToFile(java.lang.String filename)
         throws java.lang.Exception
```
    Save the generated HTML to a file using UTF-8 encoding.
    
    Parameters:
    
    filename - the filename
    
    Throws:
    
    java.lang.Exception - On error
  - saveToFile
```
void saveToFile(java.lang.String filename,
                java.lang.String encoding)
         throws java.lang.Exception
```
    Save the generated HTML to a file using the specified encoding.
    
    Parameters:
    
    filename - the filename
    
    encoding - the encoding
    
    Throws:
    
    java.lang.Exception - On error
  - close
```
void close()
    throws java.io.IOException
```
    Closes this writer and releases any system resources associated with it. Once the file has been closed, further write() invocations will cause an exception to be thrown. Closing a previously closed stream has no effect.
    
    Specified by:
    
    close in interface AQDataWriter
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException - On error

Interface AQHtmlWriter

Method Summary

Methods inherited from interface com.aquafold.openapi.io.AQDataWriter

Method Detail

setTitle

setEmbeddedStyleSheet

setTableStyle

setRowStyle

setCellStyle

writeText

writeLink

toHtml

saveToFile

saveToFile

close