KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > definitions > indent > ActionStartCurrStmtPlus


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.model.definitions.indent;
35
36 import edu.rice.cs.drjava.model.AbstractDJDocument;
37 import edu.rice.cs.util.UnexpectedException;
38
39 import javax.swing.text.BadLocationException JavaDoc;
40
41 /** Indents the current line in the document to the indent level of the start of the statement that the cursor is
42   * currently on, plus the given suffix string.
43   * @version $Id: ActionStartCurrStmtPlus.java 3901 2006-06-30 05:28:11Z rcartwright $
44   */
45 public class ActionStartCurrStmtPlus extends IndentRuleAction {
46   private String JavaDoc _suffix;
47
48   /** Constructs a new rule with the given suffix string.
49     * @param suffix String to append to indent level of brace
50     */
51   public ActionStartCurrStmtPlus(String JavaDoc suffix) {
52     super();
53     _suffix = suffix;
54   }
55
56   /** Properly indents the line that the caret is currently on. Replaces all whitespace characters at the beginning
57     * of the line with the appropriate spacing or characters.
58     * @param doc AbstractDJDocument containing the line to be indented.
59     * @return true if the caller should update the current location itself,
60     * false if the indenter has already handled this
61     */
62   public boolean indentLine(AbstractDJDocument doc, int reason) {
63     boolean supResult = super.indentLine(doc, reason);
64
65     /** This method is simply a call to getIndentOfCurrStmt, which is fully tested in IndentHelperTest, so no additional
66       * tests are provided for this class.
67       */
68
69     String JavaDoc indent = "";
70
71     try {
72       indent = doc.getIndentOfCurrStmt(doc.getCurrentLocation(), new char[] {';','{','}'}, new char[] {' ', '\t','\n'});
73     }
74     catch (BadLocationException JavaDoc e) { throw new UnexpectedException(e); }
75
76     indent = indent + _suffix;
77     doc.setTab(indent, doc.getCurrentLocation());
78     
79     return supResult;
80   }
81 }
82
Popular Tags