#3587 - Click on annotation sidebar text to jump

- Add scroll command that editor can send to backend to trigger a scroll - Extend scroll command that backend can sent to editor to finalize a scoll to include an area to highlight - Make brat briefly highlight the scroll target after a scroll - Fix scrolling to anywhere beyond the first page in the brat editor - Rename a few internal functions in the brat code - Update the package-lock.json files - Improve style of the annotation sidebar - Fix annotation sidebar not appearing at all
inception-project · Jan 6, 2023 · ad18462 · ad18462
1 parent 0ef6ae8
commit ad18462
Show file tree

Hide file tree

Showing 40 changed files with 8,552 additions and 3,622 deletions.
diff --git a/...c/main/java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/page/AnnotationPageBase.java b/...c/main/java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/page/AnnotationPageBase.java
@@ -76,6 +76,7 @@
 import de.tudarmstadt.ukp.inception.preferences.Key;
 import de.tudarmstadt.ukp.inception.rendering.editorstate.AnnotatorState;
 import de.tudarmstadt.ukp.inception.rendering.vmodel.VID;
+import de.tudarmstadt.ukp.inception.rendering.vmodel.VRange;
 import de.tudarmstadt.ukp.inception.schema.AnnotationSchemaService;
 import de.tudarmstadt.ukp.inception.schema.adapter.AnnotationException;
 import de.tudarmstadt.ukp.inception.schema.adapter.TypeAdapter;
@@ -272,7 +273,8 @@ public void actionShowSelectedDocument(AjaxRequestTarget aTarget, SourceDocument
         AnnotatorState state = getModelObject();
 
         CAS cas = getEditorCas();
-        state.getPagingStrategy().moveToOffset(state, cas, aBegin, CENTERED);
+        state.getPagingStrategy().moveToOffset(state, cas, aBegin, new VRange(aBegin, aEnd),
+                CENTERED);
 
         if (!switched && state.getPagingStrategy() instanceof NoPagingStrategy) {
             return;

diff --git a/...java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/paging/PagingStrategy_ImplBase.java b/...java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/paging/PagingStrategy_ImplBase.java
@@ -33,19 +33,21 @@
 import de.tudarmstadt.ukp.inception.rendering.paging.Unit;
 import de.tudarmstadt.ukp.inception.rendering.selection.FocusPosition;
 import de.tudarmstadt.ukp.inception.rendering.selection.ScrollToEvent;
+import de.tudarmstadt.ukp.inception.rendering.vmodel.VRange;
 
 public abstract class PagingStrategy_ImplBase
     implements PagingStrategy
 {
     private static final long serialVersionUID = 928025483609029306L;
 
     @Override
-    public void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, FocusPosition aPos)
+    public void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, VRange aPingRange,
+            FocusPosition aPos)
     {
         switch (aPos) {
         case TOP: {
             aState.setPageBegin(aCas, aOffset);
-            fireScrollToEvent(aOffset, aPos);
+            fireScrollToEvent(aOffset, aPingRange, aPos);
             break;
         }
         case CENTERED: {
@@ -65,15 +67,15 @@ public void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, Focus
 
             aState.setPageBegin(aCas, firstUnit.getBegin());
             aState.setFocusUnitIndex(unit.getIndex());
-            fireScrollToEvent(aOffset, aPos);
+            fireScrollToEvent(aOffset, aPingRange, aPos);
             break;
         }
         default:
             throw new IllegalArgumentException("Unknown focus positon: [" + aPos + "]");
         }
     }
 
-    private void fireScrollToEvent(int aOffset, FocusPosition aPos)
+    private void fireScrollToEvent(int aOffset, VRange aPingRange, FocusPosition aPos)
     {
         RequestCycle requestCycle = RequestCycle.get();
 
@@ -85,7 +87,7 @@ private void fireScrollToEvent(int aOffset, FocusPosition aPos)
         if (handler.isPresent() && handler.get().isPageInstanceCreated()) {
             Page page = (Page) handler.get().getPage();
             var target = requestCycle.find(AjaxRequestTarget.class).orElse(null);
-            page.send(page, BREADTH, new ScrollToEvent(target, aOffset, aPos));
+            page.send(page, BREADTH, new ScrollToEvent(target, aOffset, aPingRange, aPos));
         }
     }
 }
diff --git a/...pi-render/src/main/java/de/tudarmstadt/ukp/inception/rendering/paging/PagingStrategy.java b/...pi-render/src/main/java/de/tudarmstadt/ukp/inception/rendering/paging/PagingStrategy.java
@@ -31,6 +31,7 @@
 import de.tudarmstadt.ukp.inception.rendering.editorstate.AnnotatorState;
 import de.tudarmstadt.ukp.inception.rendering.editorstate.AnnotatorViewState;
 import de.tudarmstadt.ukp.inception.rendering.selection.FocusPosition;
+import de.tudarmstadt.ukp.inception.rendering.vmodel.VRange;
 
 public interface PagingStrategy
     extends Serializable
@@ -53,7 +54,13 @@ public interface PagingStrategy
 
     Component createPageNavigator(String aId, Page aPage);
 
-    void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, FocusPosition aPos);
+    default void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, FocusPosition aPos)
+    {
+        moveToOffset(aState, aCas, aOffset, null, aPos);
+    }
+
+    void moveToOffset(AnnotatorViewState aState, CAS aCas, int aOffset, VRange aPingRange,
+            FocusPosition aPos);
 
     default void recalculatePage(AnnotatorViewState aState, CAS aCas)
     {

diff --git a/...-render/src/main/java/de/tudarmstadt/ukp/inception/rendering/selection/ScrollToEvent.java b/...-render/src/main/java/de/tudarmstadt/ukp/inception/rendering/selection/ScrollToEvent.java
@@ -19,17 +19,22 @@
 
 import org.apache.wicket.ajax.AjaxRequestTarget;
 
+import de.tudarmstadt.ukp.inception.rendering.vmodel.VRange;
+
 public class ScrollToEvent
 {
     private final AjaxRequestTarget requestHandler;
     private final int offset;
+    private final VRange pingRange;
     private final FocusPosition position;
 
-    public ScrollToEvent(AjaxRequestTarget aRequestHandler, int aOffset, FocusPosition aPos)
+    public ScrollToEvent(AjaxRequestTarget aRequestHandler, int aOffset, VRange aPingRange,
+            FocusPosition aPos)
     {
         requestHandler = aRequestHandler;
         offset = aOffset;
         position = aPos;
+        pingRange = aPingRange;
     }
 
     public AjaxRequestTarget getRequestHandler()
@@ -42,6 +47,11 @@ public int getOffset()
         return offset;
     }
 
+    public VRange getPingRange()
+    {
+        return pingRange;
+    }
+
     public FocusPosition getPosition()
     {
         return position;

diff --git a/...ema/src/main/java/de/tudarmstadt/ukp/inception/editor/action/AnnotationActionHandler.java b/...ema/src/main/java/de/tudarmstadt/ukp/inception/editor/action/AnnotationActionHandler.java
@@ -78,6 +78,9 @@ void actionSelectAndJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
     void actionJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
         throws IOException, AnnotationException;
 
+    void actionJump(AjaxRequestTarget aTarget, int aBegin, int aEnd)
+        throws IOException, AnnotationException;
+
     /**
      * Delete currently selected annotation.
      *