com.monochromeroad.play.xwiki.rendering.plugin

DefaultXWikiMacro

class DefaultXWikiMacro [P] extends XWikiMacro[P]

XWiki macro takes some parameters (e.g. {{code for="java" /}}) to use in Play default component manager.

P

bean class that represents the macro's parameter.

Attributes
abstract
Linear Supertypes
XWikiMacro[P], AbstractMacro[P], Initializable, Macro[P], Comparable[org.xwiki.rendering.macro.Macro[_]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DefaultXWikiMacro
  2. XWikiMacro
  3. AbstractMacro
  4. Initializable
  5. Macro
  6. Comparable
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultXWikiMacro (name: String, description: String)(implicit c: ClassManifest[P])

    name

    macro name ({{xxx}}macro content{{/xxx}}).

    description

    description about the macro.

Abstract Value Members

  1. def exec (parameters: P, content: String, context: MacroTransformationContext): List[Block]

    Attributes
    abstract
    Definition Classes
    XWikiMacro

  2. def supportsInlineMode (): Boolean

    Attributes
    abstract
    Definition Classes
    Macro

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def compareTo (arg0: org.xwiki.rendering.macro.Macro[_]): Int

    Definition Classes
    AbstractMacro → Comparable

  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  10. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def execute (parameters: P, content: String, context: MacroTransformationContext): List[Block]

    Macro Implementation

    Macro Implementation

    parameters

    the bean instance created from the macro's parameter ({{ macro param="xxx"/}}

    content

    the macro's content (){{macro}}xxx{{/macro}})

    context

    the macro transformation context

    returns

    XDOM Blocks

    Definition Classes
    XWikiMacro → Macro

  12. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  13. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  14. def getDescriptor (): MacroDescriptor

    Definition Classes
    AbstractMacro → Macro

  15. def getPriority (): Int

    Definition Classes
    AbstractMacro → Macro

  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  17. def initialize (): Unit

    Definition Classes
    AbstractMacro → Initializable
    Annotations
    @throws()

  18. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  19. def macroName : String

    Definition Classes
    XWikiMacro

  20. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  21. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  22. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  23. def setDefaultCategory (arg0: String): Unit

    Attributes
    protected[macro]
    Definition Classes
    AbstractMacro

  24. def setDescriptor (arg0: MacroDescriptor): Unit

    Attributes
    protected[macro]
    Definition Classes
    AbstractMacro

  25. def setPriority (arg0: Int): Unit

    Definition Classes
    AbstractMacro

  26. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  27. def toString (): String

    Definition Classes
    AnyRef → Any

  28. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  29. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  30. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from XWikiMacro[P]

Inherited from AbstractMacro[P]

Inherited from Initializable

Inherited from Macro[P]

Inherited from Comparable[org.xwiki.rendering.macro.Macro[_]]

Inherited from AnyRef

Inherited from Any