|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.reporting.AbstractMavenReportRenderer
public abstract class AbstractMavenReportRenderer
An abstract class to manage report generation.
Field Summary | |
---|---|
protected org.apache.maven.doxia.sink.Sink |
sink
|
Constructor Summary | |
---|---|
AbstractMavenReportRenderer(org.apache.maven.doxia.sink.Sink sink)
|
Method Summary | |
---|---|
protected static java.lang.String |
createLinkPatternedText(java.lang.String text,
java.lang.String href)
Create a link pattern text defined by {text, url} . |
protected void |
endSection()
|
protected void |
endTable()
|
abstract java.lang.String |
getTitle()
|
protected void |
javaScript(java.lang.String jsCode)
Add a Javascript code. |
protected void |
link(java.lang.String href,
java.lang.String name)
|
void |
linkPatternedText(java.lang.String text)
Add a text with links inside. |
protected void |
paragraph(java.lang.String paragraph)
|
protected static java.lang.String |
propertiesToString(java.util.Properties props)
Convenience method to display a Properties object comma separated. |
void |
render()
|
protected abstract void |
renderBody()
|
protected void |
startSection(java.lang.String name)
|
protected void |
startTable()
|
protected void |
tableCaption(java.lang.String caption)
|
protected void |
tableCell(java.lang.String text)
Add a cell in a table. |
protected void |
tableCell(java.lang.String text,
boolean asHtml)
Add a cell in a table. |
protected void |
tableHeader(java.lang.String[] content)
|
protected void |
tableHeaderCell(java.lang.String text)
|
protected void |
tableRow(java.lang.String[] content)
|
protected void |
text(java.lang.String text)
Add a new text. |
protected void |
verbatimLink(java.lang.String text,
java.lang.String href)
Add a verbatim text with a specific link. |
protected void |
verbatimText(java.lang.String text)
Add a verbatim text. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.maven.doxia.sink.Sink sink
Constructor Detail |
---|
public AbstractMavenReportRenderer(org.apache.maven.doxia.sink.Sink sink)
Method Detail |
---|
public void render()
render
in interface org.apache.maven.reporting.MavenReportRenderer
protected void startTable()
protected void endTable()
protected void startSection(java.lang.String name)
protected void endSection()
protected void tableHeaderCell(java.lang.String text)
protected void tableCell(java.lang.String text)
The text could be a link patterned text defined by {text, url}
text
- linkPatternedText(String)
protected void tableCell(java.lang.String text, boolean asHtml)
If asHtml
is true, add the text as Html
text
- asHtml
- protected void tableRow(java.lang.String[] content)
protected void tableHeader(java.lang.String[] content)
protected void tableCaption(java.lang.String caption)
protected void paragraph(java.lang.String paragraph)
protected void link(java.lang.String href, java.lang.String name)
protected void text(java.lang.String text)
If text is empty of has a null value, add the "-" charater
text
- a stringprotected void verbatimText(java.lang.String text)
text
- a stringtext(String)
protected void verbatimLink(java.lang.String text, java.lang.String href)
text
- a stringhref
- an href could be nulllink(String, String)
protected void javaScript(java.lang.String jsCode)
jsCode
- a string of Javascriptpublic void linkPatternedText(java.lang.String text)
The text variable should contained this given pattern {text, url}
to handle the link creation.
text
- a text with link pattern defined.text(String)
,
applyPattern(String)
protected static java.lang.String createLinkPatternedText(java.lang.String text, java.lang.String href)
{text, url}
.
This created pattern could be used by the method linkPatternedText(String)
to
handle a text with link.
text
- href
-
linkPatternedText(String)
protected static java.lang.String propertiesToString(java.util.Properties props)
Properties
object comma separated.
props
-
public abstract java.lang.String getTitle()
getTitle
in interface org.apache.maven.reporting.MavenReportRenderer
protected abstract void renderBody()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |