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.api.languages;
043:
044: import javax.swing.text.Document;
045: import javax.swing.text.JTextComponent;
046: import org.netbeans.modules.editor.NbEditorUtilities;
047: import org.openide.cookies.EditorCookie;
048: import org.openide.loaders.DataObject;
049:
050: /**
051: * Represents context for methods called from nbs files.
052: *
053: * @author Jan Jancura
054: */
055: public abstract class Context {
056:
057: /**
058: * Returns instance of editor.
059: *
060: * @return instance of editor
061: */
062: public abstract JTextComponent getJTextComponent();
063:
064: /**
065: * Returns instance of {@link javax.swing.text.Document}.
066: *
067: * @return instance of {@link javax.swing.text.Document}
068: */
069: public abstract Document getDocument();
070:
071: public abstract int getOffset();
072:
073: /**
074: * Creates a new Context.
075: *
076: * @return a new Context
077: */
078: public static Context create(Document doc, int offset) {
079: return new CookieImpl(doc, offset);
080: }
081:
082: private static class CookieImpl extends Context {
083:
084: private Document doc;
085: private JTextComponent component;
086: private int offset;
087:
088: CookieImpl(Document doc, int offset) {
089: this .doc = doc;
090: this .offset = offset;
091: }
092:
093: public JTextComponent getJTextComponent() {
094: if (component == null) {
095: DataObject dob = NbEditorUtilities.getDataObject(doc);
096: EditorCookie ec = dob.getLookup().lookup(
097: EditorCookie.class);
098: if (ec.getOpenedPanes().length > 0)
099: component = ec.getOpenedPanes()[0];
100: }
101: return component;
102: }
103:
104: public Document getDocument() {
105: return doc;
106: }
107:
108: public int getOffset() {
109: return offset;
110: }
111: }
112: }
|