Index (XWiki Platform - Annotations - Core Services 15.2 API)

A C D E F G H I L O P R S T U V
All Classes All Packages

A

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.
ALTERED - org.xwiki.annotation.maintainer.AnnotationState: An annotation is altered when the document on which it has been added changed and the annotation position could not be correctly found on the updated document.
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 - 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 - Interface in org.xwiki.annotation.event: A base interface for all annotation events.
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(String, Throwable) - Constructor for exception org.xwiki.annotation.AnnotationServiceException: Builds an annotation exception for the specified cause with the specified message.
AnnotationServiceException(Throwable) - Constructor for exception org.xwiki.annotation.AnnotationServiceException: Builds an annotation exception for the specified cause.
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.

C

canAddAnnotation(String, String) - Method in interface org.xwiki.annotation.rights.AnnotationRightService: Checks if the user can add annotations on the specified target.
canEditAnnotation(String, String, String) - Method in interface org.xwiki.annotation.rights.AnnotationRightService: Checks if the user can edit the specified annotation.
canUploadAttachment(String, String) - Method in interface org.xwiki.annotation.rights.AnnotationRightService: Checks if the user can upload attachment to the page as part of adding or editing an annotation.
canViewAnnotatedTarget(String, String) - Method in interface org.xwiki.annotation.rights.AnnotationRightService: Checks if the specified user can view the passed target annotated (which implies view on the target itself and the ability to view the annotations).
canViewAnnotations(String, String) - Method in interface org.xwiki.annotation.rights.AnnotationRightService: Checks if the specified user can view the annotations on the specific target.
ChainingPrintRenderer - Interface in org.xwiki.annotation.renderer: A chaining print renderer is a print renderer which can be chained in a listener chain.
CONFIGURATION_PAGE_NAME - Static variable in interface org.xwiki.annotation.AnnotationConfiguration: The configuration page's name.
CONFIGURATION_PAGE_SPACE_NAME - Static variable in interface org.xwiki.annotation.AnnotationConfiguration: The configuration page's space name.
ContentAlterer - Interface in org.xwiki.annotation.content: Service that provides functionality for filtering a sequence of characters and producing an altered content from an original content.

D

DATE_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation serialized date.

E

END - org.xwiki.annotation.renderer.AnnotationEvent.AnnotationEventType: Marks the end of an annotation.
endLink(ResourceReference, boolean, Map<String, String>) - Method in class org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener
equals(Object) - Method in class org.xwiki.annotation.Annotation
extractText(String, Syntax) - Method in interface org.xwiki.annotation.content.TextExtractor: Extract text from content considering the associated syntax.

F

fields - Variable in class org.xwiki.annotation.Annotation: The values of the fields of this annotation.
Filter - Interface in org.xwiki.annotation.content.filter: This component defines a filter to be used by alterers.

G

