001    /* Highlighter.java --
002       Copyright (C) 2004  Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.swing.text;
040    
041    import java.awt.Graphics;
042    import java.awt.Shape;
043    
044    
045    public interface Highlighter
046    {
047      public interface Highlight
048      {
049        int getEndOffset();
050    
051        int getStartOffset();
052    
053        HighlightPainter getPainter();
054      }
055    
056      public interface HighlightPainter
057      {
058        void paint(Graphics g, int p0, int p1, Shape bounds, JTextComponent c);
059      }
060      
061      void install(JTextComponent c);
062    
063      void deinstall(JTextComponent c);
064    
065      Object addHighlight(int p0, int p1, HighlightPainter p)
066        throws BadLocationException;
067    
068      void removeAllHighlights();
069    
070      void removeHighlight(Object tag);
071    
072      void changeHighlight(Object tag, int p0, int p1)
073        throws BadLocationException;
074    
075      Highlight[] getHighlights();
076    
077      void paint(Graphics g);
078    }
079