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.MagicConstants;
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 MagicConstantItem extends CompletionItem {
062:
063: private MagicConstants myMagicConstant;
064:
065: MagicConstantItem(MagicConstants magicConstant, int caretOffset,
066: HtmlFormatter formatter) {
067: super (caretOffset, formatter);
068: myMagicConstant = magicConstant;
069: }
070:
071: /* (non-Javadoc)
072: * @see org.netbeans.modules.gsf.api.CompletionProposal#getIcon()
073: */
074: public ImageIcon getIcon() {
075: // TODO An Icon for Keyword is required.
076: return null;
077: }
078:
079: /* (non-Javadoc)
080: * @see org.netbeans.modules.gsf.api.CompletionProposal#getInsertPrefix()
081: */
082: public String getInsertPrefix() {
083: return myMagicConstant.value();
084: }
085:
086: /* (non-Javadoc)
087: * @see org.netbeans.modules.gsf.api.CompletionProposal#getKind()
088: */
089: public ElementKind getKind() {
090: return ElementKind.KEYWORD;
091: }
092:
093: /* (non-Javadoc)
094: * @see org.netbeans.modules.gsf.api.CompletionProposal#getLhsHtml()
095: */
096: public String getLhsHtml() {
097: HtmlFormatter formatter = getFormatter();
098: formatter.reset();
099: formatter.name(getKind(), true);
100: formatter.appendText(myMagicConstant.value());
101: formatter.name(getKind(), false);
102: return formatter.getText();
103: }
104:
105: /* (non-Javadoc)
106: * @see org.netbeans.modules.gsf.api.CompletionProposal#getModifiers()
107: */
108: public Set<Modifier> getModifiers() {
109: // TODO Auto-generated method stub
110: return null;
111: }
112:
113: /* (non-Javadoc)
114: * @see org.netbeans.modules.gsf.api.CompletionProposal#getName()
115: */
116: public String getName() {
117: return myMagicConstant.value();
118: }
119:
120: /* (non-Javadoc)
121: * @see org.netbeans.modules.gsf.api.CompletionProposal#getRhsHtml()
122: */
123: public String getRhsHtml() {
124: // TODO If it is possible then a text explained the return type
125: // should be returned.
126: return null;
127: }
128:
129: /* (non-Javadoc)
130: * @see org.netbeans.modules.gsf.api.CompletionProposal#isSmart()
131: */
132: public boolean isSmart() {
133: return true;
134: }
135:
136: private List<FormalParameter> getFormalParameterList() {
137: return null;
138: }
139:
140: /* (non-Javadoc)
141: * @see org.netbeans.modules.gsf.api.CompletionProposal#getElement()
142: */
143: @Override
144: public Element getElement() {
145: return new DocumentableElement() {
146:
147: @Override
148: public String getIn() {
149: // TODO Auto-generated method stub
150: return null;
151: }
152:
153: @Override
154: public ElementKind getKind() {
155: return ElementKind.CONSTANT;
156: }
157:
158: @Override
159: public Set<Modifier> getModifiers() {
160: // TODO Auto-generated method stub
161: return null;
162: }
163:
164: @Override
165: public String getName() {
166: return myMagicConstant.value();
167: }
168:
169: public String getDocumentation() {
170: // TODO: documentation for the myKeyword
171: return null;
172: }
173:
174: };
175: }
176:
177: }
|