GeneratorEmptyBlockChainingListener - Class in org.xwiki.annotation.renderer: Empty block chaining listener to push in the chain before the generator listener.
GeneratorEmptyBlockChainingListener(ListenerChain) - Constructor for class org.xwiki.annotation.renderer.GeneratorEmptyBlockChainingListener: Builds a new empty block chaining listener to push in the passed chain.
get(String) - Method in class org.xwiki.annotation.Annotation
getAlteredOffset(int) - Method in interface org.xwiki.annotation.content.AlteredContent
getAnnotatedHTML(String) - Method in interface org.xwiki.annotation.AnnotationService: Returns the XHTML of the requested source, along with annotations inserted as span elements inside it.
getAnnotatedRenderedContent(String, String, String, Collection<Annotation>) - Method in interface org.xwiki.annotation.AnnotationService: Returns result obtained by rendering with annotations markers the source referenced by the sourceReference parsed in sourceSyntax.
getAnnotation() - Method in class org.xwiki.annotation.renderer.AnnotationEvent
getAnnotation(String, String) - Method in interface org.xwiki.annotation.AnnotationService: Returns the annotation identified by id on the specified target.
getAnnotation(String, String) - Method in interface org.xwiki.annotation.io.IOService
getAnnotationClassReference() - Method in interface org.xwiki.annotation.AnnotationConfiguration
getAnnotationPrintRenderer(ListenerChain) - Method in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
getAnnotations(String) - Method in interface org.xwiki.annotation.AnnotationService: Returns all the annotations on the passed content.
getAnnotations(String) - Method in interface org.xwiki.annotation.io.IOService: Returns all the annotations on the passed content.
getAuthor() - Method in class org.xwiki.annotation.Annotation
getContent() - Method in interface org.xwiki.annotation.content.AlteredContent
getDate() - Method in class org.xwiki.annotation.Annotation
getEmptyBlockState() - Method in class org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener
getExceptionSpaces() - Method in interface org.xwiki.annotation.AnnotationConfiguration
getFieldNames() - Method in class org.xwiki.annotation.Annotation
getId() - Method in class org.xwiki.annotation.Annotation
getIdentifier() - Method in class org.xwiki.annotation.event.AbstractAnnotationEvent
getIdentifier() - Method in interface org.xwiki.annotation.event.AnnotationEvent: Retrieves the identifier of the annotation added/updated/deleted in the event.
getInitialLength() - Method in interface org.xwiki.annotation.content.AlteredContent
getInitialOffset(int) - Method in interface org.xwiki.annotation.content.AlteredContent
getLinkLabelGenerator() - Method in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer: Getter for the link label generator to be used for generating link labels in this mapping and rendering process for links that don't have labels.
getOriginalSelection() - Method in class org.xwiki.annotation.Annotation
getSelection() - Method in class org.xwiki.annotation.Annotation
getSelectionInContext() - Method in class org.xwiki.annotation.Annotation: Helper method to get the selection of this annotation in its context, with the context left to the left and context right to the right.
getSelectionLeftContext() - Method in class org.xwiki.annotation.Annotation
getSelectionRightContext() - Method in class org.xwiki.annotation.Annotation
getSource(String) - Method in interface org.xwiki.annotation.io.IOTargetService: Deprecated.
use IOTargetService.getXDOM(String)
getSourceSyntax(String) - Method in interface org.xwiki.annotation.io.IOTargetService
getState() - Method in class org.xwiki.annotation.Annotation
getType() - Method in class org.xwiki.annotation.renderer.AnnotationEvent
getValidAnnotations(String) - Method in interface org.xwiki.annotation.AnnotationService: Shortcut function to get all annotations which are valid on the specified target, regardless of the updates the document and its annotations suffered from creation ('safe' or 'updated' state).
getXDOM(String) - Method in interface org.xwiki.annotation.io.IOTargetService
getXDOM(String, String) - Method in interface org.xwiki.annotation.io.IOTargetService

H

hashCode() - Method in class org.xwiki.annotation.Annotation

I

id - Variable in class org.xwiki.annotation.Annotation: The unique identifier of this annotation, which should be unique among all the annotations on the same target.
initialize() - Method in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
IOService - Interface in org.xwiki.annotation.io: This component provides services related to annotations storage and retrieval.
IOServiceException - Exception in org.xwiki.annotation.io: Thrown when an input/output error occurs.
IOServiceException(String) - Constructor for exception org.xwiki.annotation.io.IOServiceException: Builds an IOService exception with the specified message.
IOServiceException(String, Throwable) - Constructor for exception org.xwiki.annotation.io.IOServiceException: Builds an IOService exception for the specified cause with the specified message.
IOTargetService - Interface in org.xwiki.annotation.io: This service provides functions to operate with annotations targets.
isActivated() - Method in interface org.xwiki.annotation.AnnotationConfiguration
isDisplayedByDefault() - Method in interface org.xwiki.annotation.AnnotationConfiguration
isDisplayedHighlightedByDefault() - Method in interface org.xwiki.annotation.AnnotationConfiguration
isInstalled() - Method in interface org.xwiki.annotation.AnnotationConfiguration

L

linkLabelGenerator - Variable in class org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener: The generator for the link labels.
LinkLabelGeneratorChainingListener - Class in org.xwiki.annotation.renderer: Chaining listener to generate labels for the links without labels and send these labels as events in the chain.
LinkLabelGeneratorChainingListener(LinkLabelGenerator, StreamParser, ListenerChain) - Constructor for class org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener: Creates a new link generator chaining listener.
linkLabelParser - Variable in class org.xwiki.annotation.renderer.LinkLabelGeneratorChainingListener: The parser for the link labels, used to parse the generated labels and create events to the next listener in the chain.

