1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: RedLetterText.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.xml;
23  
24  /**
25   * RedLetterText remembers when text should be red. Red Letter Text is used to
26   * highlight the words of Jesus.
27   * 
28   * @see gnu.lgpl.License for license details.<br>
29   *      The copyright to this program is held by it's authors.
30   * @author DM Smith [dmsmith555 at yahoo dot com]
31   * 
32   */
33  public class RedLetterText {
34      private int rlt;
35  
36      /**
37       * Construct a RedLetterText.
38       */
39      public RedLetterText() {
40          rlt = 0;
41      }
42  
43      /**
44       * Call when Red Letter Text is entered
45       * 
46       */
47      public void enter() {
48          rlt++;
49      }
50  
51      /**
52       * Call when Red Letter Text is left
53       * 
54       */
55      public void leave() {
56          if (rlt > 0) {
57              rlt--;
58          }
59      }
60  
61      /**
62       * Returns true when one is in Red Letter Text
63       * 
64       * @return true if in RLT, false otherwise
65       */
66      public boolean isRLT() {
67          return rlt > 0;
68      }
69  }
70