/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.search;

/**
 * Interface used for displaying item text.
 *
 * @author Tim Boudreau
 */
interface TextDisplayer {

    /**
     * Displays the given text and possibly highlights the given range of text.
     * 
     * @param  txt  text to be displayed
     * @param  mimeType  mime type of the text/file
     * @param  location  determines range of text that is to be highlighted
     *                   ({@code location.x} = start position,
     *                    {@code location.y} = end position);
     *                   if {@code null}, nothing is to be highlighted
     */
    public void setText(String txt,
                        String mimeType,
                        TextDetail location);
    
}
