com.xpn.xwiki.render.macro
Class LinkMacro

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by org.radeox.macro.BaseLocaleMacro
          extended by com.xpn.xwiki.render.macro.LinkMacro
All Implemented Interfaces:
Comparable, org.radeox.macro.LocaleMacro, org.radeox.macro.Macro

Deprecated. It provides limited functionality compared to the wiki link syntax.

@Deprecated
public class LinkMacro
extends org.radeox.macro.BaseLocaleMacro

Radeox macro for the xwiki 1.0 syntax, offering linking capabilities. Syntax: {link:text|url|image}

text
The link text.
url
The target address. If missing, it is the same as the text
img
An image to print before the URL. Actually not used, this parameter is always ignored.

Version:
$Id: cde943402244a2905ed11c0b665a56ba225345e8 $

Field Summary
 
Fields inherited from class org.radeox.macro.BaseMacro
description, initialContext, paramDescription
 
Constructor Summary
LinkMacro()
          Deprecated.  
 
Method Summary
 void execute(Writer writer, org.radeox.macro.parameter.MacroParameter params)
          Deprecated. Main macro execution method, replaces the macro instance with the generated output.
 String getLocaleKey()
          Deprecated.  
 
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

LinkMacro

public LinkMacro()
Deprecated. 
Method Detail

getLocaleKey

public String getLocaleKey()
Deprecated. 

execute

public void execute(Writer writer,
                    org.radeox.macro.parameter.MacroParameter params)
             throws IllegalArgumentException,
                    IOException
Deprecated. 
Main macro execution method, replaces the macro instance with the generated output.

Specified by:
execute in interface org.radeox.macro.Macro
Specified by:
execute in class org.radeox.macro.BaseMacro
Parameters:
writer - the place where to write the output
params - the parameters this macro is called with
Throws:
IllegalArgumentException - if the mandatory argument (text) is missing
IOException - if the output cannot be written
See Also:
BaseMacro.execute(Writer, MacroParameter)


Copyright © 2004–2014 XWiki. All rights reserved.