|
Mylyn WikiText | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mylyn.wikitext.core.parser.DocumentBuilder
org.eclipse.mylyn.wikitext.core.parser.builder.AbstractXmlDocumentBuilder
org.eclipse.mylyn.wikitext.core.parser.builder.DocBookDocumentBuilder
public class DocBookDocumentBuilder
A builder that can emit Docbook
MarkupToDocbook
,
MarkupToDocbookTask
,
DitaBookMapDocumentBuilder
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.mylyn.wikitext.core.parser.DocumentBuilder |
---|
DocumentBuilder.BlockType, DocumentBuilder.SpanType |
Field Summary |
---|
Fields inherited from class org.eclipse.mylyn.wikitext.core.parser.builder.AbstractXmlDocumentBuilder |
---|
base, baseInHead, writer |
Fields inherited from class org.eclipse.mylyn.wikitext.core.parser.DocumentBuilder |
---|
locator |
Constructor Summary | |
---|---|
DocBookDocumentBuilder(Writer out)
|
|
DocBookDocumentBuilder(XmlStreamWriter writer)
|
Method Summary | |
---|---|
void |
acronym(String text,
String definition)
Emit an acronym |
void |
beginBlock(DocumentBuilder.BlockType type,
Attributes attributes)
Begin a block of the specified type. |
void |
beginDocument()
Begin a document. |
void |
beginHeading(int level,
Attributes attributes)
Begin a heading of the specified level (usually 1-6). |
void |
beginSpan(DocumentBuilder.SpanType type,
Attributes attributes)
Begin a span of the specified type. |
void |
characters(String text)
Emit the given text as characters where special characters are encoded according to the output format rules. |
void |
charactersUnescaped(String literal)
Create unescaped characters, usually with some embedded HTML markup. |
protected XmlStreamWriter |
createFormattingXmlStreamWriter(Writer out)
|
void |
endBlock()
End a block that was started . |
void |
endDocument()
End a document. |
void |
endHeading()
End a span that was started . |
void |
endSpan()
End a span that was started . |
void |
entityReference(String entity)
An XML entity reference. |
String |
getBookTitle()
|
String |
getDoctype()
|
void |
image(Attributes attributes,
String url)
Build the image with the given attributes |
void |
imageLink(Attributes linkAttributes,
Attributes imageAttributes,
String href,
String imageUrl)
Create a hyperlink whose visual representation is an image. |
boolean |
isAutomaticGlossary()
Indicate if this builder should generate an automatic glossary if acronyms are used. |
void |
lineBreak()
Create a line break (eg: br in html). |
void |
link(Attributes attributes,
String href,
String text)
Create a hyperlink to the given url |
void |
setAutomaticGlossary(boolean automaticGlossary)
Indicate if this builder should generate an automatic glossary if acronyms are used. |
void |
setBookTitle(String bookTitle)
|
void |
setDoctype(String doctype)
|
Methods inherited from class org.eclipse.mylyn.wikitext.core.parser.builder.AbstractXmlDocumentBuilder |
---|
createXmlStreamWriter, getBase, isBaseInHead, isExternalLink, makeUrlAbsolute, setBase, setBaseInHead |
Methods inherited from class org.eclipse.mylyn.wikitext.core.parser.DocumentBuilder |
---|
getLocator, imageLink, imageLink, link, setLocator |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocBookDocumentBuilder(Writer out)
public DocBookDocumentBuilder(XmlStreamWriter writer)
Method Detail |
---|
protected XmlStreamWriter createFormattingXmlStreamWriter(Writer out)
public String getDoctype()
public void setDoctype(String doctype)
public String getBookTitle()
public void setBookTitle(String bookTitle)
public void acronym(String text, String definition)
DocumentBuilder
acronym
in class DocumentBuilder
text
- the acronym to emitdefinition
- the definition of the acronym, which is typically displayed on mouse hoverpublic void link(Attributes attributes, String href, String text)
DocumentBuilder
link
in class DocumentBuilder
attributes
- the attributes of the linkhref
- the url (which may be internal to the page if prefixed with a hash '#')text
- the text of the hyperlinkpublic void beginBlock(DocumentBuilder.BlockType type, Attributes attributes)
DocumentBuilder
Attributes
class, in which case the builder may attempt to apply
the attributes specified. Builders may choose to ignore attributes, and should fail silently if the given
attributes are not as expected.
Each call to this method must be matched by a corresponding call to DocumentBuilder.endBlock()
.
beginBlock
in class DocumentBuilder
attributes
- the attributes to apply to the block. Callers may choose to specify a more specialized set of
attributes by providing a subclass instance.DocumentBuilder.endBlock()
public void endBlock()
DocumentBuilder
started
.
endBlock
in class DocumentBuilder
public void beginHeading(int level, Attributes attributes)
DocumentBuilder
DocumentBuilder.endHeading()
.
beginHeading
in class DocumentBuilder
level
- the level of the heading, usually 1-6attributes
- the attributes to apply to the headingDocumentBuilder.endHeading()
public void endHeading()
DocumentBuilder
started
.
endHeading
in class DocumentBuilder
DocumentBuilder.beginHeading(int, Attributes)
public void beginDocument()
DocumentBuilder
DocumentBuilder.endDocument()
.
beginDocument
in class DocumentBuilder
DocumentBuilder.endDocument()
public void beginSpan(DocumentBuilder.SpanType type, Attributes attributes)
DocumentBuilder
DocumentBuilder.endSpan()
.
beginSpan
in class DocumentBuilder
attributes
- the attributes to apply to the spanDocumentBuilder.endSpan()
public void endDocument()
DocumentBuilder
endDocument
in class DocumentBuilder
DocumentBuilder.endDocument()
public void endSpan()
DocumentBuilder
started
.
endSpan
in class DocumentBuilder
#beginSpan(org.eclipse.mylyn.wikitext.parser.DocumentBuilder.SpanType, Attributes)
public void characters(String text)
DocumentBuilder
characters
in class AbstractXmlDocumentBuilder
text
- the text to emit.public void charactersUnescaped(String literal)
DocumentBuilder
charactersUnescaped
in class DocumentBuilder
literal
- the literal characters to emitpublic void entityReference(String entity)
DocumentBuilder
entityReference
in class DocumentBuilder
entity
- the entitypublic void image(Attributes attributes, String url)
DocumentBuilder
image
in class DocumentBuilder
attributes
- the attributes, which may be an ImageAttributes
.url
- the URL to the image, possibly relativepublic void imageLink(Attributes linkAttributes, Attributes imageAttributes, String href, String imageUrl)
DocumentBuilder
<a href="..."><img src="..."/></a>
. In this case if the attributes define a css class then
the resulting HTML should look like this: <a href="..."><img src="..." class="..."/></a>
imageLink
in class DocumentBuilder
linkAttributes
- the attributes of the link, which may be LinkAttributes
imageAttributes
- the attributes of the image , which may be ImageAttributes
href
- the url (which may be internal to the page if prefixed with a hash '#')imageUrl
- the url of the image, which may be relativepublic void lineBreak()
DocumentBuilder
lineBreak
in class DocumentBuilder
public boolean isAutomaticGlossary()
appendix
with title 'Glossary' is added to
the document, with a glosslist
generated for all of the acronyms that appear in the document.
The default is true.
public void setAutomaticGlossary(boolean automaticGlossary)
appendix
with title 'Glossary' is added to
the document, with a glosslist
generated for all of the acronyms that appear in the document.
The default is true.
|
Mylyn WikiText | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |