com.xpn.xwiki.render.macro
Class AttachMacro

java.lang.Object
  org.radeox.macro.BaseMacro
      org.radeox.macro.BaseLocaleMacro
          com.xpn.xwiki.render.macro.AttachMacro

All Implemented Interfaces:

java.lang.Comparable, org.radeox.macro.LocaleMacro, org.radeox.macro.Macro

public class AttachMacro
extends org.radeox.macro.BaseLocaleMacro

Macro that outputs links to document attachments. Syntax: {attach:text|file|document|title|rel|id|fromIncludingDoc}

• text: The link text. If missing, the file name is used.
• file: The target filename. If missing, the link text is used.
• document: The document to which the file is attached. If missing, the current document is used.
• title: The title attribute of the link. If missing, no title.
• rel: The rel attribute of the link. If missing, no rel.
• id: The id attribute of the link. If missing, no id.
• fromIncludingDoc: If present, when the current document is included using #include*, use the top level document instead of the included one. This is useful for templates, for example.

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

AttachMacro()

Method Summary

void	execute(java.io.Writer writer, org.radeox.macro.parameter.MacroParameter params)
java.lang.String	getLocaleKey()

Methods inherited from class org.radeox.macro.BaseLocaleMacro

getName, setInitialContext

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, getDescription, getParamDescription, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachMacro

public AttachMacro()

Method Detail

getLocaleKey

public java.lang.String getLocaleKey()

execute

public void execute(java.io.Writer writer,
                    org.radeox.macro.parameter.MacroParameter params)
             throws java.lang.IllegalArgumentException,
                    java.io.IOException

Specified by:

execute in interface org.radeox.macro.Macro

Specified by:

execute in class org.radeox.macro.BaseMacro

Throws:

java.lang.IllegalArgumentException

java.io.IOException