|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.beandoc.output.SimpleDecorator
org.springframework.beandoc.output.HtmlDecorator
public class HtmlDecorator
HtmlDecorator decorates the DOM's with attributes used predominantly in the generation of HTML documentation. Bean properties on this class make it possible to specify titles, page footers, CSS URL's and whether graphs should be included in the HTML (whether they're generated or not).
Field Summary |
---|
Fields inherited from class org.springframework.beandoc.output.SimpleDecorator |
---|
logger |
Constructor Summary | |
---|---|
HtmlDecorator()
|
Method Summary | |
---|---|
protected void |
decorateElement(org.jdom.Element element)
Each Element in each input Document is iteratively
passed to this method allowing subclasses to add or amend any attributes they
desire. |
String |
getCssUrl()
An URI (absolute or relative) that will be added toi the HTML output as a <link rel="stylesheet"> tag in the header. |
String |
getTitle()
Title of the application context. |
void |
setCssUrl(String cssUrl)
Optional location of a CSS file that can be used to skin the beandoc output. |
void |
setFilenameStrategy(org.springframework.beandoc.output.FilenameStrategy filenameStrategy)
sets the filename resolution strategy to use for this decorator |
void |
setFooter(String footer)
Set a footer for each page which can contain HTML tags. |
void |
setIncludeGraphs(boolean includeGraphs)
Set to false if you wish the HTML documentation not to include images and links to graphing output. |
void |
setTitle(String title)
Sets the page titles for the documentation output. |
Methods inherited from class org.springframework.beandoc.output.SimpleDecorator |
---|
decorate, setFilter, setFilterNames |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HtmlDecorator()
Method Detail |
---|
protected void decorateElement(org.jdom.Element element)
SimpleDecorator
Element
in each input Document
is iteratively
passed to this method allowing subclasses to add or amend any attributes they
desire. It's possible to filter the view of the DOM, and thereby the list of
Element
s that will be passed to this method by setting a
Filter
on this instance.
decorateElement
in class SimpleDecorator
SimpleDecorator.decorateElement(org.jdom.Element)
public void setCssUrl(String cssUrl)
cssUrl
- a locations (absolute or relative to your output directory)
that the CSS file can be found which is used to skin the beandoc output.public String getCssUrl()
<link rel="stylesheet">
tag in the header. If none
is provided then a default CSS file is copied to the output directory and
linked in the HTML header.
public void setTitle(String title)
title
- the page title used in documentation outputpublic String getTitle()
<title>
tag in HTML
documentation.
public void setFooter(String footer)
footer
- the value to use as a footer for each beandoc pagepublic void setIncludeGraphs(boolean includeGraphs)
includeGraphs
- set to false to prevent graphs being included in
HTML documentation. True by default.public void setFilenameStrategy(org.springframework.beandoc.output.FilenameStrategy filenameStrategy)
filenameStrategy
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |