trait Decorator extends AnyRef

This trait influences the behavior of the Markdown output of inline and block parsers and the complete transformer. Mix in this trait and override methods to change the behavior and override the "deco()" method in the respective parser/transformer to return your modified instances to change the output they create.

Inline element decoration methods always get passed the spanned text, so you have to prepend and append the opening/closing tags. For block elements there is always a method for the opening and closing tags. This is to make block processing more efficient to prevent unnecessary String building of whole blocks just to add tags. (The block building uses a StringBuilder internally and just appends the returned tags)

If you want line breaks after opening/closing block level tags, you have to add the newline yourself.

Linear Supertypes
AnyRef, Any
Known Subclasses
Decorator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Decorator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def allowVerbatimXml(): Boolean

    If true, inline xml tags and verbatim xml blocks are allowed, otherwise they are escaped and included as plain text

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def decorateBlockQuoteClose(): String

    used to print the end of a blockquote, defaults to "\n"

  8. def decorateBlockQuoteOpen(): String

    used to print the beginning of a blockquote, defaults to "

    "

    used to print the beginning of a blockquote, defaults to "

    "

  9. def decorateBreak(): String

    used to print out manual line breaks (default:
    )

  10. def decorateCode(code: String): String

    used to print out inline code (default: ...)

  11. def decorateCodeBlockClose(): String

    used to print the end of a code block, defaults to " \n" used to print the end of a code block, defaults to "

  12. def decorateCodeBlockOpen(): String

    used to print the beginning of a code block, defaults to " 

    "

    used to print the beginning of a code block, defaults to " 

    "
  13. def decorateEmphasis(text: String): String

    used to print out emphasized text (default ...)

  14. def decorateHeaderClose(headerNo: Int): String

    used to print the end of a header, defaults to "</h[headerNo]\n>"

  15. def decorateHeaderOpen(headerNo: Int): String

    used to print the beginning of a header, defaults to "<h[headerNo]>"

  16. def decorateImg(alt: String, src: String, title: Option[String]): String

    Used to print image elements (default: <img ...)

  17. def decorateItemClose(): String

    used to print the end of a list item, defaults to ""

  18. def decorateItemOpen(): String

    used to print the beginning of a list item, defaults to "

    used to print the beginning of a list item, defaults to "

    • "
  19. def decorateLink(text: String, url: String, title: Option[String]): String

    Used to print link elements (default: <a href...)

  20. def decorateOListClose(): String

    used to print the end of an ordered list, defaults to \n

  21. def decorateOListOpen(): String

    used to print the beginning of an ordered list, defaults to \n

  22. def decorateParagraphClose(): String

    used to print the end of a paragraph, defaults to "\n"

  23. def decorateParagraphOpen(): String

    used to print the beginning of a paragraph, defaults to "

    used to print the beginning of a paragraph, defaults to "

    "

  24. def decorateRuler(): String

    used to print a horizontal ruler defaults to "

    \n"

    used to print a horizontal ruler defaults to "

    \n"

  25. def decorateStrong(text: String): String

    Used to print out strong text (default: ...

  26. def decorateUListClose(): String

    used to print the end of an unordered list, defaults to "\n"

  27. def decorateUListOpen(): String

    used to print the beginning of an unordered list, defaults to "\n"

  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  33. def indentation(): String

    The string used to ident one level.

    The string used to ident one level. Defaults to the empty string

  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped