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: package org.netbeans.modules.php.editor.completion;
042:
043: import java.util.List;
044: import java.util.Set;
045:
046: import javax.swing.ImageIcon;
047:
048: import org.netbeans.modules.gsf.api.Element;
049: import org.netbeans.modules.gsf.api.ElementKind;
050: import org.netbeans.modules.gsf.api.HtmlFormatter;
051: import org.netbeans.modules.gsf.api.Modifier;
052: import org.netbeans.modules.languages.php.lang.Keywords;
053: import org.netbeans.modules.php.model.FormalParameter;
054:
055: /**
056: * This is PHP keyword completion proposal.
057: *
058: * @author Victor G. Vasilyev
059: *
060: */
061: class KeywordItem extends CompletionItem {
062:
063: private Keywords myKeyword;
064:
065: // private static final String ICON_FILE =
066: // "org/netbeans/modules/php/editor/completion/php_keyword.png"; //NOI18N
067: private static final ImageIcon ICON = null;
068:
069: // new ImageIcon(org.openide.util.Utilities.loadImage(ICON_FILE));
070:
071: KeywordItem(Keywords keyword, int caretOffset,
072: HtmlFormatter formatter) {
073: super (caretOffset, formatter);
074: myKeyword = keyword;
075: }
076:
077: /* (non-Javadoc)
078: * @see org.netbeans.modules.gsf.api.CompletionProposal#getIcon()
079: */
080: public ImageIcon getIcon() {
081: return ICON;
082: }
083:
084: /* (non-Javadoc)
085: * @see org.netbeans.modules.gsf.api.CompletionProposal#getInsertPrefix()
086: */
087: public String getInsertPrefix() {
088: return myKeyword.value();
089: }
090:
091: /* (non-Javadoc)
092: * @see org.netbeans.modules.gsf.api.CompletionProposal#getKind()
093: */
094: public ElementKind getKind() {
095: return ElementKind.KEYWORD;
096: }
097:
098: /* (non-Javadoc)
099: * @see org.netbeans.modules.gsf.api.CompletionProposal#getLhsHtml()
100: */
101: public String getLhsHtml() {
102: HtmlFormatter formatter = getFormatter();
103: formatter.reset();
104: formatter.name(getKind(), true);
105: formatter.appendText(myKeyword.value());
106: formatter.name(getKind(), false);
107: return formatter.getText();
108: }
109:
110: /* (non-Javadoc)
111: * @see org.netbeans.modules.gsf.api.CompletionProposal#getModifiers()
112: */
113: public Set<Modifier> getModifiers() {
114: // TODO Auto-generated method stub
115: return null;
116: }
117:
118: /* (non-Javadoc)
119: * @see org.netbeans.modules.gsf.api.CompletionProposal#getName()
120: */
121: public String getName() {
122: return myKeyword.value();
123: }
124:
125: /* (non-Javadoc)
126: * @see org.netbeans.modules.gsf.api.CompletionProposal#getRhsHtml()
127: */
128: public String getRhsHtml() {
129: // TODO If it is possible then a text explained the return type
130: // should be returned.
131: return null;
132: }
133:
134: /* (non-Javadoc)
135: * @see org.netbeans.modules.gsf.api.CompletionProposal#isSmart()
136: */
137: public boolean isSmart() {
138: return true;
139: }
140:
141: private List<FormalParameter> getFormalParameterList() {
142: return null;
143: }
144:
145: /* (non-Javadoc)
146: * @see org.netbeans.modules.gsf.api.CompletionProposal#getElement()
147: */
148: @Override
149: public Element getElement() {
150: return new DocumentableElement() {
151:
152: public String getIn() {
153: // TODO Auto-generated method stub
154: return null;
155: }
156:
157: public ElementKind getKind() {
158: return ElementKind.KEYWORD;
159: }
160:
161: public Set<Modifier> getModifiers() {
162: // TODO Auto-generated method stub
163: return null;
164: }
165:
166: public String getName() {
167: return myKeyword.value();
168: }
169:
170: public String getDocumentation() {
171: // TODO: documentation for the myKeyword
172: return null;
173: }
174:
175: };
176: }
177:
178: }
|