- AbstractAnnotationEvent - Class in org.xwiki.annotation.event
-
Base class for all annotation Event.
- AbstractAnnotationEvent() - Constructor for class org.xwiki.annotation.event.AbstractAnnotationEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter, meaning that this event will match any
other annotation event (add, update, delete).
- AbstractAnnotationEvent(String, String) - Constructor for class org.xwiki.annotation.event.AbstractAnnotationEvent
-
Constructor initializing the event filter with a FixedNameEventFilter,
meaning that this event will match only comment events affecting the document matching the passed document name.
- AbstractAnnotationEvent(EventFilter) - Constructor for class org.xwiki.annotation.event.AbstractAnnotationEvent
-
Constructor using a custom EventFilter.
- AbstractAnnotationRenderer - Class in org.xwiki.annotation.renderer
-
Abstract class for annotation renderer, any specific syntax renderer should implement this class and provide the
specific annotation listener.
- AbstractAnnotationRenderer() - Constructor for class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
-
- accept(Character) - Method in interface org.xwiki.annotation.content.filter.Filter
-
- addAnnotation(String, String, String, int, String, Map<String, Object>) - Method in interface org.xwiki.annotation.AnnotationService
-
Adds an the specified annotation for the specified target.
- addAnnotation(String, Annotation) - Method in interface org.xwiki.annotation.io.IOService
-
Adds annotation on the specified target.
- alter(CharSequence) - Method in interface org.xwiki.annotation.content.ContentAlterer
-
- alter(AlteredContent) - Method in interface org.xwiki.annotation.content.ContentAlterer
-
Provides altering of an already altered content, such allowing for multiple alterers to be composed.
- AlteredContent - Interface in org.xwiki.annotation.content
-
This class models an altered content, by providing the translations of offsets from the original content to the
altered content.
- Annotation - Class in org.xwiki.annotation
-
This class wraps together the data needed to describe an annotation.
- Annotation(String) - Constructor for class org.xwiki.annotation.Annotation
-
Builds an annotation description for the annotation with the passed id: used for annotation updates where only a
part of the fields my need to be set.
- Annotation(String, String, String) - Constructor for class org.xwiki.annotation.Annotation
-
Builds an annotation for the passed selection in the context, used to pass an annotation to be added (which does
not have an id yet since it hasn't been stored yet).
- AnnotationAddedEvent - Class in org.xwiki.annotation.event
-
An event triggered when an annotation is added.
- AnnotationAddedEvent() - Constructor for class org.xwiki.annotation.event.AnnotationAddedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter, meaning that this event will match any
other annotation add event.
- AnnotationAddedEvent(String, String) - Constructor for class org.xwiki.annotation.event.AnnotationAddedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter,
meaning that this event will match only annotation add events affecting the document matching the passed document
name.
- AnnotationAddedEvent(EventFilter) - Constructor for class org.xwiki.annotation.event.AnnotationAddedEvent
-
Constructor using a custom EventFilter.
- AnnotationConfiguration - Interface in org.xwiki.annotation
-
The configuration of the Annotations Application for the current wiki.
- AnnotationDeletedEvent - Class in org.xwiki.annotation.event
-
An event triggered when an annotation is deleted.
- AnnotationDeletedEvent() - Constructor for class org.xwiki.annotation.event.AnnotationDeletedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter, meaning that this event will match any
other annotation delete event.
- AnnotationDeletedEvent(String, String) - Constructor for class org.xwiki.annotation.event.AnnotationDeletedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter,
meaning that this event will match only annotation delete events affecting the document matching the passed
document name.
- AnnotationDeletedEvent(EventFilter) - Constructor for class org.xwiki.annotation.event.AnnotationDeletedEvent
-
Constructor using a custom EventFilter.
- AnnotationEvent - Interface in org.xwiki.annotation.event
-
A base interface for all annotation events.
- AnnotationEvent - Class in org.xwiki.annotation.renderer
-
Class to hold information about an annotation event, namely its type (annotation start or end) and the annotation for
which the event takes place.
- AnnotationEvent(AnnotationEvent.AnnotationEventType, Annotation) - Constructor for class org.xwiki.annotation.renderer.AnnotationEvent
-
Builds an annotation event for the passed annotation and type.
- AnnotationEvent.AnnotationEventType - Enum in org.xwiki.annotation.renderer
-
The type of annotation event that can occur during the processing.
- AnnotationPrintRenderer - Interface in org.xwiki.annotation.renderer
-
An annotations print renderer is a PrintRenderer that also renders annotations on the content.
- AnnotationRightService - Interface in org.xwiki.annotation.rights
-
Service to provide functions to check access rights to annotations actions (viewing, adding annotations, editing).
- AnnotationService - Interface in org.xwiki.annotation
-
Component responsible for providing annotations related services: the management of annotations (retrieving, adding,
removing, updating) and rendering them on their respective targets.
- AnnotationServiceException - Exception in org.xwiki.annotation
-
General wrapping exception.
- AnnotationServiceException(String) - Constructor for exception org.xwiki.annotation.AnnotationServiceException
-
Builds an annotation exception with the specified message.
- AnnotationServiceException(Throwable) - Constructor for exception org.xwiki.annotation.AnnotationServiceException
-
Builds an annotation exception for the specified cause.
- AnnotationServiceException(String, Throwable) - Constructor for exception org.xwiki.annotation.AnnotationServiceException
-
Builds an annotation exception for the specified cause with the specified message.
- annotationsGenerator - Variable in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
-
The annotations generator listener to use in this renderer.
- AnnotationState - Enum in org.xwiki.annotation.maintainer
-
Used to specify if an annotation target has been altered by a document modification.
- AnnotationUpdatedEvent - Class in org.xwiki.annotation.event
-
An event triggered when an annotation is updated.
- AnnotationUpdatedEvent() - Constructor for class org.xwiki.annotation.event.AnnotationUpdatedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter, meaning that this event will match any
other annotation update event.
- AnnotationUpdatedEvent(String, String) - Constructor for class org.xwiki.annotation.event.AnnotationUpdatedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter,
meaning that this event will match only annotation update events affecting the document matching the passed
document name.
- AnnotationUpdatedEvent(EventFilter) - Constructor for class org.xwiki.annotation.event.AnnotationUpdatedEvent
-
Constructor using a custom EventFilter.
- AUTHOR_FIELD - Static variable in class org.xwiki.annotation.Annotation
-
The name of the field of this annotation author.