1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html>
<body>
<h2>Mime Resolver</h2>
<p>
GSF is based on mimetypes. Each GSF language plugin is associated
with a particular "mime type". For example, Ruby files have the
mime type <code>text/x-ruby</code>, JavaScript files have the mime
type <code>text/javascript</code>, and so on.
</p>
<p>
In order for GSF to add its editing services to particular files,
you have to teach the IDE how to recognize the mime type for your
files. You do that using the "mime resolver" support in NetBeans.
This is not particular to GSF, but it's a prerequisite.
</p>
<p>
Basically, all you have to do is write a simple XML file which
tells NetBeans for example that files with the extension <code>.foo</code>
have the mimetype <code>text/foo</code>. Once you've done that,
you can go to the <a href="registration.html">registration</a>
section and register editing services for the <code>text/foo</code>
mime type. GSF will provide DataLoaders, DataObjects etc. for
files of the mimetypes as soon as you do that.
</p>
<h3>Registering a Mime Resolver</h3>
<p>
When you create a new NetBeans plugin, it will typically create
an empty layer.xml file for you. This is an XML file where you
can register implementations of various IDE services.
In particular, to register a mime resolver, you'll need to
add something like this:
<pre style="background: #ffffcc; color: black; border: solid 1px black; padding: 5px">
<filesystem>
<b> <folder name="Services">
<folder name="MIMEResolver">
<file name="javascript.xml" url="jsresolver.xml">
<attr name="SystemFileSystem.localizingBundle" stringvalue="org.netbeans.modules.javascript.editing.Bundle"/>
<attr name="position" intvalue="190"/>
</file>
</folder>
</folder></b>
<filesystem>
</pre>
Here, the file name <code>javascript.xml</code> should be something unique that no other
mime resolver might have picked. The <code>url</code> attribute points to a filename
in the same directory as the layer.xml file. I'll cover that file next.
Finally, the attributes let you create a properly localized user visible description
of files of this file type.
</p>
<h3>Describing File Types</h3>
<p>
For the example above, you would create a <code>Bundle.properties</code> file in the same
package as the layer file (again, when you create a plugin you usually get one of these
created for you already), and it should contain something like this:
<pre>
Services/MIMEResolver/javascript.xml=JavaScript Files
</pre>
</p>
<h3>Writing a Mime Resolver</h3>
<p>
Finally, you need to go and write the actual mime resolver file, <code>jsresolver.xml</code>
(we could have named it anything, including <code>javascript.xml</code>).
<pre style="background: #ffffcc; color: black; border: solid 1px black; padding: 5px">
<!DOCTYPE MIME-resolver PUBLIC "-//NetBeans//DTD MIME Resolver 1.0//EN" "http://www.netbeans.org/dtds/mime-resolver-1_0.dtd">
<MIME-resolver>
<file>
<ext name="json"/>
<ext name="js"/>
<resolver mime="text/javascript"/>
</file>
</MIME-resolver>
</pre>
Here we're saying that files of extensions <code>json</code> and <code>js</code> should
be treated as JavaScript files. The DTD for mime resolvers allow more complex
analysis, such as analyzing file headers and such. Take a look
at the <a href="http://www.netbeans.org/dtds/mime-resolver-1_0.dtd">DTD</a> for
the full details. You can also write a custom class to do mime resolvers
if you have really specific needs. Avoid doing that if you can, since with a custom
mime resolver the IDE can't figure out what you're doing and do special optimizations.
There is an example of how to do this in the ruby editing module - look for <code>RubyMimeResolver</code> - but
again try to avoid this if you don't strictly have to do it.
</p>
<p>
Finally, note that there is a position attribute on the registration of the
mime resolver above. The position attributes are used to order the mime resolvers.
In case there are overlaps in registrations, order matters. For that reason,
pick some number. NetBeans integration unit tests will check all the layers and make
sure there aren't inconsistencies into folder orderings and will generate unit test
failures if there are.
</p>
<h3>Icons and Actions</h3>
<p>
Once you register your mime type with GSF (described in the
<a href="registration.html">registration document</a>, files shown in the
Files and Projects views will be handled by GSF.
You can also assign a custom icon to file as well as context menu actions.
To do this, you need a few more registration steps. Add something like the
following to your layer:
<pre style="background: #ffffcc; color: black; border: solid 1px black; padding: 5px">
<folder name="Loaders">
<folder name="text">
<folder name="javascript">
<b><attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/netbeans/modules/javascript/editing/javascript.png"/>
<attr name="iconBase" stringvalue="org/netbeans/modules/javascript/editing/javascript.png"/></b>
<folder name="Actions">
<file name="OpenAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.OpenAction"/>
<attr name="position" intvalue="100"/>
</file>
<file name="Separator1.instance">
<attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
<attr name="position" intvalue="200"/>
</file>
<file name="CutAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.CutAction"/>
<attr name="position" intvalue="300"/>
</file>
<file name="CopyAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.CopyAction"/>
<attr name="position" intvalue="400"/>
</file>
<file name="PasteAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.PasteAction"/>
<attr name="position" intvalue="500"/>
</file>
<file name="Separator2.instance">
<attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
<attr name="position" intvalue="600"/>
</file>
<file name="NewAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.NewAction"/>
<attr name="position" intvalue="700"/>
</file>
<file name="DeleteAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.DeleteAction"/>
<attr name="position" intvalue="800"/>
</file>
<file name="RenameAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.RenameAction"/>
<attr name="position" intvalue="900"/>
</file>
<file name="Separator3.instance">
<attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
<attr name="position" intvalue="1000"/>
</file>
<file name="SaveAsTemplateAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.SaveAsTemplateAction"/>
<attr name="position" intvalue="1100"/>
</file>
<file name="Separator4.instance">
<attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
<attr name="position" intvalue="1200"/>
</file>
<file name="FileSystemAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.FileSystemAction"/>
<attr name="position" intvalue="1300"/>
</file>
<file name="Separator5.instance">
<attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
<attr name="position" intvalue="1400"/>
</file>
<file name="ToolsAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.ToolsAction"/>
<attr name="position" intvalue="1500"/>
</file>
<file name="PropertiesAction.instance">
<attr name="instanceClass" stringvalue="org.openide.actions.PropertiesAction"/>
<attr name="position" intvalue="1600"/>
</file>
</folder>
</folder>
</folder>
</folder>
</pre>
Here, the highlighted section shows how an icon is assigned to this type.
You need to place an icon in the directory shown in the attribute. The rest
of this section registers various common actions you might want on your
files. These are all standard actions defined by NetBeans so you don't
have to write these on your own.
</p>
<br/>
<span style="color: #cccccc">Tor Norbye <tor@netbeans.org></span>
</body>
</html>
|
