KickJava   Java API By Example, From Geeks To Geeks.

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


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.util.UnexpectedException;
37
38 import edu.rice.cs.drjava.model.AbstractDJDocument;
39 import edu.rice.cs.drjava.model.definitions.reducedmodel.*;
40
41 import javax.swing.text.BadLocationException JavaDoc;
42
43 /**
44  * Indents the current line in the document to the indent level of the
45  * start of the contract or statement of the brace enclosing the start of the
46  * current line, plus the given suffix.
47  * @version $Id: ActionStartStmtOfBracePlus.java 3901 2006-06-30 05:28:11Z rcartwright $
48  */
49 public class ActionStartStmtOfBracePlus extends IndentRuleAction {
50   private String JavaDoc _suffix;
51
52   /**
53    * Constructs a new rule with the given suffix string.
54    * @param suffix String to append to indent level of brace
55    */
56   public ActionStartStmtOfBracePlus(String JavaDoc suffix) {
57     super();
58     _suffix = suffix;
59   }
60
61   /**
62    * Properly indents the line that the caret is currently on.
63    * Replaces all whitespace characters at the beginning of the
64    * line with the appropriate spacing or characters.
65    * @param doc AbstractDJDocument containing the line to be indented.
66    * @return true if the caller should update the current location itself,
67    * false if the indenter has already handled this
68    */
69   public boolean indentLine(AbstractDJDocument doc, int reason) {
70     boolean supResult = super.indentLine(doc, reason);
71     int pos = doc.getCurrentLocation();
72
73     // Get distance to brace
74 IndentInfo info = doc.getIndentInformation();
75     int distToBrace = info.distToBrace;
76
77     // If there is no brace, align to left margin
78 if (distToBrace == -1) {
79       doc.setTab(_suffix, pos);
80       return supResult;
81     }
82
83     // Get the absolute position of the brace
84 int bracePos = pos - distToBrace;
85
86     String JavaDoc indent = "";
87     try {
88       indent = doc.getIndentOfCurrStmt(bracePos);
89     } catch (BadLocationException JavaDoc e) {
90       // Should not happen
91 throw new UnexpectedException(e);
92     }
93     indent = indent + _suffix;
94
95     doc.setTab(indent, pos);
96     
97     return supResult;
98   }
99
100 }
101
Popular Tags