org.xwiki.edit

Class AbstractEditor<D>

java.lang.Object

org.xwiki.edit.AbstractEditor<D>

Type Parameters:

D - the type of data that can be edited by this editor

All Implemented Interfaces:

Editor<D>

Direct Known Subclasses:

AbstractTemplateEditor

@Unstable
public abstract class AbstractEditor<D>
extends Object
implements Editor<D>

Base class for editors that take their input from the ScriptContext.

Since:

8.2RC1

Version:

$Id: b6c412be68d209cfc2fbc6768e406b36e24b41fe $

Constructor Summary

Constructors

Constructor and Description
AbstractEditor()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getEditContext(D data, Map<String,Object> parameters)
protected abstract String	render()
String	render(D data, Map<String,Object> parameters) Generates the HTML code needed to edit the given data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.edit.Editor

getDescriptor

Constructor Detail

AbstractEditor

public AbstractEditor()

Method Detail

render

public String render(D data,
                     Map<String,Object> parameters)
              throws EditException

Description copied from interface: Editor

Generates the HTML code needed to edit the given data.

Specified by:

render in interface Editor<D>

Parameters:

data - the data to edit

parameters - editor parameters

Returns:

the HTML code that displays the editor

Throws:

EditException - if the editor fails to be rendered

getEditContext

protected Map<String,Object> getEditContext(D data,
                                            Map<String,Object> parameters)

render

protected abstract String render()
                          throws EditException

Throws:

EditException