This page demonstrates functions of the #doclink( 'AbstractSearchTool' false ). In this case, we are working with a simplistic, demonstration implementation called "MySearchTool".
If you submit a list of items using the store() function at the bottom> of the table below, that will add those items to a static database of strings which we can use to search for the purposes of the function demonstrations and the example below the function list. Please note that, ${esc.d}search.store() is not a part of the AbstractSearchTool API and exists only for the implementation used in this demo.
#demoTableStart() #set( $quote = '"' ) #set( $desc = 'Sets the criteria for finding results (i.e. the search terms).' ) #demo1( 'search' 'setCriteria' 8 $desc ) #set( $quote = '' ) #set( $desc = 'Sets the index of the first result in the current page' ) #demo1( 'search' 'setIndex' 4 $desc ) #set( $desc = 'Sets the number of results returned in a page of results' ) #demo1( 'search' 'setItemsPerPage' 4 $desc ) #set( $desc = 'Sets the number of result page indices for $search.slip to list.' ) #demo1( 'search' 'setSlipSize' 4 $desc ) #set( $desc = 'Checks whether or not the result list is empty.' ) #demo( 'search' 'hasItems()' $desc ) #set( $desc = 'Returns the current search criteria.' ) #demo( 'search' 'criteria' $desc ) #set( $desc = 'Returns the current search result index.' ) #demo( 'search' 'index' $desc ) #set( $desc = 'Returns the index of the first result on the current page of results (as determined by the current index, results per page, and the number of results).' ) #demo( 'search' 'firstIndex' $desc ) #set( $desc = 'Returns the index of the last result on the current page of results (as determined by the current index, results per page, and the number of results).' ) #demo( 'search' 'lastIndex' $desc ) #set( $desc = 'Return the index for the previous page of results (as determined by the current index, results per page, and the number of results).' ) #demo( 'search' 'prevIndex' $desc ) #set( $desc = 'Returns the index for the next page of results (as determined by the current index, results per page, and the number of results).' ) #demo( 'search' 'nextIndex' $desc ) #set( $desc = 'Returns the search result list.' ) #demo( 'search' 'items' $desc ) #set( $desc = 'Returns the current "page" of search results.' ) #demo( 'search' 'page' $desc ) #set( $desc = 'Returns a description of the current page.' ) #demo( 'search' 'pageDescription' $desc ) #set( $desc = 'Returns the "page number" for the current index.' ) #demo( 'search' 'pageNumber' $desc ) #set( $desc = 'Returns the "page number" for the specified index.' ) #demo1( 'search' 'getPageNumber' 4 $desc ) #set( $desc = 'Returns the set number of results to be displayed per page of results' ) #demo( 'search' 'itemsPerPage' $desc ) #set( $desc = 'Returns the number of pages that can be made from this list given the set number of results per page.' ) #demo( 'search' 'pagesAvailable' $desc ) #set( $desc = 'Returns the total number of results available.' ) #demo( 'search' 'total' $desc ) #set( $desc = 'Returns a Sliding List of Indices for Pages of results.' ) #demo( 'search' 'slip' $desc ) #set( $desc = 'Returns the number of result page indices $search.slip will return per request (if available).' ) #demo( 'search' 'slipSize' $desc ) #demoCustom( 'search.store($context.toolbox)' ) #set( $desc = 'Adds an item or list of items to the faux "database" that is being "searched" by this example. This method is not part of the AbstractSearchTool API.' ) #demo1( 'search' 'store' 12 $desc )There are no items to display. To activate this example, follow the directions at the top of this page.
#end