Package net.sf.statcvs.pages
Class HTML
- java.lang.Object
-
- net.sf.statcvs.pages.HTML
-
public final class HTML extends java.lang.Object
TODO: Can we turn this into an abstract base class of MarkupHTML and MarkupXDoc?- Version:
- $Id: HTML.java,v 1.19 2009/08/05 16:32:10 benoitx Exp $
- Author:
- Anja Jentzsch, Richard Cyganiak (richard@cyganiak.de)
-
-
Field Summary
Fields Modifier and Type Field Description static java.text.SimpleDateFormat
OUTPUT_DATE_FORMAT
static java.text.SimpleDateFormat
OUTPUT_DATE_TIME_FORMAT
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
escape(java.lang.String text)
Escapes HTML meta characters "&", "<", ">" and turns "\n" line breaks into HTML line breaks ("
");static java.lang.String
escapeAuthorName(java.lang.String authorName)
Escapes evil characters in author's names.static java.lang.String
escapeDirectoryName(java.lang.String directoryName)
static java.lang.String
escapeUrl(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.static java.lang.String
escapeUrlParameters(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.static java.lang.String
getAffectedFilesCount(java.util.Set files)
Returns HTML code for number of affected filesstatic java.lang.String
getAuthorIdLink(Author author)
Returns HTML code for a link to an author Id pagestatic java.lang.String
getAuthorLink(Author author)
Returns HTML code for a link to an author pagestatic java.lang.String
getDate(java.util.Date date)
Returns HTML code for a datestatic java.lang.String
getDateAndTime(java.util.Date date)
Returns HTML code for a date, including timestatic java.lang.String
getDirectoryLink(Directory directory)
Returns HTML code for a directory page linkstatic java.lang.String
getIcon(java.lang.String iconFilename)
Generates HTML for an iconstatic java.lang.String
getIcon(java.lang.String iconFilename, java.lang.String title)
Generates HTML for an iconstatic java.lang.String
getLink(java.lang.String link, java.lang.String linkName)
Creates a HTML representation of a hyperlinkstatic java.lang.String
getLink(java.lang.String link, java.lang.String linkName, java.lang.String prefix, java.lang.String suffix)
Creates a HTML representation of a hyperlinkstatic java.lang.String
getRevisionNumber(java.lang.String revisionNumber)
Returns HTML code for a revision numberstatic java.lang.String
webifyLinksFromPlainText(java.lang.String plainText)
From a plain text comment identify the http: and https links and create a link for them.
-
-
-
Method Detail
-
getLink
public static java.lang.String getLink(java.lang.String link, java.lang.String linkName)
Creates a HTML representation of a hyperlink- Parameters:
link
- URLlinkName
- Name of the Link- Returns:
- String HTML code of the hyperlink
-
getLink
public static java.lang.String getLink(java.lang.String link, java.lang.String linkName, java.lang.String prefix, java.lang.String suffix)
Creates a HTML representation of a hyperlink- Parameters:
link
- URLlinkName
- Name of the Linkprefix
- A prefix to be inserted before the link label; no HTML escaping is performedprefix
- A suffix to be inserted after the link label; no HTML escaping is performed- Returns:
- String HTML code of the hyperlink
-
getAuthorLink
public static java.lang.String getAuthorLink(Author author)
Returns HTML code for a link to an author page- Parameters:
author
- the author- Returns:
- HTML code for the link
-
getAuthorIdLink
public static java.lang.String getAuthorIdLink(Author author)
Returns HTML code for a link to an author Id page- Parameters:
author
- the author- Returns:
- HTML code for the link
-
getDate
public static java.lang.String getDate(java.util.Date date)
Returns HTML code for a date- Parameters:
date
- the date- Returns:
- HTML code for the date
-
getAffectedFilesCount
public static java.lang.String getAffectedFilesCount(java.util.Set files)
Returns HTML code for number of affected files- Parameters:
files
- affected files- Returns:
- HTML code for number of affected files
-
getDateAndTime
public static java.lang.String getDateAndTime(java.util.Date date)
Returns HTML code for a date, including time- Parameters:
date
- the date- Returns:
- HTML code for the date
-
getRevisionNumber
public static java.lang.String getRevisionNumber(java.lang.String revisionNumber)
Returns HTML code for a revision number- Parameters:
revisionNumber
- a revision number- Returns:
- HTML code for a revision number
-
getDirectoryLink
public static java.lang.String getDirectoryLink(Directory directory)
Returns HTML code for a directory page link- Parameters:
directory
- a directory- Returns:
- HTML code for the link
-
getIcon
public static java.lang.String getIcon(java.lang.String iconFilename)
Generates HTML for an icon- Parameters:
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)- Returns:
- HTML string
-
getIcon
public static java.lang.String getIcon(java.lang.String iconFilename, java.lang.String title)
Generates HTML for an icon- Parameters:
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)title
- the title for the icon.- Returns:
- HTML string
-
escapeAuthorName
public static java.lang.String escapeAuthorName(java.lang.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- Parameters:
authorName
- an author's name- Returns:
- a version safe for creation of files and URLs
-
escapeDirectoryName
public static java.lang.String escapeDirectoryName(java.lang.String directoryName)
-
escape
public static java.lang.String escape(java.lang.String text)
Escapes HTML meta characters "&", "<", ">" and turns "\n" line breaks into HTML line breaks ("
");- Parameters:
text
- some string, for example "x > 0 && y < 100"- Returns:
- HTML-escaped string, for example "x > 0 && y < 100"
-
escapeUrl
public static java.lang.String escapeUrl(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.- Parameters:
text
- some string, for example "x > 0 && y < 100"- Returns:
- HTML-escaped string, for example "x > 0 && y < 100"
-
escapeUrlParameters
public static java.lang.String escapeUrlParameters(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.- Parameters:
text
- some string, for example "x > 0 && y < 100"- Returns:
- HTML-escaped string, for example "x > 0 && y < 100"
-
webifyLinksFromPlainText
public static java.lang.String webifyLinksFromPlainText(java.lang.String plainText)
From a plain text comment identify the http: and https links and create a link for them.- Parameters:
plainText
-
-
-