net.sf.statcvs.pages
Class HTML
TODO: Can we turn this into an abstract base class of MarkupHTML and MarkupXDoc?
$Id: HTML.java,v 1.12 2008/04/14 18:32:59 benoitx Exp $- Anja Jentzsch
- Richard Cyganiak (richard@cyganiak.de)
static String | escape(String text) - Escapes HTML meta characters "&", "<", ">" and turns "\n" line breaks
into HTML line breaks ("
");
|
static String | escapeAuthorName(String authorName) -
Escapes evil characters in author's names.
|
static String | escapeDirectoryName(String directoryName)
|
static String | escapeUrl(String text) - Escapes HTML as well as " as it is not valid in URL.
|
static String | getAffectedFilesCount(Set files) - Returns HTML code for number of affected files
|
static String | getAuthorIdLink(Author author) - Returns HTML code for a link to an author Id page
|
static String | getAuthorLink(Author author) - Returns HTML code for a link to an author page
|
static String | getDate(Date date) - Returns HTML code for a date
|
static String | getDateAndTime(Date date) - Returns HTML code for a date, including time
|
static String | getDirectoryLink(Directory directory) - Returns HTML code for a directory page link
|
static String | getIcon(String iconFilename) - Generates HTML for an icon
|
static String | getIcon(String iconFilename, String title) - Generates HTML for an icon
|
static String | getLink(String link, String linkName) - Creates a HTML representation of a hyperlink
|
static String | getLink(String link, String linkName, String prefix, String suffix) - Creates a HTML representation of a hyperlink
|
static String | getRevisionNumber(String revisionNumber) - Returns HTML code for a revision number
|
static String | webifyLinksFromPlainText(String plainText) - From a plain text comment identify the http: and https links and create a link for them.
|
escape
public static String escape(String text)
Escapes HTML meta characters "&", "<", ">" and turns "\n" line breaks
into HTML line breaks ("
");
text
- some string, for example "x > 0 && y <32100"
- HTML-escaped string, for example "x > 0 && y < 100"
escapeAuthorName
public static String escapeAuthorName(String authorName)
Escapes evil characters in author's names. E.g. "#" must be escaped
because for an author "my#name" a page "author_my#name.html" will be
created, and you can't link to that in HTML
TODO: Replace everything *but* known good characters, instead of just
evil ones
authorName
- an author's name
- a version safe for creation of files and URLs
escapeDirectoryName
public static String escapeDirectoryName(String directoryName)
escapeUrl
public static String escapeUrl(String text)
Escapes HTML as well as " as it is not valid in URL.
text
- some string, for example "x > 0 && y <32100"
- HTML-escaped string, for example "x > 0 && y < 100"
getAffectedFilesCount
public static String getAffectedFilesCount(Set files)
Returns HTML code for number of affected files
- HTML code for number of affected files
getAuthorIdLink
public static String getAuthorIdLink(Author author)
Returns HTML code for a link to an author Id page
getAuthorLink
public static String getAuthorLink(Author author)
Returns HTML code for a link to an author page
getDate
public static String getDate(Date date)
Returns HTML code for a date
getDateAndTime
public static String getDateAndTime(Date date)
Returns HTML code for a date, including time
getDirectoryLink
public static String getDirectoryLink(Directory directory)
Returns HTML code for a directory page link
getIcon
public static String getIcon(String iconFilename)
Generates HTML for an icon
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)
getIcon
public static String getIcon(String iconFilename,
String title)
Generates HTML for an icon
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)title
- the title for the icon.
getLink
public static String getLink(String link,
String linkName)
Creates a HTML representation of a hyperlink
link
- URLlinkName
- Name of the Link
- String HTML code of the hyperlink
getLink
public static String getLink(String link,
String linkName,
String prefix,
String suffix)
Creates a HTML representation of a hyperlink
link
- URLlinkName
- Name of the Linkprefix
- A prefix to be inserted before the link label; no HTML escaping is performed
- String HTML code of the hyperlink
getRevisionNumber
public static String getRevisionNumber(String revisionNumber)
Returns HTML code for a revision number
revisionNumber
- a revision number
- HTML code for a revision number
webifyLinksFromPlainText
public static String webifyLinksFromPlainText(String plainText)
From a plain text comment identify the http: and https links and create a link for them.