Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

GHTMLOutput Class Reference

HTML output processor. More...

Inheritance diagram for GHTMLOutput:

GOutput List of all members.

Public Member Functions

void GHTMLOutput ()
 Constructs an HTML output processor.

String get_optimised_html (GCanvas gcanvas)
 Returns the image canvas html (using RLE compression on both lines and rows = optimised RLE).

void print_optimised_html (GCanvas gcanvas)
 Assigns the image canvas html (using RLE compression on both lines and rows = optimised RLE) to a given layer.

void print (GCanvas gcanvas)
 Assigns the image canvas html to a given layer.

String get_html (GCanvas gcanvas)
 Returns the image canvas html (using RLE compression on lines = fast RLE).

void setup (Object doc, String layerId)
 HTML output printing parametrs setup function.

void print_html (GCanvas gcanvas)
 Assigns the image canvas html (using RLE compression on lines = fast RLE) to a given layer.

String get (GCanvas gcanvas)
 Returns the image canvas html.


Public Attributes

Integer generation_time
 Time (in ms.) used for the generation of the HTML table.

Boolean append
 Append or overwrite the layer.

Integer compression
 Compression parametr (0 - fast RLE, 1 - optimised RLE).

Integer invisible_color
 An invsibile color.

Integer number_of_cells
 Number of cells generated in the HTML table.

Boolean dhtml
 Output type - HTML (table) or DHTML (div's).

Object doc
 Javascript document object (usually this.document).

String layerId
 Output layer ID.


Detailed Description

HTML output processor.

This output processor can be used to render the canvas as an HTML table. Two types ('Fast RLE' and 'Optimised RLE') of output rendering are provided, see bellow.


Member Function Documentation

String GHTMLOutput::get GCanvas  gcanvas  )  [inline]
 

Returns the image canvas html.

Returns:
A table in HTML format representing the image canvas.
Parameters:
gcanvas 2D image canvas.

String GHTMLOutput::get_html GCanvas  gcanvas  )  [inline]
 

Returns the image canvas html (using RLE compression on lines = fast RLE).

Returns:
A table in HTML format representing the image canvas.
Parameters:
gcanvas 2D image canvas.

String GHTMLOutput::get_optimised_html GCanvas  gcanvas  )  [inline]
 

Returns the image canvas html (using RLE compression on both lines and rows = optimised RLE).

Returns:
A table in HTML format representing the image canvas.
Parameters:
gcanvas 2D image canvas.

void GHTMLOutput::print GCanvas  gcanvas  )  [inline]
 

Assigns the image canvas html to a given layer.

Parameters:
gcanvas 2D image canvas.

void GHTMLOutput::print_html GCanvas  gcanvas  )  [inline]
 

Assigns the image canvas html (using RLE compression on lines = fast RLE) to a given layer.

Parameters:
gcanvas 2D image canvas.

void GHTMLOutput::print_optimised_html GCanvas  gcanvas  )  [inline]
 

Assigns the image canvas html (using RLE compression on both lines and rows = optimised RLE) to a given layer.

Parameters:
gcanvas 2D image canvas.

void GHTMLOutput::setup Object  doc,
String  layerId
[inline]
 

HTML output printing parametrs setup function.

Parameters:
doc Document object (usually this.document).
layerId Output layer ID.


Member Data Documentation

Boolean GHTMLOutput::append
 

Append or overwrite the layer.

Needed only for print functions.

Boolean GHTMLOutput::dhtml
 

Output type - HTML (table) or DHTML (div's).

If dhtml is set to false HTML output is produced and if dhtml is set to true DHTML output is produced.

Object GHTMLOutput::doc
 

Javascript document object (usually this.document).

Needed only for print functions.

Integer GHTMLOutput::invisible_color
 

An invsibile color.

By default invisible_color = -1, i.e. the default background of the canvas.

String GHTMLOutput::layerId
 

Output layer ID.

Needed only for print functions.


The documentation for this class was generated from the following file:
This is a documentation for JSGraphics, a powerfull JavaScript graphics library
© 2003 by Kitya Karlson
Produced using DoxyGen.