|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.mojo.javancss.AbstractNcssReportGenerator
public abstract class AbstractNcssReportGenerator
Base abstract class for NCSSReport classes.
It holds essentially helper methods on top of the Sink Doxia object.
Constructor Summary | |
---|---|
protected |
AbstractNcssReportGenerator(org.apache.maven.doxia.sink.Sink sink,
ResourceBundle bundle,
org.apache.maven.plugin.logging.Log log)
build a new NcssReportGenerator. |
Method Summary | |
---|---|
protected void |
codeCellHelper(String text)
sink helper to write cell containing code. |
protected void |
codeItemListHelper(String text)
sink helper to write a "code" itemList. |
protected void |
doIntro(boolean withNavigationBar)
Output the report introduction. |
protected void |
endSection()
sink helper to end a section |
org.apache.maven.plugin.logging.Log |
getLog()
Getter for the Log instance. |
ResourceBundle |
getResourceBundle()
Getter for the RessourceBundle. |
org.apache.maven.doxia.sink.Sink |
getSink()
Getter for the Sink instance. |
protected String |
getString(String key)
resource bundle helper to get a value. |
protected void |
headerCellHelper(String text)
sink helper to write a simple table header cell. |
protected void |
navigationBar()
|
protected void |
paragraphHelper(String text)
sink helper to write a paragraph |
protected void |
startSection(String link,
String title)
sink helper to start a section. |
protected void |
subtitleHelper(String text)
sink helper to write a subtitle |
protected void |
tableCellHelper(String text)
sink helper to write a simple tabke cell. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractNcssReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, org.apache.maven.plugin.logging.Log log)
sink
- the sink that will be used for reporting.bundle
- the correct RessourceBundle to be used for reporting.log
- the log object enabling logging within maven plugins.Method Detail |
---|
public org.apache.maven.plugin.logging.Log getLog()
public org.apache.maven.doxia.sink.Sink getSink()
public ResourceBundle getResourceBundle()
protected void codeItemListHelper(String text)
text
- the text to write within the code tags.protected void paragraphHelper(String text)
text
- the text to write within the paragraph.protected void subtitleHelper(String text)
text
- the text to write as a subtitle.protected void codeCellHelper(String text)
text
- the text to write within a cell and within code tags.protected void headerCellHelper(String text)
text
- the text to write within a table header cell.protected void tableCellHelper(String text)
text
- the text to write within a table cell.protected void startSection(String link, String title)
link
- the anchor link.title
- the title of the anchor link.protected void endSection()
protected String getString(String key)
key
- the key for the desired string.
protected void doIntro(boolean withNavigationBar)
withNavigationBar
- a boolean stating wether or not the navigationBar should be displayed.protected void navigationBar()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |