AnnotationController (Nuxeo ECM Projects 7.2-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.platform.annotations.gwt.client.controler.AnnotationController

public class AnnotationController
extends Object

Author:: Alexandre Russel

Constructor Summary

Constructors
Constructor and Description

AnnotationController(WebConfiguration webConfiguration, boolean onFrame)

Constructors
Constructor and Description
`AnnotationController(WebConfiguration webConfiguration, boolean onFrame)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addModelChangeListener(AnnotationChangeListener listener)`
`void`	`addNewAnnotation()`
`boolean`	`canAnnotate()`
`void`	`cancelNewAnnotation()`
`void`	`cancelNewAnnotationPopup()`
`boolean`	`canCreateNewCreationPopup()`
`void`	`closeCreationPopup()`
`void`	`createNewAnnotation(String pointer)`
`void`	`decorateDocument()`
`void`	`deleteAnnotation(int index)`
`void`	`disablePopupListeners()`
`void`	`enablePopupListeners()`
`String`	`filter(String xPointerFilter, com.google.gwt.dom.client.ImageElement image, String xpath, int i, int j, int k, int l)`
`Point[]`	`filterAnnotation(Point topLeft, Point bottomRight)`
`String`	`filterXPointer(com.google.gwt.dom.client.ImageElement image, String xpath, int i, int j, int k, int l)`
`AnnotatedDocument`	`getAnnotatedDocument()`
`String`	`getAnnoteaServerUrl()`
`String`	`getDecorateClassName()`
`String`	`getDocumentUrl()`
`int`	`getFrameScrollFromTop()`
`Annotation`	`getNewAnnotation()`
`NewAnnotationPopup`	`getNewAnnotationPopup()`
`WebConfiguration`	`getWebConfiguration()`
`void`	`hideAnnotations()`
`boolean`	`isAnnotationsVisible()`
`boolean`	`isImageOnly()`
`boolean`	`isMultiImage()`
`void`	`loadAnnotations()`
`void`	`newAnnotationCreated(Annotation annotation)`
`void`	`openCreationPopup()`
`void`	`registerAnnotationPopupListener(AnnotationPopupEventListener listener)`
`void`	`reloadAnnotations()`
`void`	`removeAnnotationPopupListener(AnnotationPopupEventListener listener)`
`void`	`removeSelectedTextDecoration()`
`void`	`setAnnotationDecoratorFunction(String annotationDecoratorFunction)`
`void`	`setAnnotationList(List<Annotation> annotations)`
`void`	`setCancelNewAnnotation()`
`void`	`setFirstAnnotationSelected()`
`void`	`setFrameScrollFromTop(int frameScrollFromTop)`
`void`	`setImageOnly(boolean b)`
`void`	`setMultiImage(boolean b)`
`void`	`setNewAnnotationPopup(NewAnnotationPopup popup)`
`void`	`setPointerAdapter(String pointerAdapter)`
`void`	`setXPointerFilter(String pointerFilter)`
`void`	`showAnnotations()`
`void`	`submitNewAnnotation()`
`static void`	`updateAnnotation()`
`static void`	`updateAnnotation(boolean forceDecorate)`
`void`	`updateAnnotations(boolean forceDecorate)`
`void`	`updateSelectedAnnotation(int index)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationController

public AnnotationController(WebConfiguration webConfiguration,
                    boolean onFrame)

Method Detail

addNewAnnotation
```
public void addNewAnnotation()
```

getWebConfiguration

public WebConfiguration getWebConfiguration()

getAnnotatedDocument

public AnnotatedDocument getAnnotatedDocument()

setXPointerFilter

public void setXPointerFilter(String pointerFilter)

setPointerAdapter

public void setPointerAdapter(String pointerAdapter)

canAnnotate
```
public boolean canAnnotate()
```

addModelChangeListener

public void addModelChangeListener(AnnotationChangeListener listener)

getFrameScrollFromTop
```
public int getFrameScrollFromTop()
```

setFrameScrollFromTop

public void setFrameScrollFromTop(int frameScrollFromTop)

canCreateNewCreationPopup

public boolean canCreateNewCreationPopup()

openCreationPopup
```
public void openCreationPopup()
```

closeCreationPopup
```
public void closeCreationPopup()
```

newAnnotationCreated

public void newAnnotationCreated(Annotation annotation)

submitNewAnnotation
```
public void submitNewAnnotation()
```

reloadAnnotations
```
public void reloadAnnotations()
```

cancelNewAnnotation
```
public void cancelNewAnnotation()
```

cancelNewAnnotationPopup

public void cancelNewAnnotationPopup()

createNewAnnotation

public void createNewAnnotation(String pointer)

setAnnotationList

public void setAnnotationList(List<Annotation> annotations)

getAnnoteaServerUrl
```
public String getAnnoteaServerUrl()
```

getNewAnnotation
```
public Annotation getNewAnnotation()
```

loadAnnotations
```
public void loadAnnotations()
```

getDocumentUrl
```
public String getDocumentUrl()
```

decorateDocument
```
public void decorateDocument()
```

updateSelectedAnnotation

public void updateSelectedAnnotation(int index)

setFirstAnnotationSelected

public void setFirstAnnotationSelected()

setCancelNewAnnotation
```
public void setCancelNewAnnotation()
```

setImageOnly
```
public void setImageOnly(boolean b)
```

isImageOnly
```
public boolean isImageOnly()
```

setMultiImage
```
public void setMultiImage(boolean b)
```

isMultiImage
```
public boolean isMultiImage()
```

filterXPointer

public String filterXPointer(com.google.gwt.dom.client.ImageElement image,
                    String xpath,
                    int i,
                    int j,
                    int k,
                    int l)

filter

public String filter(String xPointerFilter,
            com.google.gwt.dom.client.ImageElement image,
            String xpath,
            int i,
            int j,
            int k,
            int l)

filterAnnotation

public Point[] filterAnnotation(Point topLeft,
                       Point bottomRight)

updateAnnotation

public static void updateAnnotation(boolean forceDecorate)

updateAnnotation
```
public static void updateAnnotation()
```

updateAnnotations

public void updateAnnotations(boolean forceDecorate)

setAnnotationDecoratorFunction

public void setAnnotationDecoratorFunction(String annotationDecoratorFunction)

setNewAnnotationPopup

public void setNewAnnotationPopup(NewAnnotationPopup popup)

getNewAnnotationPopup

public NewAnnotationPopup getNewAnnotationPopup()

hideAnnotations
```
public void hideAnnotations()
```

disablePopupListeners
```
public void disablePopupListeners()
```

showAnnotations
```
public void showAnnotations()
```

enablePopupListeners
```
public void enablePopupListeners()
```

registerAnnotationPopupListener

public void registerAnnotationPopupListener(AnnotationPopupEventListener listener)

removeAnnotationPopupListener

public void removeAnnotationPopupListener(AnnotationPopupEventListener listener)

getDecorateClassName
```
public String getDecorateClassName()
```

deleteAnnotation

public void deleteAnnotation(int index)

isAnnotationsVisible
```
public boolean isAnnotationsVisible()
```

removeSelectedTextDecoration

public void removeSelectedTextDecoration()

Class AnnotationController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationController

Method Detail

addNewAnnotation

getWebConfiguration

getAnnotatedDocument

setXPointerFilter

setPointerAdapter

canAnnotate

addModelChangeListener

getFrameScrollFromTop

setFrameScrollFromTop

canCreateNewCreationPopup

openCreationPopup

closeCreationPopup

newAnnotationCreated

submitNewAnnotation

reloadAnnotations

cancelNewAnnotation

cancelNewAnnotationPopup

createNewAnnotation

setAnnotationList

getAnnoteaServerUrl

getNewAnnotation

loadAnnotations

getDocumentUrl

decorateDocument

updateSelectedAnnotation

setFirstAnnotationSelected

setCancelNewAnnotation

setImageOnly

isImageOnly

setMultiImage

isMultiImage

filterXPointer

filter

filterAnnotation

updateAnnotation

updateAnnotation

updateAnnotations

setAnnotationDecoratorFunction

setNewAnnotationPopup

getNewAnnotationPopup

hideAnnotations

disablePopupListeners

showAnnotations

enablePopupListeners

registerAnnotationPopupListener

removeAnnotationPopupListener

getDecorateClassName

deleteAnnotation

isAnnotationsVisible

removeSelectedTextDecoration