1 /*
   2  * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.swing.text;
  26 
  27 import java.awt.Graphics;
  28 import java.awt.Shape;
  29 
  30 /**
  31  *
  32  * @author  Scott Violet
  33  * @author  Timothy Prinzing
  34  * @see     Highlighter
  35  */
  36 public abstract class LayeredHighlighter implements Highlighter {
  37     /**
  38      * When leaf Views (such as LabelView) are rendering they should
  39      * call into this method. If a highlight is in the given region it will
  40      * be drawn immediately.
  41      *
  42      * @param g Graphics used to draw
  43      * @param p0 starting offset of view
  44      * @param p1 ending offset of view
  45      * @param viewBounds Bounds of View
  46      * @param editor JTextComponent
  47      * @param view View instance being rendered
  48      */
  49     public abstract void paintLayeredHighlights(Graphics g, int p0, int p1,
  50                                                 Shape viewBounds,
  51                                                 JTextComponent editor,
  52                                                 View view);
  53 
  54 
  55     /**
  56      * Layered highlight renderer.
  57      */
  58     static public abstract class LayerPainter implements Highlighter.HighlightPainter {
  59         /**
  60          * @return a shape
  61          * @param g Graphics used to draw
  62          * @param p0 starting offset of view
  63          * @param p1 ending offset of view
  64          * @param viewBounds Bounds of View
  65          * @param editor JTextComponent
  66          * @param view View instance being rendered
  67          */
  68         public abstract Shape paintLayer(Graphics g, int p0, int p1,
  69                                         Shape viewBounds,JTextComponent editor,
  70                                         View view);
  71     }
  72 }