Skip navigation links
A C G O R U 

A

addAnnotation(String, String, String, int, String, Map<String, Object>) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Adds an the specified annotation for the specified target.
AnnotationScriptService - Class in org.xwiki.annotation.script
Wrapper for the annotation service functions to be exposed to scripting contexts.
AnnotationScriptService() - Constructor for class org.xwiki.annotation.script.AnnotationScriptService
 

C

canAddAnnotation(String, String, String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Deprecated.
since 7.2M3, use canAddAnnotation(DocumentReference) instead
canAddAnnotation(DocumentReference) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Checks if the current user can add an annotation on the document given by the reference.
canEditAnnotation(String, String, String, String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Deprecated.
canEditAnnotation(String, DocumentReference) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Checks if the current user can edit an annotation on the document given by wiki, space and page.

G

getAnnotatedHTML(String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Returns the XHTML of the requested source, along with annotations inserted as span elements inside it.
getAnnotatedRenderedContent(String, String, String, Collection<Annotation>) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Returns result obtained by rendering with annotations markers the source referenced by the sourceReference parsed in sourceSyntax.
getAnnotation(String, String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Returns the annotation identified by id on the specified target.
getAnnotation(EntityReference, String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Returns the annotation identified by id on the specified target.
getAnnotations(String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Returns all the annotations on the passed content.
getValidAnnotations(String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
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).

O

org.xwiki.annotation.script - package org.xwiki.annotation.script
 

R

removeAnnotation(String, String) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Remove an annotation given by its identifier, which should be unique among all annotations on the same target.

U

updateAnnotation(String, Annotation) - Method in class org.xwiki.annotation.script.AnnotationScriptService
Updates the passed annotation with the new values.
A C G O R U 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.