Document Searcher

Provides a UI for searching the text content of the current document.

Remarks

Overview

The Document Searcher control enables users to search for text within the currently displayed document in the Grooper web client. It is designed for fast, interactive searching, allowing users to locate keywords, phrases, or patterns and navigate between results.

Purpose

• Search the text content of the active document.
• Highlight and navigate between multiple search hits.
• Clear search results and reset the search interface.

Main Features

• Search Input:
  Enter search terms or phrases to locate within the document's text.
• Match Navigation:
  Use the {Navigator} child control to move between found matches, with clear indication of the current hit and total matches.
• Clear Search:
  The {clear} button resets the search, removing highlights and results.

Interactive Components

• Inputs:
  • Search box for entering text queries.
• Buttons:
  • {clear}: Clears the current search and resets the interface.
• Child Controls:
  • {Navigator}: Allows navigation between multiple search hits.

Usage Guidance

1. Enter a search term in the search box.
2. The control highlights all matches and displays the number of hits.
3. Use the {Navigator} to move between matches.
4. Click {clear} to remove search results and start a new search.

Example

The following diagram illustrates the typical layout of the Document Searcher control:

┌─────────────────────────────────────────────┐
│ {Search Box}                                │
├─────────────────────────────────────────────┤
│ {Navigator}  [Matches: 3/10]                │
│   ├─ {First} {Previous} {Next} {Last}       │
│   └─ Current match highlighted in document  │
├─────────────────────────────────────────────┤
│ {clear}                                     │
│   └─ Button to clear search results         │
└─────────────────────────────────────────────┘

Notes

• The control is optimized for usability, with keyboard shortcuts available for navigation (see {Navigator} documentation).
• Search results are updated in real time as you type.
• The control is intended for use in document review and analysis workflows within Grooper.

Command Buttons

Button	Shortcut Key		Summary
disabled_by_default clear		►	Clear the current search. Overview The 'clear' button resets the search interface, removing all highlights and search results from the document. Features Instantly clears the search box and any highlighted matches in the document. Returns the Document Searcher to its initial state, ready for a new search. Disabled by default; becomes enabled when a search is active. Usage Click {clear} to remove the current search term and results. This is useful when you want to start a new search or remove all search highlights from the document. Accessibility The button is visually distinct and labeled for clarity. Can be activated using mouse or keyboard navigation.

Child Controls

Name	Type		Summary
Navigator	Page Navigator	►	Allows the user to navigate between multiple hits when searching the text content of a document. Overview The 'Navigator' control provides intuitive navigation between search results in the document. Features Displays the total number of matches and the current match index. Includes navigation buttons: {First}, {Previous}, {Next}, {Last}. Keyboard shortcuts for navigation: Ctrl + Home: Go to the first match. Ctrl + Left: Go to the previous match. Ctrl + Right: Go to the next match. Ctrl + End: Go to the last match. Usage Use the navigation buttons or keyboard shortcuts to move between search hits. The current match is highlighted in the document view, and the match count is shown for context.

Used By

Document Viewer