|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectes.unex.sextante.docEngines.html.HTMLDoc
public class HTMLDoc
A class to create simple HTML-formatted texts. Use this to create HTML results from SEXTANTE algorithms
Constructor Summary | |
---|---|
HTMLDoc()
|
Method Summary | |
---|---|
void |
addBoldText(java.lang.String sText)
Adds the given text in bold font |
void |
addCourierText(java.lang.String sText)
Adds text in courier font |
void |
addHeader(java.lang.String sText,
int iOrder)
Adds a header |
void |
addHorizontalSeparator()
Adds a horizontal separator |
void |
addHyperlink(java.lang.String sText,
java.lang.String sURL)
Adds a hyperlink |
void |
addImage(java.lang.String sFilename)
Adds an image |
void |
addImageAndDescription(java.lang.String sImageFile,
java.lang.String sDescription)
Adds an image an a caption describing it |
void |
addLineBreak()
Adds a line break |
void |
addListElement(java.lang.String sText)
Adds an element to the last opened list (ordered or unordered) |
void |
addOrderedList(java.lang.String[] sText)
Creates an ordered list from a set of elements |
void |
addParagraph(java.lang.String sText)
Adds a new paragraph |
void |
addTable(java.lang.String[][] Table,
java.lang.String sDescription,
boolean bColorFirstRow,
boolean bColorFirstCol)
Adds a table |
void |
addText(java.lang.String sText)
adds the given text. |
void |
addThumbnail(java.lang.String sFilename,
int iWidth,
boolean bIsPercent)
|
void |
addUnorderedList(java.lang.String[] sText)
Creates an unordered list from a set of elements |
void |
close()
Closes the HTML page |
void |
closeOrderedList()
Closes an ordered list |
void |
closeUnorderedList()
Closes an unordered list |
java.lang.String |
getHTMLCode()
Returns the page as a HTML-formatted string |
void |
open(java.lang.String sTitle)
Opens the HTML page with the given title |
void |
startOrderedList()
Starts an ordered list |
void |
startUnorderedList()
Starts an unordered list |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HTMLDoc()
Method Detail |
---|
public void open(java.lang.String sTitle)
sTitle
- the title of the pagepublic void close()
public java.lang.String getHTMLCode()
public void addText(java.lang.String sText)
sText
- the text to addpublic void addBoldText(java.lang.String sText)
sText
- the text to addpublic void addParagraph(java.lang.String sText)
sText
- the text of the paragraphpublic void addLineBreak()
public void addHeader(java.lang.String sText, int iOrder)
sText
- the text of the headeriOrder
- the order (importance) of the header (1,2,3...)public void addHyperlink(java.lang.String sText, java.lang.String sURL)
sText
- the text of the linksURL
- the URL to link topublic void addHorizontalSeparator()
public void addImage(java.lang.String sFilename)
sFilename
- the filename of the imagepublic void addThumbnail(java.lang.String sFilename, int iWidth, boolean bIsPercent)
public void startUnorderedList()
public void startOrderedList()
public void closeUnorderedList()
public void closeOrderedList()
public void addListElement(java.lang.String sText)
sText
- the text of the elementpublic void addOrderedList(java.lang.String[] sText)
sText
- an array of string, each of them representing
one element of the listpublic void addUnorderedList(java.lang.String[] sText)
sText
- an array of string, each of them representing
one element of the listpublic void addTable(java.lang.String[][] Table, java.lang.String sDescription, boolean bColorFirstRow, boolean bColorFirstCol)
Table
- The table as a 2D array of stringssDescription
- The description of the tablebColorFirstRow
- true if should give a different color
to the first rowbColorFirstCol
- true if should give a different color
to the first columnspublic void addImageAndDescription(java.lang.String sImageFile, java.lang.String sDescription)
sImageFile
- the image filesDescription
- the captionpublic void addCourierText(java.lang.String sText)
sText
- the text to add
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |