Package org.apache.wiki.htmltowiki.syntax.jspwiki

Class JSPWikiSyntaxDecorator

java.lang.Object

org.apache.wiki.htmltowiki.syntax.jspwiki.JSPWikiSyntaxDecorator

All Implemented Interfaces:

SyntaxDecorator

public class JSPWikiSyntaxDecorator
extends java.lang.Object
implements SyntaxDecorator

Syntax decorator which translates to JSPWiki syntax. Delegates each kind of XHTML element to its specific decorator.

Constructor Summary

Constructors

Constructor	Description
JSPWikiSyntaxDecorator()

Method Summary

Modifier and Type	Method	Description
void	a(org.jdom2.Element e)	Decorates an a element.
void	br(org.jdom2.Element base, org.jdom2.Element e)	Decorates a br element.
void	code(org.jdom2.Element e)	Decorates a code ot tt element.
void	dd(org.jdom2.Element e)	Decorates a dd element.
void	dl(org.jdom2.Element e)	Decorates a dl element.
void	dt(org.jdom2.Element e)	Decorates a dt element.
void	em(org.jdom2.Element e)	Decorates an em, i or address element.
void	form(org.jdom2.Element e)	Decorates a form element.
void	h1(org.jdom2.Element e)	Decorates an h1 element.
void	h2(org.jdom2.Element e)	Decorates an h2 element.
void	h3(org.jdom2.Element e)	Decorates an h3 element.
void	h4(org.jdom2.Element e)	Decorates an h4 element.
void	hr(org.jdom2.Element e)	Decorates an hr element.
void	image(java.lang.String src, java.util.Map<java.lang.String,java.lang.Object> imageAttrs)	Decorates an image element.
void	img(org.jdom2.Element e)	Decorates an image element.
void	init(java.io.PrintWriter out, java.util.Stack<java.lang.String> liStack, java.util.Stack<java.lang.String> preStack, WhitespaceTrimWriter outTrimmer, XHtmlToWikiConfig config, XHtmlElementToWikiTranslator chain)	Prepares the syntax decorator.
void	input(org.jdom2.Element e)	Decorates an input element.
void	li(org.jdom2.Element base, org.jdom2.Element e)	Decorates a li element.
void	ol(org.jdom2.Element e)	Decorates an ol element.
void	option(org.jdom2.Element base, org.jdom2.Element e)	Decorates an option element.
void	p(org.jdom2.Element e)	Decorates a p element.
void	paragraph(XHtmlElementToWikiTranslator.ElementDecoratorData dto)	Decorates a text paragraph.
void	pre(org.jdom2.Element e)	Decorates a pre element.
void	select(org.jdom2.Element e)	Decorates a select element.
void	strike(org.jdom2.Element e)	Decorates a strike element.
void	strong(org.jdom2.Element e)	Decorates a strong or b element.
void	sub(org.jdom2.Element e)	Decorates a sub element.
void	sup(org.jdom2.Element e)	Decorates an sup element.
void	table(org.jdom2.Element e)	Decorates a table element.
void	td(org.jdom2.Element e)	Decorates an td element.
void	text(org.jdom2.Text element)	Decorates a text element.
void	textarea(org.jdom2.Element e)	Decorates a textarea element.
void	th(org.jdom2.Element e)	Decorates a th element.
void	tr(org.jdom2.Element e)	Decorates a tr element.
void	ul(org.jdom2.Element e)	Decorates an ul element.
void	underline(org.jdom2.Element e)	Decorates an underline element.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSPWikiSyntaxDecorator

public JSPWikiSyntaxDecorator()

Method Detail

init

public void init(java.io.PrintWriter out,
                 java.util.Stack<java.lang.String> liStack,
                 java.util.Stack<java.lang.String> preStack,
                 WhitespaceTrimWriter outTrimmer,
                 XHtmlToWikiConfig config,
                 XHtmlElementToWikiTranslator chain)

Prepares the syntax decorator.

Specified by:

init in interface SyntaxDecorator

Parameters:

out - writer that will hold the resulting wiki markup.

liStack - stack containing the amount of nested lis.

preStack - stack containing the amount of nested pres.

outTrimmer - writer capable of trimming whitespaces and of checking if it's currently writing a line start.

config - xhtml to wiki configuration object.

chain - chain (in the chain of responsabilities pattern) that is expected to be called by the different xhtml decorations.

a

public void a(org.jdom2.Element e)
       throws org.jdom2.JDOMException

Decorates an a element.

Specified by:

a in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

br

