Changes between Version 3 and Version 4 of SEARCH_COMMONS_R0


Ignore:
Timestamp:
07/17/09 18:02:09 (16 years ago)
Author:
meddle
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • SEARCH_COMMONS_R0

    v3 v4  
    66 
    77== Overview == 
    8  
    9 {{{ 
    10 spec_entry("Search Palette") 
    11 desc("includes the palette") 
    12 desc("since there are many searches, we may have something like a drop-down ") 
    13 desc("to select the search scope") 
    14 desc("This task deals with invoking searches, displaying the results, and common search design/infrastructure ") 
    15 }}} 
    16  
    17 Provide text search functionality in Sophie 2. 
    18  
     8We need to provide the ability for the application to highlight parts of a text. In order to do so we need to have following things: 
     9 * Start position 
     10 * End position 
     11 * Style 
     12 * To make sure that the text is readable as well as that the highlight itself is visible 
     13The highlight itself will be used for: 
     14 * text selection 
     15 * search results 
     16 * spell check 
     17The highlight should allow different styling for different functionality, for example: 
     18 * red underline for spell check 
     19 * different background as well as character color for selection and search results.(However text model shouldn't be changed) 
    1920== Task requirements == 
    20 Visual elements: 
    21  * The Tools tab has a Search palette. It lets the user search a Sophie document. 
    22  * A text field is available at the top of the palette where a user can enter a word or phrase he wants to find in current book. 
    23  * The searching palette in the Tools tab provides a list of results with context (some words before and after the match; also the page number). 
    24  
    25 Typical scenario: 
    26  * Text is typed in the field at the top of the palette 
    27  * Enter is hit 
    28  * A list of all occurrences in text are provided in the palette 
    29  * To go to one of them, it is clicked in the list 
    30  * Clicking on a result displays the page of the book with the match.  
    31  * The caret is positioned at the beginning of the match. 
    32  * The match is highlighted. 
    33  
    34 Below the text field there should be a combo box for selecting search scope: 
    35  * Current Book 
    36  * All Books in Workspace 
    37  * Server Search ([wiki:SERVER_SEARCH_R0], search into the current server connection) 
    38  
    39 Provide common search design. It should be used by: 
    40  * [wiki:ASYNC_SEARCHING] 
    41  * [wiki:BOOK_SEARCH] 
    42  * [wiki:SERVER_SEARCH] 
    43  * [wiki:WORKSPACE_SEARCH] 
    44  * [wiki:QUICK_SEARCH] 
    45  * [wiki:SEARCH_REPLACE_PALETTE] 
    46  
    47 Search palette can be invoked by pressing Ctrl+F. 
    48  
    49 Embedded books 
    50  * When the book that is being searched has embedded books: 
    51   * The embedded books are added to the search itinerary after all flows in the parent book have been searched. 
    52   * After all flows in all of the embedded books have been searched, the search loops back to the original flow that was being searched. 
    53   * If the embedded books have embedded books in them, the process is iterated. All books in the document are searched. 
    54  * When searching from within a book that is embedded in a parent book: 
    55   * First the embedded book is searched 
    56   * then the parent book is searched 
    57   * and finally other embedded books in the parent book are searched. 
    58  
    59 Annotations 
    60  * If there are reader annotations, reader annotations are also searched.  
    61  * These are searched after all the embedded books have been searched; they are searched in the order in which they appear in the document. 
     21Provide a search menu in sophie2 project. 
     22On clicking the "OK" button the typed word in the word is highlighted in the selected text element (if the word exists it is highlighted as manu times as it exists). 
    6223 
    6324== Task result == 
    64 Source code. 
    65  
     25 * The result should be source code 
    6626== Implementation idea == 
    67 Searching should be done in a new thread; otherwise, the GUI will hang when searching in large books. 
     27 * Create a highlight object that contains start position and end position as well as style. 
    6828 
    6929== Related == 
    70 ^(Add links to related tasks that could be useful or helpful.)^ 
    71  
     30[wiki:TEXT_STABLE_SELECTION_R0][[BR]] 
     31[wiki:SEARCH_COMMONS_R0][[BR]] 
     32[wiki:TEXT_SPELL_CHECK_R0] 
    7233== How to demo == 
    73  * Run Sophie 2 
    74  * Create a new book 
    75  * Insert a text frame and write something like "dfjkfds abc jfkdjfslk-abc-fdjfslkdfs" (at least two occurrencies of "abc") 
    76  * Press Ctrl+F 
    77  * Search for "abc" 
     34 * Run the application 
     35 * Create new book 
     36 * Insert text frame and populated with content 
     37 * Select part of the text frame content 
    7838 
    7939= Design = 
    80 ^(Describe your design here.)^ 
     40In order to provide the search menu and the search form with 
     41 * rename the existing class Highlight to HotHighlight and add an attribute ImmColor to it. 
     42 * move the existing class Highlight in org.sophie2.base.model.text 
     43its logic the following classes are added in org.sophie2.main.app.menus.view: 
     44 * SearchItem - the search item for the search menu. 
     45 * SearchLogic - the class providing the logic for the search menu. This class has  
     46findSearchedText method that provides the logic for searching a particular word in 
     47the selected views. This function uses java.util.regex.Pattern and java.util.regex.Matcher 
     48to find all places in the text from the selected view where the word is matched. 
     49For every matched word a new HotHighlight is inserted in the HotTextSceneElement 
     50 * SearchMenu - the search menu in the sophie2 project. 
     51 * SearchFormDialog that extends Dialog<SearchFormDialog.Input, String>. This class  
     52provides the user form that is shown on clicking the seatch menu item.  
     53 In HotTextSceneElement class add a new property RwListProp<HotHighlight> highlight() that holds all 
     54the highlighted data in the HotTextSceneElement . 
     55The highlight always has >= 1 elements in it. 
     56The first HotHighlight in the highlight() is always the selected text in the HotTextSceneElement. 
     57The HotTextPlaceLogic and HotPlaceLogic are refactored to add and remove HotHighlights: 
     58 * HotTextPlaceLogic : SELECT adds the first HotHighlight in the highlight()of the HotTextSceneElement. 
     59 * HotTextPlaceLogic :DELETE_CHARS and HotTextPlaceLogic :USER_GO_OP clears all the existing highlights in the  
     60HotTextSceneElement. 
     61 * HotTextLogic:INPUT_CHAR deletes all the existing highlights in the HotTextSceneElement. 
     62Modify the Atom:draw method with adding a new attribute ImmColor in order to set the color of the backgroung 
     63with the specific ImmColor of every HotHighlight. 
     64Modify the EdgeKind:draw with adding a new attribute List<HotHighlight> in order to draw all the highlights of the  
     65particular text. 
     66In HotTextPane:paintComponent method add a new HotHighlight - the Highlight that contains the selected text in the 
     67HotTextSceneElement. 
     68 
     69The test source can be found here:[4300] 
    8170 
    8271= Implementation =