Package org.xwiki.edit
Interface Editor<D>
-
- Type Parameters:
D
- the type of data that can be edited by this editor
- All Known Implementing Classes:
AbstractEditor
,AbstractTemplateEditor
@Role public interface Editor<D>
Base interface for editors.- Since:
- 8.2RC1
- Version:
- $Id: 3f57983685c0457fdd7b7343608ca0e7168ef26c $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EditorDescriptor
getDescriptor()
String
render(D data, Map<String,Object> parameters)
Generates the HTML code needed to edit the given data.
-
-
-
Method Detail
-
getDescriptor
EditorDescriptor getDescriptor()
- Returns:
- this editor's descriptor
-
render
String render(D data, Map<String,Object> parameters) throws EditException
Generates the HTML code needed to edit the given data.- Parameters:
data
- the data to editparameters
- editor parameters- Returns:
- the HTML code that displays the editor
- Throws:
EditException
- if the editor fails to be rendered
-
-