O

org.xwiki.annotation - package org.xwiki.annotation
org.xwiki.annotation.content - package org.xwiki.annotation.content
org.xwiki.annotation.content.filter - package org.xwiki.annotation.content.filter
org.xwiki.annotation.event - package org.xwiki.annotation.event
org.xwiki.annotation.io - package org.xwiki.annotation.io
org.xwiki.annotation.maintainer - package org.xwiki.annotation.maintainer
org.xwiki.annotation.renderer - package org.xwiki.annotation.renderer
org.xwiki.annotation.rights - package org.xwiki.annotation.rights
ORIGINAL_SELECTION_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation original selection.

P

PLAIN_TEXT_END_OFFSET_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation end offset relative to the plain text.
PLAIN_TEXT_START_OFFSET_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation start offset relative to the plain text.
plainTextParser - Variable in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer: Plain text parser used to parse generated link labels.

R

removeAnnotation(String, String) - Method in interface org.xwiki.annotation.AnnotationService: Remove an annotation given by its identifier, which should be unique among all annotations on the same target.
removeAnnotation(String, String) - Method in interface org.xwiki.annotation.io.IOService: Removes an annotation given by its identifier, which should be unique among all annotations on the same target.

S

SAFE - org.xwiki.annotation.maintainer.AnnotationState: An annotation is safe when it is valid and can be rendered on the document it has been added.
SELECTION_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation selection.
SELECTION_LEFT_CONTEXT_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation selection context to the left of the annotation.
SELECTION_RIGHT_CONTEXT_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation selection context to the right of the annotation.
selectionAlterer - Variable in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer: Selection cleaner so that the selection can be mapped on the content.
set(String, Object) - Method in class org.xwiki.annotation.Annotation: Sets / adds a value in the fields of this annotation.
setAnnotations(Collection<Annotation>) - Method in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
setAnnotations(Collection<Annotation>) - Method in interface org.xwiki.annotation.renderer.AnnotationPrintRenderer: Sets the annotations to render on the content.
setAuthor(String) - Method in class org.xwiki.annotation.Annotation: Sets the author of this annotation.
setDate(Date) - Method in class org.xwiki.annotation.Annotation
setOriginalSelection(String) - Method in class org.xwiki.annotation.Annotation
setSelection(String) - Method in class org.xwiki.annotation.Annotation: Sets the selection of this annotation.
setSelection(String, String, String) - Method in class org.xwiki.annotation.Annotation: Sets the selection of this annotation and the context along with it.
setState(AnnotationState) - Method in class org.xwiki.annotation.Annotation
START - org.xwiki.annotation.renderer.AnnotationEvent.AnnotationEventType: Marks the start of an annotation.
STATE_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation state.

T

TARGET_FIELD - Static variable in class org.xwiki.annotation.Annotation: The name of the field of this annotation's reference to the target content.
textExtractor - Variable in class org.xwiki.annotation.renderer.AbstractAnnotationRenderer
TextExtractor - Interface in org.xwiki.annotation.content: Component responsible for extracting plain text from inside a given String depending on the syntax associated with it.
toString() - Method in class org.xwiki.annotation.Annotation

U

updateAnnotation(String, Annotation) - Method in interface org.xwiki.annotation.AnnotationService: Updates the passed annotation with the new values.
updateAnnotations(String, Collection<Annotation>) - Method in interface org.xwiki.annotation.io.IOService: Updates the set of annotations in the annotations store.
UPDATED - org.xwiki.annotation.maintainer.AnnotationState: An annotation is updated if its selected text has suffered a modification and it could be detected and recovered during the maintaining process.

V

valueOf(String) - Static method in enum org.xwiki.annotation.maintainer.AnnotationState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.annotation.renderer.AnnotationEvent.AnnotationEventType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.annotation.maintainer.AnnotationState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.annotation.renderer.AnnotationEvent.AnnotationEventType: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L O P R S T U V
All Classes All Packages