public void br(org.jdom2.Element base,
               org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a br element.

Specified by:

br in interface SyntaxDecorator

Parameters:

base - parent of the XHTML element being translated.

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

code

public void code(org.jdom2.Element e)
          throws org.jdom2.JDOMException

Decorates a code ot tt element.

Specified by:

code in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

dd

public void dd(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a dd element.

Specified by:

dd in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

dl

public void dl(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a dl element.

Specified by:

dl in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

dt

public void dt(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a dt element.

Specified by:

dt in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

em

public void em(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an em, i or address element.

Specified by:

em in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

form

public void form(org.jdom2.Element e)
          throws org.jdom2.JDOMException

Decorates a form element.

Specified by:

form in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

hr

public void hr(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an hr element.

Specified by:

hr in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

h1

public void h1(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an h1 element.

Specified by:

h1 in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

h2

public void h2(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an h2 element.

Specified by:

h2 in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

h3

public void h3(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an h3 element.

Specified by:

h3 in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

h4

public void h4(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an h4 element.

Specified by:

h4 in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

image

public void image(java.lang.String src,
                  java.util.Map<java.lang.String,java.lang.Object> imageAttrs)

Decorates an image element. This is a terminal operation, that is, chain is not expected to be called by this method.

Specified by:

image in interface SyntaxDecorator

Parameters:

src - image source

imageAttrs - image attributes

img

public void img(org.jdom2.Element e)

Decorates an image element. This is a terminal operation, that is, chain is not expected to be called by this method.

Specified by:

img in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

input

public void input(org.jdom2.Element e)
           throws org.jdom2.JDOMException

Decorates an input element.

Specified by:

input in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

li

public void li(org.jdom2.Element base,
               org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a li element.

Specified by:

li in interface SyntaxDecorator

Parameters:

base - parent of the XHTML element being translated.

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

ol

public void ol(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an ol element.

Specified by:

ol in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

option

public void option(org.jdom2.Element base,
                   org.jdom2.Element e)
            throws org.jdom2.JDOMException

Decorates an option element.

Specified by:

option in interface SyntaxDecorator

Parameters:

base - parent of the XHTML element being translated.

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

p

public void p(org.jdom2.Element e)
       throws org.jdom2.JDOMException

Decorates a p element.

Specified by:

p in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

paragraph

public void paragraph(XHtmlElementToWikiTranslator.ElementDecoratorData dto)
               throws org.jdom2.JDOMException

Decorates a text paragraph.

Specified by:

paragraph in interface SyntaxDecorator

Parameters:

dto - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

pre

public void pre(org.jdom2.Element e)
         throws org.jdom2.JDOMException

Decorates a pre element.

Specified by:

pre in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

strong

public void strong(org.jdom2.Element e)
            throws org.jdom2.JDOMException

Decorates a strong or b element.

Specified by:

strong in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

table

public void table(org.jdom2.Element e)
           throws org.jdom2.JDOMException

Decorates a table element.

Specified by:

table in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

td

public void td(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an td element.

Specified by:

td in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

text

public void text(org.jdom2.Text element)

Decorates a text element. This is a terminal operation, that is, chain is not expected to be called by this method.

Specified by:

text in interface SyntaxDecorator

Parameters:

element - XHTML element being translated.

textarea

public void textarea(org.jdom2.Element e)
              throws org.jdom2.JDOMException

Decorates a textarea element.

Specified by:

textarea in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

th

public void th(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a th element.

Specified by:

th in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

tr

public void tr(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates a tr element.

Specified by:

tr in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

select

public void select(org.jdom2.Element e)
            throws org.jdom2.JDOMException

Decorates a select element.

Specified by:

select in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

strike

public void strike(org.jdom2.Element e)
            throws org.jdom2.JDOMException

Decorates a strike element.

Specified by:

strike in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

sub

public void sub(org.jdom2.Element e)
         throws org.jdom2.JDOMException

Decorates a sub element.

Specified by:

sub in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

sup

public void sup(org.jdom2.Element e)
         throws org.jdom2.JDOMException

Decorates an sup element.

Specified by:

sup in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

ul

public void ul(org.jdom2.Element e)
        throws org.jdom2.JDOMException

Decorates an ul element.

Specified by:

ul in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.

underline

public void underline(org.jdom2.Element e)
               throws org.jdom2.JDOMException

Decorates an underline element.

Specified by:

underline in interface SyntaxDecorator

Parameters:

e - XHTML element being translated.

Throws:

org.jdom2.JDOMException - if an error has ocurred parsing the xhtml chain.