com.swfit.core.xhtml
Class XHTMLTools

java.lang.Object
  |
  +--com.swfit.core.xhtml.XHTMLTools

public final class XHTMLTools

extends java.lang.Object

A collection of methods to render the most common plain XHTML elements (image, link, bullet list, table, paragraph etc.). There are three levels to access elements / lists:

a) get a String with the shorthand method - fi. writeLink (String link_value), b) process a StringBuffer - fi. writeLink (StringBuffer str_b, String link_value), c) get the XHTMLElement / XHTMLList directly, and work with that

At the bottom of this document there is an informal collection of tests that also show how the code could be implemented.

Since:

SWFIT1.0

Version:

$Revision: 1.2 $ $Date: 2003/02/03 03:15:03 $

Author:

Olaf Havnes

Method Summary

static XHTMLList	bulletList() Different ways of creating a bulleted list
static XHTMLList	bulletList(java.lang.String list_style, java.lang.String element_style)
static com.swfit.core.xhtml.XHTMLTools.XHTMLImage	image(java.lang.String image_url) Different ways of creating an image
static com.swfit.core.xhtml.XHTMLTools.XHTMLImage	image(java.lang.String image_url, java.lang.String image_style)
static com.swfit.core.xhtml.XHTMLTools.XHTMLImage	image(java.lang.String image_url, java.lang.String image_style, int image_width, int image_height)
static XHTMLElement	link(java.lang.String link_value) Different ways of creating a hyperlink
static XHTMLElement	link(java.lang.String link_value, java.lang.String link_style)
static XHTMLElement	link(java.lang.String link_value, java.lang.String link_style, java.lang.String link_title)
static XHTMLElement	link(java.lang.String link_value, java.lang.String link_style, java.lang.String link_title, java.lang.String mouse_over, java.lang.String mouse_out)
static XHTMLList	paragraph() Different ways of creating a paragraph
static XHTMLList	paragraph(java.lang.String paragraph_style)
static java.lang.String	parseBody(java.lang.String text) Split a body text into paragraphs and subheaders.
static java.lang.StringBuffer	parseBody(java.lang.StringBuffer str_b, java.lang.String text)
static XHTMLList	table() Different ways of creating a table
static XHTMLList	table(int cols)
static XHTMLList	table(int cols, java.lang.String table_style, java.lang.String cell_style)
static java.lang.StringBuffer	toolTest(java.lang.StringBuffer str_b) Test the methods with typical input strings
static java.lang.String	writeArticleLinks(java.lang.String[] links, java.lang.String[] linktexts) Article links
static java.lang.StringBuffer	writeArticleLinks(java.lang.StringBuffer str_b, java.lang.String[] links, java.lang.String[] linktexts)
static java.lang.StringBuffer	writeAuthorLink(java.lang.StringBuffer str_b, java.lang.String name, java.lang.String link, java.lang.String bio)
static java.lang.String	writeAuthorLink(java.lang.String name, java.lang.String link, java.lang.String bio) Technical information (typically dates, photo credits etc)
static java.lang.String	writeBody(java.lang.String text) Body text - uses semi encoding, so it is possible to type HTML into form fields.
static java.lang.StringBuffer	writeBody(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeComment(java.lang.String text) Comment text - comes out hidden in the XHTML document.
static java.lang.StringBuffer	writeComment(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeDocTitle(java.lang.String text) Title text - the title of a XHTML document
static java.lang.StringBuffer	writeDocTitle(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.StringBuffer	writeH1(java.lang.StringBuffer str_b, java.lang.String text) Generic header 1
static java.lang.StringBuffer	writeH2(java.lang.StringBuffer str_b, java.lang.String text) Generic header 2
static java.lang.StringBuffer	writeH3(java.lang.StringBuffer str_b, java.lang.String text) Generic header 3
static java.lang.String	writeHeadline(java.lang.String text) Title of an article - NOT the title of a XHTML document.
static java.lang.StringBuffer	writeHeadline(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeHorizontalRule() A horizontal rule
static java.lang.StringBuffer	writeHorizontalRule(java.lang.StringBuffer str_b)
static java.lang.String	writeImage(java.lang.String image_url) An image rendered from various inputs.
static java.lang.StringBuffer	writeImage(java.lang.StringBuffer str_b, java.lang.String image_url)
static java.lang.StringBuffer	writeImage(java.lang.StringBuffer str_b, java.lang.String image_url, java.lang.String image_alt)
static java.lang.StringBuffer	writeImage(java.lang.StringBuffer str_b, java.lang.String image_url, java.lang.String image_alt, java.lang.String image_style)
static java.lang.StringBuffer	writeImage(java.lang.StringBuffer str_b, java.lang.String image_url, java.lang.String image_alt, java.lang.String image_style, int image_width, int image_height)
static java.lang.String	writeImage(java.lang.String image_url, java.lang.String image_alt)
static java.lang.String	writeImage(java.lang.String image_url, java.lang.String image_alt, java.lang.String image_style)
static java.lang.String	writeImage(java.lang.String image_url, java.lang.String image_alt, java.lang.String image_style, int image_width, int image_height)
static java.lang.StringBuffer	writeImageLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String image_url)
static java.lang.StringBuffer	writeImageLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String image_url, boolean linebreak)
static java.lang.String	writeImageLink(java.lang.String link_value, java.lang.String image_url) Render a link wrapped around an image and (optionally) some text
static java.lang.String	writeImageLink(java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String image_url, boolean linebreak)
static java.lang.String	writeImageText(java.lang.String text) Text that accompanies an image.
static java.lang.StringBuffer	writeImageText(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeInfo(java.lang.String text) Technical information (typically dates, photo credits etc)
static java.lang.StringBuffer	writeInfo(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeIngress(java.lang.String text) Ingress text
static java.lang.StringBuffer	writeIngress(java.lang.StringBuffer str_b, java.lang.String text)
static java.lang.String	writeLink(java.lang.String link_value) A hyperlink rendered from various inputs.
static java.lang.StringBuffer	writeLink(java.lang.StringBuffer str_b, java.lang.String link_value)
static java.lang.StringBuffer	writeLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String link_description)
static java.lang.StringBuffer	writeLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String link_description, java.lang.String link_style)
static java.lang.StringBuffer	writeLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String link_title)
static java.lang.StringBuffer	writeLink(java.lang.StringBuffer str_b, java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String link_title, java.lang.String mouse_over, java.lang.String mouse_out)
static java.lang.String	writeLink(java.lang.String link_value, java.lang.String link_description)
static java.lang.String	writeLink(java.lang.String link_value, java.lang.String link_description, java.lang.String link_style)
static java.lang.String	writeLink(java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String link_title)
static java.lang.String	writeLink(java.lang.String link_value, java.lang.String link_description, java.lang.String link_style, java.lang.String link_title, java.lang.String mouse_over, java.lang.String mouse_out)
static java.lang.String	writeSubHeader(java.lang.String text) Sub headers
static java.lang.StringBuffer	writeSubHeader(java.lang.StringBuffer str_b, java.lang.String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parseBody

public static final java.lang.String parseBody(java.lang.String text)

Split a body text into paragraphs and subheaders. Paragraphs are divided by exactly two line breaks. A subheader is two line breaks followed by text followed by three line breaks. The rest of the line breaks will be treated as html BREAKS.

parseBody

public static final java.lang.StringBuffer parseBody(java.lang.StringBuffer str_b,
                                                     java.lang.String text)

writeBody

public static final java.lang.String writeBody(java.lang.String text)

Body text - uses semi encoding, so it is possible to type HTML into form fields. User the method above for large amounts of texts that needs formatting.

writeBody

public static final java.lang.StringBuffer writeBody(java.lang.StringBuffer str_b,
                                                     java.lang.String text)

writeH1

public static final java.lang.StringBuffer writeH1(java.lang.StringBuffer str_b,
                                                   java.lang.String text)

Generic header 1

writeH2

public static final java.lang.StringBuffer writeH2(java.lang.StringBuffer str_b,
                                                   java.lang.String text)

Generic header 2

writeH3

public static final java.lang.StringBuffer writeH3(java.lang.StringBuffer str_b,
                                                   java.lang.String text)

Generic header 3

writeHeadline

public static final java.lang.String writeHeadline(java.lang.String text)

Title of an article - NOT the title of a XHTML document.

writeHeadline

public static final java.lang.StringBuffer writeHeadline(java.lang.StringBuffer str_b,
                                                         java.lang.String text)

writeSubHeader

public static final java.lang.String writeSubHeader(java.lang.String text)

Sub headers

writeSubHeader

public static final java.lang.StringBuffer writeSubHeader(java.lang.StringBuffer str_b,
                                                          java.lang.String text)

writeIngress

public static final java.lang.String writeIngress(java.lang.String text)

Ingress text

writeIngress

public static final java.lang.StringBuffer writeIngress(java.lang.StringBuffer str_b,
                                                        java.lang.String text)

writeImageText

public static final java.lang.String writeImageText(java.lang.String text)

Text that accompanies an image.

writeImageText

public static final java.lang.StringBuffer writeImageText(java.lang.StringBuffer str_b,
                                                          java.lang.String text)

writeInfo

public static final java.lang.String writeInfo(java.lang.String text)

Technical information (typically dates, photo credits etc)

writeInfo

public static final java.lang.StringBuffer writeInfo(java.lang.StringBuffer str_b,
                                                     java.lang.String text)

writeAuthorLink

public static final java.lang.String writeAuthorLink(java.lang.String name,
                                                     java.lang.String link,
                                                     java.lang.String bio)

Technical information (typically dates, photo credits etc)

writeAuthorLink

public static final java.lang.StringBuffer writeAuthorLink(java.lang.StringBuffer str_b,
                                                           java.lang.String name,
                                                           java.lang.String link,
                                                           java.lang.String bio)

writeArticleLinks

public static final java.lang.String writeArticleLinks(java.lang.String[] links,
                                                       java.lang.String[] linktexts)

Article links

writeArticleLinks

public static final java.lang.StringBuffer writeArticleLinks(java.lang.StringBuffer str_b,
                                                             java.lang.String[] links,
                                                             java.lang.String[] linktexts)

writeDocTitle

public static final java.lang.String writeDocTitle(java.lang.String text)

Title text - the title of a XHTML document

writeDocTitle

public static final java.lang.StringBuffer writeDocTitle(java.lang.StringBuffer str_b,
                                                         java.lang.String text)

writeComment

public static final java.lang.String writeComment(java.lang.String text)

Comment text - comes out hidden in the XHTML document.

writeComment

public static final java.lang.StringBuffer writeComment(java.lang.StringBuffer str_b,
                                                        java.lang.String text)

writeHorizontalRule

public static final java.lang.String writeHorizontalRule()

A horizontal rule

writeHorizontalRule

public static final java.lang.StringBuffer writeHorizontalRule(java.lang.StringBuffer str_b)

writeLink

public static final java.lang.String writeLink(java.lang.String link_value)

A hyperlink rendered from various inputs.

writeLink

public static final java.lang.String writeLink(java.lang.String link_value,
                                               java.lang.String link_description)

writeLink

public static final java.lang.String writeLink(java.lang.String link_value,
                                               java.lang.String link_description,
                                               java.lang.String link_style)

writeLink

public static final java.lang.String writeLink(java.lang.String link_value,
                                               java.lang.String link_description,
                                               java.lang.String link_style,
                                               java.lang.String link_title)

writeLink

public static final java.lang.String writeLink(java.lang.String link_value,
                                               java.lang.String link_description,
                                               java.lang.String link_style,
                                               java.lang.String link_title,
                                               java.lang.String mouse_over,
                                               java.lang.String mouse_out)

writeLink

public static final java.lang.StringBuffer writeLink(java.lang.StringBuffer str_b,
                                                     java.lang.String link_value)

writeLink

public static final java.lang.StringBuffer writeLink(java.lang.StringBuffer str_b,
                                                     java.lang.String link_value,
                                                     java.lang.String link_description)

writeLink

public static final java.lang.StringBuffer writeLink(java.lang.StringBuffer str_b,
                                                     java.lang.String link_value,
                                                     java.lang.String link_description,
                                                     java.lang.String link_style)

writeLink

public static final java.lang.StringBuffer writeLink(java.lang.StringBuffer str_b,
                                                     java.lang.String link_value,
                                                     java.lang.String link_description,
                                                     java.lang.String link_style,
                                                     java.lang.String link_title)

writeLink

public static final java.lang.StringBuffer writeLink(java.lang.StringBuffer str_b,
                                                     java.lang.String link_value,
                                                     java.lang.String link_description,
                                                     java.lang.String link_style,
                                                     java.lang.String link_title,
                                                     java.lang.String mouse_over,
                                                     java.lang.String mouse_out)

writeImage

public static final java.lang.String writeImage(java.lang.String image_url)

An image rendered from various inputs.

writeImage

public static final java.lang.String writeImage(java.lang.String image_url,
                                                java.lang.String image_alt)

writeImage

public static final java.lang.String writeImage(java.lang.String image_url,
                                                java.lang.String image_alt,
                                                java.lang.String image_style)

writeImage

public static final java.lang.String writeImage(java.lang.String image_url,
                                                java.lang.String image_alt,
                                                java.lang.String image_style,
                                                int image_width,
                                                int image_height)

writeImage

public static final java.lang.StringBuffer writeImage(java.lang.StringBuffer str_b,
                                                      java.lang.String image_url)

writeImage

public static final java.lang.StringBuffer writeImage(java.lang.StringBuffer str_b,
                                                      java.lang.String image_url,
                                                      java.lang.String image_alt)

writeImage

public static final java.lang.StringBuffer writeImage(java.lang.StringBuffer str_b,
                                                      java.lang.String image_url,
                                                      java.lang.String image_alt,
                                                      java.lang.String image_style)

writeImage

public static final java.lang.StringBuffer writeImage(java.lang.StringBuffer str_b,
                                                      java.lang.String image_url,
                                                      java.lang.String image_alt,
                                                      java.lang.String image_style,
                                                      int image_width,
                                                      int image_height)

writeImageLink

public static final java.lang.String writeImageLink(java.lang.String link_value,
                                                    java.lang.String image_url)

Render a link wrapped around an image and (optionally) some text

writeImageLink

public static final java.lang.String writeImageLink(java.lang.String link_value,
                                                    java.lang.String link_description,
                                                    java.lang.String link_style,
                                                    java.lang.String image_url,
                                                    boolean linebreak)

writeImageLink

public static final java.lang.StringBuffer writeImageLink(java.lang.StringBuffer str_b,
                                                          java.lang.String link_value,
                                                          java.lang.String image_url)

writeImageLink

public static final java.lang.StringBuffer writeImageLink(java.lang.StringBuffer str_b,
                                                          java.lang.String link_value,
                                                          java.lang.String link_description,
                                                          java.lang.String link_style,
                                                          java.lang.String image_url,
                                                          boolean linebreak)

link

public static final XHTMLElement link(java.lang.String link_value)

Different ways of creating a hyperlink

link

public static final XHTMLElement link(java.lang.String link_value,
                                      java.lang.String link_style)

link

public static final XHTMLElement link(java.lang.String link_value,
                                      java.lang.String link_style,
                                      java.lang.String link_title)

link

public static final XHTMLElement link(java.lang.String link_value,
                                      java.lang.String link_style,
                                      java.lang.String link_title,
                                      java.lang.String mouse_over,
                                      java.lang.String mouse_out)

image

public static final com.swfit.core.xhtml.XHTMLTools.XHTMLImage image(java.lang.String image_url)

Different ways of creating an image

image

public static final com.swfit.core.xhtml.XHTMLTools.XHTMLImage image(java.lang.String image_url,
                                                                     java.lang.String image_style)

image

public static final com.swfit.core.xhtml.XHTMLTools.XHTMLImage image(java.lang.String image_url,
                                                                     java.lang.String image_style,
                                                                     int image_width,
                                                                     int image_height)

paragraph

public static final XHTMLList paragraph()

Different ways of creating a paragraph

paragraph

public static final XHTMLList paragraph(java.lang.String paragraph_style)

table

public static final XHTMLList table()

Different ways of creating a table

table

public static final XHTMLList table(int cols)

table

public static final XHTMLList table(int cols,
                                    java.lang.String table_style,
                                    java.lang.String cell_style)

bulletList

public static final XHTMLList bulletList()

Different ways of creating a bulleted list

bulletList

public static final XHTMLList bulletList(java.lang.String list_style,
                                         java.lang.String element_style)

toolTest

public static final java.lang.StringBuffer toolTest(java.lang.StringBuffer str_b)

Test the methods with typical input strings