2
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
6
* The contents of this file are subject to the terms of either the GNU
7
* General Public License Version 2 only ("GPL") or the Common
8
* Development and Distribution License("CDDL") (collectively, the
9
* "License"). You may not use this file except in compliance with the
10
* License. You can obtain a copy of the License at
11
* http://www.netbeans.org/cddl-gplv2.html
12
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13
* specific language governing permissions and limitations under the
14
* License. When distributing the software, include this License Header
15
* Notice in each file and include the License file at
16
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17
* particular file as subject to the "Classpath" exception as provided
18
* by Sun in the GPL Version 2 section of the License file that
19
* accompanied this code. If applicable, add the following below the
20
* License Header, with the fields enclosed by brackets [] replaced by
21
* your own identifying information:
22
* "Portions Copyrighted [year] [name of copyright owner]"
26
* The Original Software is NetBeans. The Initial Developer of the Original
27
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28
* Microsystems, Inc. All Rights Reserved.
30
* If you wish your version of this file to be governed by only the CDDL
31
* or only the GPL Version 2, indicate your decision by adding
32
* "[Contributor] elects to include this software in this distribution
33
* under the [CDDL or GPL Version 2] license." If you do not indicate a
34
* single choice of license, a recipient has the option to distribute
35
* your version of this file under either the CDDL, the GPL Version 2 or
36
* to extend the choice of license to its licensees as provided above.
37
* However, if you add GPL Version 2 code and therefore, elected the GPL
38
* Version 2 license, then the option applies only if the new code is
39
* made subject to such option by the copyright holder.
42
package org.netbeans.modules.xml.api.model;
44
import org.w3c.dom.Node;
45
import javax.swing.Icon;
48
* It represents additonal properties of a result option.
50
* It enriches DOM Node with information useful for presenting
51
* query result option to a user. Also all children or siblings of this
52
* result must be <code>GrammarResult</code> instances.
54
* It can have children representing mandatory content.
55
* However it is up to client if it uses the mandatory content.
57
* As in whole package provide only readonly DOM level 1 implementation.
60
* @stereotype description
62
public interface GrammarResult extends Node {
64
//Node getNode() use instead of extends Node
67
//boolean isRequired()
71
* @return name that is presented to user or <code>null</code> if
72
* <code>getNodeName()</code> is enough.
74
String getDisplayName();
77
* @return provide additional information simplifing decision
78
* (suitable for tooltip) or <code>null</code>
80
String getDescription();
83
* @param kind icon kind as given by BeanInfo
84
* @return an icon - a visual hint or <code>null</code>
86
Icon getIcon(int kind);
89
* For elements provide hint whether element has empty content model.
90
* @return true element has empty content model (no childs) and can
91
* be completed in empty element form i.e. <code><ement/></code>.
94
boolean isEmptyElement();