001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.editor.ext.html.javadoc;
043:
044: /**
045: *
046: * @author Petr Pisl
047: */
048: public class TagHelpItem implements HelpItem {
049:
050: private String identical;
051:
052: /**
053: * Holds value of property startText.
054: */
055: private String startText;
056:
057: /**
058: * Holds value of property startTextOffset.
059: */
060: private int startTextOffset;
061:
062: /**
063: * Holds value of property endText.
064: */
065: private String endText;
066:
067: /**
068: * Holds value of property endTextOffset.
069: */
070: private int endTextOffset;
071:
072: /**
073: * Holds value of property textBefore.
074: */
075: private String textBefore;
076:
077: /**
078: * Holds value of property textAfter.
079: */
080: private String textAfter;
081:
082: /**
083: * Holds value of property file.
084: */
085: private String file;
086:
087: /**
088: * Holds value of property name.
089: */
090: private String name;
091:
092: /** Creates a new instance of HelpItem */
093:
094: public TagHelpItem(String name, String identical) {
095: this .identical = identical;
096: this .name = name;
097: file = null;
098: startTextOffset = 0;
099: startText = null;
100: endTextOffset = 0;
101: endText = null;
102: textBefore = null;
103: textAfter = null;
104: }
105:
106: public TagHelpItem(String name) {
107: this .name = name;
108: file = null;
109: startTextOffset = 0;
110: startText = null;
111: endTextOffset = 0;
112: endText = null;
113: textBefore = null;
114: textAfter = null;
115: identical = null;
116:
117: }
118:
119: public TagHelpItem(String name, String file, String startText,
120: int startOffset, String endText, int endOffset,
121: String textBefore, String textAfter) {
122: this .name = name;
123: this .file = file;
124: this .startText = startText;
125: this .startTextOffset = startTextOffset;
126: this .endText = endText;
127: this .endTextOffset = endTextOffset;
128: this .textBefore = textBefore;
129: this .textAfter = textAfter;
130: this .identical = null;
131: }
132:
133: public TagHelpItem(String name, String file, String startText,
134: int startOffset, String endText, int endOffset) {
135: this (name, file, startText, startOffset, endText, endOffset,
136: null, null);
137: }
138:
139: /**
140: * Getter for property identical.
141: * @return Value of property identical.
142: */
143: public String getIdentical() {
144: return this .identical;
145: }
146:
147: /**
148: * Getter for property startText.
149: * @return Value of property startText.
150: */
151: public String getStartText() {
152:
153: return this .startText;
154: }
155:
156: /**
157: * Getter for property startTextOffset.
158: * @return Value of property startTextOffset.
159: */
160: public int getStartTextOffset() {
161:
162: return this .startTextOffset;
163: }
164:
165: /**
166: * Getter for property endText.
167: * @return Value of property endText.
168: */
169: public String getEndText() {
170:
171: return this .endText;
172: }
173:
174: /**
175: * Getter for property endTextOffset.
176: * @return Value of property endTextOffset.
177: */
178: public int getEndTextOffset() {
179:
180: return this .endTextOffset;
181: }
182:
183: /**
184: * Getter for property textBefore.
185: * @return Value of property textBefore.
186: */
187: public String getTextBefore() {
188:
189: return this .textBefore;
190: }
191:
192: /**
193: * Getter for property textAfter.
194: * @return Value of property textAfter.
195: */
196: public String getTextAfter() {
197:
198: return this .textAfter;
199: }
200:
201: public String getHelp() {
202: return "help for key "; // NOI18N
203: }
204:
205: /**
206: * Getter for property file.
207: * @return Value of property file.
208: */
209: public String getFile() {
210:
211: return this .file;
212: }
213:
214: /**
215: * Setter for property endText.
216: * @param endText New value of property endText.
217: */
218: public void setEndText(String endText) {
219: this .endText = endText;
220: }
221:
222: /**
223: * Setter for property endTextOffset.
224: * @param endTextOffset New value of property endTextOffset.
225: */
226: public void setEndTextOffset(int endTextOffset) {
227: this .endTextOffset = endTextOffset;
228: }
229:
230: /**
231: * Setter for property file.
232: * @param file New value of property file.
233: */
234: public void setFile(String file) {
235: this .file = file;
236: }
237:
238: /**
239: * Setter for property identical.
240: * @param identical New value of property identical.
241: */
242: public void setIdentical(String identical) {
243: this .identical = identical;
244: }
245:
246: /**
247: * Setter for property startText.
248: * @param startText New value of property startText.
249: */
250: public void setStartText(String startText) {
251: this .startText = startText;
252: }
253:
254: /**
255: * Setter for property startTextOffset.
256: * @param startTextOffset New value of property startTextOffset.
257: */
258: public void setStartTextOffset(int startTextOffset) {
259: this .startTextOffset = startTextOffset;
260: }
261:
262: /**
263: * Setter for property textAfter.
264: * @param textAfter New value of property textAfter.
265: */
266: public void setTextAfter(String textAfter) {
267: this .textAfter = textAfter;
268: }
269:
270: /**
271: * Setter for property textBefore.
272: * @param textBefore New value of property textBefore.
273: */
274: public void setTextBefore(String textBefore) {
275: this .textBefore = textBefore;
276: }
277:
278: /**
279: * Getter for property name.
280: * @return Value of property name.
281: */
282: public String getName() {
283:
284: return this .name;
285: }
286:
287: /**
288: * Setter for property name.
289: * @param name New value of property name.
290: */
291: public void setName(String name) {
292:
293: this .name = name;
294: }
295:
296: public String toString() {
297: StringBuffer sb = new StringBuffer();
298: sb.append(name);
299: if (identical == null) {
300: sb.append("\n file: "); // NOI18N
301: sb.append(file);
302: sb.append("\n start text: "); // NOI18N
303: sb.append(startText);
304: sb.append("\n start text offset: "); // NOI18N
305: sb.append(startTextOffset);
306: sb.append("\n end text: "); // NOI18N
307: sb.append(endText);
308: sb.append("\n end text offset: "); // NOI18N
309: sb.append(endTextOffset);
310: sb.append("\n text before: "); // NOI18N
311: sb.append(textBefore);
312: sb.append("\n text after: "); // NOI18N
313: sb.append(textAfter);
314: } else {
315: sb.append("\n indentical to: "); // NOI18N
316: sb.append(identical);
317: }
318: return sb.toString();
319: }
320: }
|