A B D E G I O R S T W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractEditor<D> - Class in org.xwiki.edit
-
Base class for editors that take their input from the
ScriptContext
. - AbstractEditor() - Constructor for class org.xwiki.edit.AbstractEditor
- AbstractTemplateEditor<D> - Class in org.xwiki.edit
-
Base class for editors that are based on a template.
- AbstractTemplateEditor() - Constructor for class org.xwiki.edit.AbstractTemplateEditor
- AbstractTypedEditScriptService<D> - Class in org.xwiki.edit.script
-
Base class for specialized edit script services that target specific types of editors.
- AbstractTypedEditScriptService() - Constructor for class org.xwiki.edit.script.AbstractTypedEditScriptService
B
- build() - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Builds the editor descriptor.
D
- DocumentEditConfiguration - Interface in org.xwiki.edit
-
Configuration options for editing XWiki documents.
- DocumentEditScriptService - Class in org.xwiki.edit.script
-
Script service for XWiki document editing.
- DocumentEditScriptService() - Constructor for class org.xwiki.edit.script.DocumentEditScriptService
E
- EditConfiguration - Interface in org.xwiki.edit
-
Edit configuration options.
- EditException - Exception in org.xwiki.edit
-
An edit exception.
- EditException(String) - Constructor for exception org.xwiki.edit.EditException
-
Construct an exception with the specified detail message.
- EditException(String, Throwable) - Constructor for exception org.xwiki.edit.EditException
-
Construct an exception with the specified detail message and cause.
- Editor<D> - Interface in org.xwiki.edit
-
Base interface for editors.
- EditorConfiguration<D> - Interface in org.xwiki.edit
-
Interface used to customize the
EditConfiguration
for a specific data type. - EditorDescriptor - Interface in org.xwiki.edit
-
Describes an
Editor
. - EditorDescriptorBuilder - Interface in org.xwiki.edit
-
Builds an
EditorDescriptor
instance. - EditorManager - Interface in org.xwiki.edit
-
Manages the available
Editor
s. - EditScriptService - Class in org.xwiki.edit.script
-
Script oriented edit APIs.
- EditScriptService() - Constructor for class org.xwiki.edit.script.EditScriptService
G
- get(String) - Method in class org.xwiki.edit.script.EditScriptService
- getCategory() - Method in interface org.xwiki.edit.EditorDescriptor
- getDataType() - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getDefaultEditor() - Method in interface org.xwiki.edit.EditorConfiguration
-
Returns the component hint of the configured default editor or the id of the configured default editor category associated with the data type bound to this configuration.
- getDefaultEditor() - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getDefaultEditor(Type) - Method in interface org.xwiki.edit.EditConfiguration
-
Returns the component hint of the configured default editor or the id of the configured default editor category associated with the specified data type.
- getDefaultEditor(Type) - Method in interface org.xwiki.edit.EditorManager
- getDefaultEditor(Type) - Method in class org.xwiki.edit.script.EditScriptService
- getDefaultEditor(Type, String) - Method in interface org.xwiki.edit.EditConfiguration
-
Returns the component hint of the configured default editor within the specified category, or the id of the configured default editor sub-category within the specified category, associated with the specified data type.
- getDefaultEditor(Type, String) - Method in interface org.xwiki.edit.EditorManager
- getDefaultEditor(Type, String) - Method in class org.xwiki.edit.script.EditScriptService
- getDefaultEditor(String) - Method in interface org.xwiki.edit.EditorConfiguration
-
Returns the component hint of the configured default editor within the specified category, or the id of the configured default editor sub-category within the specified category, associated with the data type bound to this configuration.
- getDefaultEditor(String) - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getDefaultEditorId() - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getDefaultEditorId(Type) - Method in class org.xwiki.edit.script.EditScriptService
- getDefaultEditorId(Type, String) - Method in class org.xwiki.edit.script.EditScriptService
- getDefaultEditorId(String) - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getDefaultTextEditor() - Method in class org.xwiki.edit.script.SyntaxContentEditScriptService
- getDefaultTextEditor() - Method in class org.xwiki.edit.script.XDOMEditScriptService
- getDefaultWysiwygEditor() - Method in class org.xwiki.edit.script.SyntaxContentEditScriptService
- getDefaultWysiwygEditor() - Method in class org.xwiki.edit.script.XDOMEditScriptService
- getDescription() - Method in interface org.xwiki.edit.EditorDescriptor
- getDescriptor() - Method in interface org.xwiki.edit.Editor
- getEditContext(D, Map<String, Object>) - Method in class org.xwiki.edit.AbstractEditor
- getEditor(Type, String) - Method in interface org.xwiki.edit.EditorManager
- getEditor(Type, String) - Method in class org.xwiki.edit.script.EditScriptService
- getEditor(String) - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getEditors() - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getEditors(Type) - Method in interface org.xwiki.edit.EditorManager
- getEditors(Type) - Method in class org.xwiki.edit.script.EditScriptService
- getEditors(Type, String) - Method in interface org.xwiki.edit.EditorManager
- getEditors(Type, String) - Method in class org.xwiki.edit.script.EditScriptService
- getEditors(String) - Method in class org.xwiki.edit.script.AbstractTypedEditScriptService
- getIcon() - Method in interface org.xwiki.edit.EditorDescriptor
- getId() - Method in interface org.xwiki.edit.EditorDescriptor
- getName() - Method in interface org.xwiki.edit.EditorDescriptor
- getTemplateName() - Method in class org.xwiki.edit.AbstractTemplateEditor
I
- inPlaceEditingEnabled() - Method in interface org.xwiki.edit.DocumentEditConfiguration
- inPlaceEditingEnabled() - Method in class org.xwiki.edit.script.DocumentEditScriptService
O
- org.xwiki.edit - package org.xwiki.edit
- org.xwiki.edit.script - package org.xwiki.edit.script
R
- render() - Method in class org.xwiki.edit.AbstractEditor
- render() - Method in class org.xwiki.edit.AbstractTemplateEditor
- render(D, Map<String, Object>) - Method in class org.xwiki.edit.AbstractEditor
- render(D, Map<String, Object>) - Method in interface org.xwiki.edit.Editor
-
Generates the HTML code needed to edit the given data.
- ROLE_HINT - Static variable in class org.xwiki.edit.script.EditScriptService
-
The role hint of this component.
S
- setCategory(String) - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Sets the editor category.
- setDescription(String) - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Sets the editor description.
- setIcon(String) - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Sets the editor icon.
- setId(String) - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Sets the editor id.
- setName(String) - Method in interface org.xwiki.edit.EditorDescriptorBuilder
-
Sets the editor name.
- SyntaxContentEditScriptService - Class in org.xwiki.edit.script
-
Edit script service specialized in
SyntaxContent
Editor
s. - SyntaxContentEditScriptService() - Constructor for class org.xwiki.edit.script.SyntaxContentEditScriptService
T
- text(String, Syntax, Map<String, Object>) - Method in class org.xwiki.edit.script.SyntaxContentEditScriptService
-
Generates the HTML code needed to edit the given data.
W
- wysiwyg(String, Syntax, Map<String, Object>) - Method in class org.xwiki.edit.script.SyntaxContentEditScriptService
-
Generates the HTML code needed to edit the given data.
X
- XDOMEditScriptService - Class in org.xwiki.edit.script
-
Edit script service specialized in
XDOM
Editor
s. - XDOMEditScriptService() - Constructor for class org.xwiki.edit.script.XDOMEditScriptService
All Classes All Packages