KickJava   Java API By Example, From Geeks To Geeks.

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


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.drjava.model.definitions.reducedmodel.IndentInfo;
38
39 /** Aligns indentation of the current line to the character that opened the enclosing block or expression list.
40   * Optional additional whitespaces can be passed through the constructor.
41   * @version $Id: ActionBracePlus.java 3903 2006-07-05 20:03:06Z rcartwright $
42   */
43 public class ActionBracePlus extends IndentRuleAction {
44   /** String holding the additional whitespaces to be inserted. */
45   private String JavaDoc _suffix;
46
47   /** @param suffix The additional whitespaces to be inserted. */
48   public ActionBracePlus(String JavaDoc suffix) { _suffix = suffix; }
49
50   /** Properly indents the line that the caret is currently on. Replaces all whitespace characters at the beginning of
51     * the line with the appropriate spacing or characters.<p>
52     * Preconditions: must be inside a brace.
53     * @param doc AbstractDJDocument containing the line to be indented.
54     * @return true if the caller should update the current location, false if the indenter has already done this.
55     */
56   public boolean indentLine(AbstractDJDocument doc, int reason) {
57     boolean supResult = super.indentLine(doc, reason);
58     int here = doc.getCurrentLocation();
59     int startLine = doc.getLineStartPos(here);
60     doc.setCurrentLocation(startLine);
61     IndentInfo ii = doc.getIndentInformation();
62
63     // Check preconditions
64 if ((ii.braceType.equals("")) ||
65         (ii.distToBrace < 0)) {
66       // Can't find brace, so do nothing.
67 return supResult;
68     }
69
70     // Find length to brace
71 int bracePos = startLine - ii.distToBrace;
72     int braceNewLine = 0;
73     if (ii.distToNewline >=0) {
74       braceNewLine = startLine - ii.distToNewline;
75     }
76     int braceLen = bracePos - braceNewLine;
77
78     // Create tab string
79 final StringBuilder JavaDoc tab = new StringBuilder JavaDoc(_suffix.length() + braceLen);
80     for (int i=0; i < braceLen; i++) {
81       tab.append(" ");
82     }
83     tab.append(_suffix);
84
85     if (here > doc.getLength()) {
86       here = doc.getLength() - 1;
87     }
88     doc.setCurrentLocation(here);
89
90     doc.setTab(tab.toString(), here);
91     
92     return supResult;
93   }
94 }
95
Popular Tags