HTMLTableChartFormatter (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.report.AbstractTableFormatter
- - desmoj.core.report.HTMLTableChartFormatter

All Implemented Interfaces:

TableFormatter
```
public class HTMLTableChartFormatter
extends AbstractTableFormatter
```
A table formatter class for writing simulation output to HTML tables. It also supports the visualisation of 2D-charts based on HTML5's canvas-element. This class implements the HTML formatting functionality of the deprecated class desmoj.report.HTMLFileOuptut

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Johanna Djimandjaja, based on HTMLTableFormatter by Nicolas Knaak 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.

Constructor Summary

Constructors
Constructor and Description

HTMLTableChartFormatter()

Constructors
Constructor and Description
`HTMLTableChartFormatter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Inserts a reference to the top page and close the HTML file by writing the footing tags, flushing the buffer and closing the file.
`void`	`closeRow()` Writes the tag to close a row in a table to the file.
`void`	`closeTable()` Inserts the tags needed to close a HTML 3.2 table into the file.
`void`	`closeTableNoTopTag()` Inserts the tags needed to close a HTML 3.2 table into the file.
`void`	`drawChart(Canvas canvas)` Creates a canvas area and draws a chart in this area.
`java.lang.String`	`getFileFormat()`
`long`	`getFreeCanvasIDNum()` Returns an ID number for a canvas-element and increases the free ID number.
`void`	`open(java.lang.String name)` Opens a new file with the given fileName for writing a HTML table to.
`void`	`openRow()` Writes the HTML 3.2 tags to open a new row in a table to the file.
`void`	`openTable(java.lang.String s)` Inserts the tags needed to build a HTML 3.2 table heading into the file.
`boolean`	`rowIsOpen()` Returns the status of the current table row that is written to.
`void`	`setOutput(FileOutput out)` Sets an output file to write the table to
`boolean`	`tableIsOpen()` Returns the status of the current table that is written to.
`void`	`writeCell(java.lang.String s, int spanning)` Creates a new table cell and writes the given String into that cell.
`void`	`writeColoredCell(java.awt.Color cellColor)` Creates a new table cell with the specified color.
`void`	`writeHeading(int style, java.lang.String s)` Creates a newcentered heading row to print a title in.
`void`	`writeHeadingCell(java.lang.String s)` Creates a new table cell and writes the given String into that cell as heading cells in bold letters and with centered text.
`void`	`writeHorizontalRuler()` Inserts a reference to the top page and writes the HTML tag for inserting a horizontal ruler into the file.

Methods inherited from class desmoj.core.report.AbstractTableFormatter
openRow, setTimePrecision, timePrecision, writeTime

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

- Constructor Detail
  - HTMLTableChartFormatter
```
public HTMLTableChartFormatter()
```
- Method Detail
  - close
```
public void close()
```
    Inserts a reference to the top page and close the HTML file by writing the footing tags, flushing the buffer and closing the file.
  - closeRow
```
public void closeRow()
```
    Writes the tag to close a row in a table to the file.
  - closeTable
```
public void closeTable()
```
    Inserts the tags needed to close a HTML 3.2 table into the file.
  - closeTableNoTopTag
```
public void closeTableNoTopTag()
```
    Inserts the tags needed to close a HTML 3.2 table into the file. Also inserts a paragraph tag to add some space below the table. But omits the top tag as used in method closeTable(). This is needed if one reportable is generating a report that consists of more than one table (see StockReporter or HistogramReporter)
  - open
```
public void open(java.lang.String name)
```
    Opens a new file with the given fileName for writing a HTML table to. If no String is given, the default filename "unnamed_DESMOJ_file" is used.
    
    Parameters:
    
    name - java.lang.String : The name of the file to be created
  - openRow
```
public void openRow()
```
    Writes the HTML 3.2 tags to open a new row in a table to the file. A new row can only be started, if the table has alerady been opened and the previous row has been closed.
  - openTable
```
public void openTable(java.lang.String s)
```
    Inserts the tags needed to build a HTML 3.2 table heading into the file. The table's heading text is given with the parameter.
    
    Parameters:
    
    s - String : The heading for the table
  - rowIsOpen
```
public boolean rowIsOpen()
```
    Returns the status of the current table row that is written to.
    
    Specified by:
    
    rowIsOpen in interface TableFormatter
    
    Overrides:
    
    rowIsOpen in class AbstractTableFormatter
    
    Returns:
    
    boolean : Is true if the method openRow() has been called last, false if the method closeRow() has been called last
    
    See Also:
    
    TableFormatter.rowIsOpen()
  - setOutput
```
public void setOutput(FileOutput out)
```
    Sets an output file to write the table to
    
    Specified by:
    
    setOutput in interface TableFormatter
    
    Overrides:
    
    setOutput in class AbstractTableFormatter
    
    Parameters:
    
    out - desmoj.report.FileOutput
  - tableIsOpen
```
public boolean tableIsOpen()
```
    Returns the status of the current table that is written to.
    
    Specified by:
    
    tableIsOpen in interface TableFormatter
    
    Overrides:
    
    tableIsOpen in class AbstractTableFormatter
    
    Returns:
    
    boolean : Is true if the method openTable() has been called last, false if the method closeTable() has been called last
    
    See Also:
    
    TableFormatter.tableIsOpen()
  - writeCell
```
public void writeCell(java.lang.String s,
                      int spanning)
```
    Creates a new table cell and writes the given String into that cell. Note that there this is raw HTML code so there must not be any special language specific characters that might confuse any browser. A new cell can not be written, if neither a table nor a row have been opened yet. The method will simply return without action in that case.
    
    Parameters:
    
    s - java.lang.String : The text to be printed into a cell
    
    spanning - number of cells to span
  - writeColoredCell
```
public void writeColoredCell(java.awt.Color cellColor)
```
    Creates a new table cell with the specified color.
    
    Parameters:
    
    cellColor - java.awt.Color : The color of the cell, that should be created.
  - writeHeading
```
public void writeHeading(int style,
                         java.lang.String s)
```
    Creates a newcentered heading row to print a title in. Note that there this is raw HTML code so the string given must not contain any special language specific characters that might confuse any browser. been opened yet. The method will simply return without action in that case. The number for the HTML heading style must be inside the range [1,6]. If not, it will be trimmed to the nearest legal heading style number.
    
    Parameters:
    
    style - int : The heading style format number for the text to be printed in
    
    s - java.lang.String : The text to be printed as heading
  - writeHeadingCell
```
public void writeHeadingCell(java.lang.String s)
```
    Creates a new table cell and writes the given String into that cell as heading cells in bold letters and with centered text. Note that there this is raw HTML code so there must not be any special language specific characters that might confuse any browser. A new cell can not be written, if netiher a tbale nor a row have been opened yet. The method will simply return without action in that case.
    
    Parameters:
    
    s - java.lang.String : The text to be printed into a cell
  - writeHorizontalRuler
```
public void writeHorizontalRuler()
```
    Inserts a reference to the top page and writes the HTML tag for inserting a horizontal ruler into the file. Note that horizontal rulers are not written into table cells, thus this method simply returns, if a table is still open.
  - drawChart
```
public void drawChart(Canvas canvas)
```
    Creates a canvas area and draws a chart in this area.
    
    Parameters:
    
    canvas - The canvas containing the chart data to be drawn.
  - getFreeCanvasIDNum
```
public long getFreeCanvasIDNum()
```
    Returns an ID number for a canvas-element and increases the free ID number.
    
    Returns:
  - getFileFormat
```
public java.lang.String getFileFormat()
```
    Returns:
    
    The string "html"

Class HTMLTableChartFormatter

Constructor Summary

Method Summary

Methods inherited from class desmoj.core.report.AbstractTableFormatter

Methods inherited from class java.lang.Object

Constructor Detail

HTMLTableChartFormatter

Method Detail

close

closeRow

closeTable

closeTableNoTopTag

open

openRow

openTable

rowIsOpen

setOutput

tableIsOpen

writeCell

writeColoredCell

writeHeading

writeHeadingCell

writeHorizontalRuler

drawChart

getFreeCanvasIDNum

getFileFormat