DefaultDecorator (txtmark 0.13 API)

java.lang.Object
- com.github.rjeschke.txtmark.DefaultDecorator

All Implemented Interfaces:: Decorator

public class DefaultDecorator
extends Object
implements Decorator

Default Decorator implementation.

Example for a user Decorator having a class attribute on tags.

 public class MyDecorator extends DefaultDecorator
 {
     @Override
     public void openParagraph(StringBuilder out)
     {
         out.append("<p class=\"myclass\">");
     }
 }

Author:: René Jeschke <rene_jeschke@yahoo.de>

Constructor Summary

Constructors
Constructor and Description

DefaultDecorator()
Constructor.

Constructors
Constructor and Description
`DefaultDecorator()` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeBlockquote(StringBuilder out)` Called when a blockquote is closed.
`void`	`closeCodeBlock(StringBuilder out)` Called when a code block is closed.
`void`	`closeCodeSpan(StringBuilder out)` Called when a code span is closed.
`void`	`closeEmphasis(StringBuilder out)` Called when an emphasis span is closed.
`void`	`closeHeadline(StringBuilder out, int level)` Called when a headline is closed.
`void`	`closeImage(StringBuilder out)` Called when an image is closed.
`void`	`closeLink(StringBuilder out)` Called when a link is closed
`void`	`closeListItem(StringBuilder out)` Called when a list item is closed.
`void`	`closeOrderedList(StringBuilder out)` Called when an ordered list is closed.
`void`	`closeParagraph(StringBuilder out)` Called when a paragraph is closed.
`void`	`closeStrong(StringBuilder out)` Called when a strong span is closed.
`void`	`closeSuper(StringBuilder out)` Called when a superscript span is closed.
`void`	`closeUnorderedList(StringBuilder out)` Called when an unordered list is closed.
`void`	`horizontalRuler(StringBuilder out)` Called when a horizontal ruler is encountered.
`void`	`openBlockquote(StringBuilder out)` Called when a blockquote is opened.
`void`	`openCodeBlock(StringBuilder out)` Called when a code block is opened.
`void`	`openCodeSpan(StringBuilder out)` Called when a code span is opened.
`void`	`openEmphasis(StringBuilder out)` Called when an emphasis span is opened.
`void`	`openHeadline(StringBuilder out, int level)` Called when a headline is opened.
`void`	`openImage(StringBuilder out)` Called when an image is opened.
`void`	`openLink(StringBuilder out)` Called when a link is opened.
`void`	`openListItem(StringBuilder out)` Called when a list item is opened.
`void`	`openOrderedList(StringBuilder out)` Called when an ordered list is opened.
`void`	`openParagraph(StringBuilder out)` Called when a paragraph is opened.
`void`	`openStrong(StringBuilder out)` Called when a strong span is opened.
`void`	`openSuper(StringBuilder out)` Called when a superscript span is opened.
`void`	`openUnorderedList(StringBuilder out)` Called when an unordered list is opened.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - DefaultDecorator
```
public DefaultDecorator()
```
 Constructor.
- Method Detail
 - openParagraph
```
public void openParagraph(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a paragraph is opened.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 openParagraph in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openParagraph(StringBuilder)
 - closeParagraph
```
public void closeParagraph(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a paragraph is closed.
 Default implementation is:
```
 out.append("\n");
 
```
 Specified by:
 
 closeParagraph in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeParagraph(StringBuilder)
 - openBlockquote
```
public void openBlockquote(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a blockquote is opened. Default implementation is:
```
 out.append("<blockquote>");
 
```
 Specified by:
 
 openBlockquote in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openBlockquote(StringBuilder)
 - closeBlockquote
```
public void closeBlockquote(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a blockquote is closed.
 Default implementation is:
```
 out.append("</blockquote>\n");
 
```
 Specified by:
 
 closeBlockquote in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeBlockquote(StringBuilder)
 - openCodeBlock
```
public void openCodeBlock(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a code block is opened.
 Default implementation is:
```
 out.append("<pre><code>");
 
```
 Specified by:
 
 openCodeBlock in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openCodeBlock(StringBuilder)
 - closeCodeBlock
```
public void closeCodeBlock(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a code block is closed.
 Default implementation is:
```
 out.append("</code></pre>\n");
 
```
 Specified by:
 
 closeCodeBlock in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeCodeBlock(StringBuilder)
 - openCodeSpan
```
public void openCodeSpan(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a code span is opened.
 Default implementation is:
```
 out.append("<code>");
 
```
 Specified by:
 
 openCodeSpan in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openCodeSpan(StringBuilder)
 - closeCodeSpan
```
public void closeCodeSpan(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a code span is closed.
 Default implementation is:
```
 out.append("</code>");
 
```
 Specified by:
 
 closeCodeSpan in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeCodeSpan(StringBuilder)
 - openHeadline
```
public void openHeadline(StringBuilder out,
 int level)
```
 Description copied from interface: Decorator
 Called when a headline is opened.
 Note: Don't close the HTML tag!
 
 Default implementation is:
```
 out.append("<h");
 out.append(level);
 
```
 Specified by:
 
 openHeadline in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 level - The level to use.
 See Also:
 Decorator.openHeadline(StringBuilder, int)
 - closeHeadline
```
public void closeHeadline(StringBuilder out,
 int level)
```
 Description copied from interface: Decorator
 Called when a headline is closed.
 Default implementation is:
```
 out.append("</h");
 out.append(level);
 out.append(">\n");
 
```
 Specified by:
 
 closeHeadline in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 level - The level to use.
 See Also:
 Decorator.closeHeadline(StringBuilder, int)
 - openStrong
```
public void openStrong(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a strong span is opened.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 openStrong in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openStrong(StringBuilder)
 - closeStrong
```
public void closeStrong(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a strong span is closed.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 closeStrong in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeStrong(StringBuilder)
 - openEmphasis
```
public void openEmphasis(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an emphasis span is opened.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 openEmphasis in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openEmphasis(StringBuilder)
 - closeEmphasis
```
public void closeEmphasis(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an emphasis span is closed.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 closeEmphasis in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeEmphasis(StringBuilder)
 - openSuper
```
public void openSuper(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a superscript span is opened.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 openSuper in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openSuper(StringBuilder)
 - closeSuper
```
public void closeSuper(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a superscript span is closed.
 Default implementation is:
```
 out.append("");
 
```
 Specified by:
 
 closeSuper in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeSuper(StringBuilder)
 - openOrderedList
```
public void openOrderedList(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an ordered list is opened.
 Default implementation is:
```
 out.append("<ol>\n");
 
```
 Specified by:
 
 openOrderedList in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openOrderedList(StringBuilder)
 - closeOrderedList
```
public void closeOrderedList(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an ordered list is closed.
 Default implementation is:
```
 out.append("</ol>\n");
 
```
 Specified by:
 
 closeOrderedList in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeOrderedList(StringBuilder)
 - openUnorderedList
```
public void openUnorderedList(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an unordered list is opened.
 Default implementation is:
```
 out.append("<ul>\n");
 
```
 Specified by:
 
 openUnorderedList in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openUnorderedList(StringBuilder)
 - closeUnorderedList
```
public void closeUnorderedList(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an unordered list is closed.
 Default implementation is:
```
 out.append("</ul>\n");
 
```
 Specified by:
 
 closeUnorderedList in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeUnorderedList(StringBuilder)
 - openListItem
```
public void openListItem(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a list item is opened.
 Note: Don't close the HTML tag!
 
 Default implementation is:
```
 out.append("<li");
 
```
 Specified by:
 
 openListItem in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openListItem(StringBuilder)
 - closeListItem
```
public void closeListItem(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a list item is closed.
 Default implementation is:
```
 out.append("</li>\n");
 
```
 Specified by:
 
 closeListItem in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeListItem(StringBuilder)
 - horizontalRuler
```
public void horizontalRuler(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a horizontal ruler is encountered.
 Default implementation is:
```
 out.append("<hr />\n");
 
```
 Specified by:
 
 horizontalRuler in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.horizontalRuler(StringBuilder)
 - openLink
```
public void openLink(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a link is opened.
 Note: Don't close the HTML tag!
 
 Default implementation is:
```
 out.append("<a");
 
```
 Specified by:
 
 openLink in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openLink(StringBuilder)
 - closeLink
```
public void closeLink(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when a link is closed
 Default implementation is:
```
 out.append("</a>");
 
```
 Specified by:
 
 closeLink in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeLink(StringBuilder)
 - openImage
```
public void openImage(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an image is opened.
 Note: Don't close the HTML tag!
 
 Default implementation is:
```
 out.append("<img");
 
```
 Specified by:
 
 openImage in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.openImage(StringBuilder)
 - closeImage
```
public void closeImage(StringBuilder out)
```
 Description copied from interface: Decorator
 Called when an image is closed.
 Default implementation is:
```
 out.append(" />");
 
```
 Specified by:
 
 closeImage in interface Decorator
 
 Parameters:
 out - The StringBuilder to write to.
 See Also:
 Decorator.closeImage(StringBuilder)

Class DefaultDecorator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultDecorator

Method Detail

openParagraph

closeParagraph

openBlockquote

closeBlockquote

openCodeBlock

closeCodeBlock

openCodeSpan

closeCodeSpan

openHeadline

closeHeadline

openStrong

closeStrong

openEmphasis

closeEmphasis

openSuper

closeSuper

openOrderedList

closeOrderedList

openUnorderedList

closeUnorderedList

openListItem

closeListItem

horizontalRuler

openLink

closeLink

openImage

closeImage