|
||||||||||
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.RecordingDocumentBuilder
public class RecordingDocumentBuilder
Nested Class Summary | |
---|---|
static class |
RecordingDocumentBuilder.Event
|
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.DocumentBuilder |
---|
locator |
Constructor Summary | |
---|---|
RecordingDocumentBuilder()
|
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. |
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. |
List<RecordingDocumentBuilder.Event> |
getEvents()
|
void |
image(Attributes attributes,
String url)
Build the image with the given attributes |
void |
imageLink(Attributes linkAttributes,
Attributes attributes,
String href,
String imageUrl)
Create a hyperlink whose visual representation is an image. |
void |
lineBreak()
Create a line break (eg: br in html). |
void |
link(Attributes attributes,
String hrefOrHashName,
String text)
Create a hyperlink to the given url. |
String |
toString()
|
Methods inherited from class org.eclipse.mylyn.wikitext.core.parser.DocumentBuilder |
---|
annotation, beginLink, endLink, getLocator, imageLink, imageLink, link, setLocator |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RecordingDocumentBuilder()
Method Detail |
---|
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 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 beginDocument()
DocumentBuilder
DocumentBuilder.endDocument()
.
beginDocument
in class DocumentBuilder
DocumentBuilder.endDocument()
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 beginSpan(DocumentBuilder.SpanType type, Attributes attributes)
DocumentBuilder
DocumentBuilder.endSpan()
.
beginSpan
in class DocumentBuilder
attributes
- the attributes to apply to the spanDocumentBuilder.endSpan()
public void characters(String text)
DocumentBuilder
characters
in class DocumentBuilder
text
- the text to emit.public void charactersUnescaped(String literal)
DocumentBuilder
charactersUnescaped
in class DocumentBuilder
literal
- the literal characters to emitpublic void endBlock()
DocumentBuilder
started
.
endBlock
in class DocumentBuilder
public void endDocument()
DocumentBuilder
endDocument
in class DocumentBuilder
DocumentBuilder.endDocument()
public void endHeading()
DocumentBuilder
started
.
endHeading
in class DocumentBuilder
DocumentBuilder.beginHeading(int, Attributes)
public void endSpan()
DocumentBuilder
started
.
endSpan
in class DocumentBuilder
#beginSpan(org.eclipse.mylyn.wikitext.parser.DocumentBuilder.SpanType, Attributes)
public 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 attributes, 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
attributes
- 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 void link(Attributes attributes, String hrefOrHashName, String text)
DocumentBuilder
LinkAttributes
are used, the attributes must not have the
href
attribute set.
link
in class DocumentBuilder
attributes
- the attributes of the linkhrefOrHashName
- the url (which may be internal to the page if prefixed with a hash '#')text
- the text of the hyperlinkpublic List<RecordingDocumentBuilder.Event> getEvents()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |