/* 
    P/P   *  Method: com.dmdirc.ui.interfaces.SearchBar__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   * 
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   * 
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   * 
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.ui.interfaces;
    24  
    25  /**
    26   * Search bar interface.
    27   */
    28  public interface SearchBar {
    29  
    30      /** Direction used for searching. */
             /* 
    P/P       *  Method: void com.dmdirc.ui.interfaces.SearchBar$Direction(String, int)
              */
    31      public enum Direction {
    32  
    33          /** Move up through the document. */
                 /* 
    P/P           *  Method: com.dmdirc.ui.interfaces.SearchBar$Direction__static_init
                  * 
                  *  Postconditions:
                  *    $VALUES == &new SearchBar$Direction[](SearchBar$Direction__static_init#3)
                  *    DOWN == &new SearchBar$Direction(SearchBar$Direction__static_init#2)
                  *    $VALUES[1] == &new SearchBar$Direction(SearchBar$Direction__static_init#2)
                  *    UP == &new SearchBar$Direction(SearchBar$Direction__static_init#1)
                  *    $VALUES[0] == &new SearchBar$Direction(SearchBar$Direction__static_init#1)
                  *    new SearchBar$Direction(SearchBar$Direction__static_init#1) num objects == 1
                  *    new SearchBar$Direction(SearchBar$Direction__static_init#2) num objects == 1
                  *    new SearchBar$Direction[](SearchBar$Direction__static_init#3) num objects == 1
                  *    $VALUES.length == 2
                  */
    34          UP,
    35          /** Move down through the document. */
    36          DOWN,
    37      }
    38  
    39      /**
    40       * Opens the search bar.
    41       */
    42      void open();
    43  
    44      /**
    45       * Closes the search bar.
    46       */
    47      void close();
    48  
    49      /**
    50       * Returns the current search phrase for the search bar.
    51       * 
    52       * @return Current search phrase
    53       */
    54      String getSearchPhrase();
    55  
    56      /**
    57       * Returns whether the search needs to be case sensitive.
    58       * 
    59       * @return true if the search needs to be case sensitive
    60       */
    61      boolean isCaseSensitive();
    62  
    63      /**
    64       * Searches the textpane for text.
    65       * 
    66       * @param text the text to search for
    67       * @param caseSensitive whether the search is case sensitive
    68       */
    69      public void search(final String text, final boolean caseSensitive);
    70  
    71      /**
    72       * Searches the textpane for text.
    73       *
    74       * @param direction the direction to search from
    75       * @param text the text to search for
    76       * @param caseSensitive whether the search is case sensitive
    77       */
    78      public void search(final Direction direction, final String text,
    79              final boolean caseSensitive);
    80  }