Attachment #131993 for bug #160415

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 160415
Collapse All | Expand All

Lines 131-144 Link Here

(-)a/api.search/arch.xml (-33 / +52 lines)
131	<answer id="arch-usecases">	131	<answer id="arch-usecases">
132	<usecase id="searchHistory" name="Search History">	132	<usecase id="searchHistory" name="Search History">
133	<p>	133	<p>
134	SearchHistory is synchronising history content through netbeans modules and it saves history to preferences.	134	<code><a href="@TOP@/org/netbeans/api/search/SearchHistory.html">SearchHistory</a></code>
		135	is synchronising history content through netbeans modules and it saves history to preferences.
135	</p>	136	</p>
136	<p>	137	<p>
137	There are two separate histories. One for search and another for replace.	138	There are two separate histories. One for search and another for replace.
138	When you add your propertyListener to SearchHistory - you can listen for changes in histories.	139	When you add your propertyListener to
		140	<code><a href="@TOP@/org/netbeans/api/search/SearchHistory.html">SearchHistory</a></code>
		141	- you can listen for changes in histories.
139	</p>	142	</p>
140	<p>	143	<p>
141	SearchHistory has methods for adding new entries and getting whole history list.	144	<code><a href="@TOP@/org/netbeans/api/search/SearchHistory.html">SearchHistory</a></code>
		145	has methods for adding new entries and getting whole history list.
142	</p>	146	</p>
143		147
144	</usecase>	148	</usecase>
Lines 153-184 Link Here
153	</p>	157	</p>
154	<p>	158	<p>
155	The definition is represented by objects extending class	159	The definition is represented by objects extending class
156	<code>SearchInfoDefinition</code>. To customize searching on	160	<code>
157	a custom node, a	161	<a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinition.html">
		162	SearchInfoDefinition</a>
		163	</code>. To customize searching on a custom node, a
158	<code>SearchInfoDefinition</code> object must be added to the node's lookup.	164	<code>SearchInfoDefinition</code> object must be added to the node's lookup.
159	In most cases, there is no need to define own class extending the	165	In most cases, there is no need to define own class extending the
160	class - one can use factory methods of class	166	class - one can use factory methods of class
161	<code>SearchInfoDefinitionFactory</code>.	167	<code>
		168	<a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinitionFactory.html">
		169	SearchInfoDefinitionFactory</a>
		170	</code>.
162	</p>	171	</p>
163	<p>	172	<p>
164	In some cases implementators may need to apply the same set	173	In some cases implementators may need to apply the same set
165	of SearchFilterDefinitions in the whole subtree of a node.	174	of SearchFilterDefinitions in the whole subtree of a node.
166	If so, it is not needed to put SearchInfoDefinition to all	175	If so, it is not needed to put <code>SearchInfoDefinition</code> to all
167	nodes' lookups, but only one instance of SubTreeSearchOptions	176	nodes' lookups, but only one instance of <code>
168	have to be put into the lookup of the root node.	177	<a href="@TOP@/org/netbeans/spi/search/SubTreeSearchOptions.html">
		178	SubTreeSearchOptions</a>
		179	</code> have to be put into the lookup of the root node.
169	</p>	180	</p>
170		181
171	<api group="java"	182	<api group="java"
172	name="SearchInfoSPI"	183	name="SearchInfoSPI"
173	type="export"	184	type="export"
174	category="devel"	185	category="stable"
175	url="@TOP@org/netbeans/spi/search/package-summary.html">	186	url="@TOP@org/netbeans/spi/search/package-summary.html">
176	Defines abstract classes	187	Defines abstract classes
177	<code>SearchInfoDefinition</code>,	188	<code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinition.html">SearchInfoDefinition</a></code>,
178	<code>SearchFilterDefinition</code>,	189	<code><a href="@TOP@/org/netbeans/spi/search/SearchFilterDefinition.html">SearchFilterDefinition</a></code>,
179	<code>SubTreeSearchOptions</code>	190	<code><a href="@TOP@/org/netbeans/spi/search/SubTreeSearchOptions.html">SubTreeSearchOptions</a></code>
180	and a factory class	191	and a factory class
181	<code>SearchInfoDefinitionFactory</code>	192	<code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinitionFactory.html">SearchInfoDefinitionFactory</a></code>
182	</api>	193	</api>
183	</usecase>	194	</usecase>
184	<usecase id="SearchProvider" name="Enhance IDE searching features">	195	<usecase id="SearchProvider" name="Enhance IDE searching features">
Lines 192-241 Link Here
192	</p>	203	</p>
193	<ul>	204	<ul>
194	<li>	205	<li>
195	<code>SearchProvider</code> to register the new search feature to the IDE or platform application.	206	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.html">SearchProvider</a></code>
		207	to register the new search feature to the IDE or platform application.
196	</li>	208	</li>
197	<li>	209	<li>
198	<code>SearchProvider.Presenter</code> that creates visual component for adding to the search dialog and that can interact with dialog buttons.	210	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.Presenter.html">SearchProvider.Presenter</a></code>
		211	that creates visual component for adding to the search dialog and that can interact with dialog buttons.
199	</li>	212	</li>
200	<li>	213	<li>
201	<code>SearchResultsDisplayer</code> to show search results to the user.	214	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchResultsDisplayer.html">SearchResultsDisplayer</a></code>
		215	to show search results to the user.
202	</li>	216	</li>
203	<li>	217	<li>
204	<code>SearchComposition</code> that encapsulates setting and state of searches, provide access to result displayer, and is able to start and terminate the search.	218	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchComposition.html">SearchComposition</a></code>
		219	that encapsulates setting and state of searches, provide access to result displayer, and is able to start
		220	and terminate the search.
205	</li>	221	</li>
206	</ul>	222	</ul>
207	<api group="java"	223	<api group="java"
208	name="SearchProviderSPI"	224	name="SearchProviderSPI"
209	type="export"	225	type="export"
210	category="devel"	226	category="stable"
211	url="@TOP@org/netbeans/spi/search/provider/package-summary.html">	227	url="@TOP@org/netbeans/spi/search/provider/package-summary.html">
212	Defines abstract classes that need to be implemented when	228	Defines abstract classes that need to be implemented when
213	creating custom providers:	229	creating custom providers:
214	<code>SearchProvider</code>,	230	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.html">SearchProvider</a></code>,
215	<code>SearchProvider.Presenter</code>,	231	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.Presenter.html">SearchProvider.Presenter</a></code>,
216	<code>SearchResultsDisplayer</code>,	232	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchResultsDisplayer.html">SearchResultsDisplayer</a></code>,
217	<code>SearchComposition</code>	233	<code><a href="@TOP@/org/netbeans/spi/search/provider/SearchComposition.html">SearchComposition</a></code>
218	and relative classes.	234	and relative classes.
219	</api>	235	</api>
220	<api group="java"	236	<api group="java"
221	name="SearchProviderAPI"	237	name="SearchProviderAPI"
222	type="export"	238	type="export"
223	category="devel"	239	category="stable"
224	url="@TOP@org/netbeans/api/search/provider/package-summary.html">	240	url="@TOP@org/netbeans/api/search/provider/package-summary.html">
225		241
226	Classes usually used by search providers.	242	Classes usually used by search providers.
227	Contains class <code>SearchInfo</code>, that defines which files	243	Contains class <code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfo.html">SearchInfo</a></code>,
228	should be searched (it can be retrieved from methods in	244	that defines which files should be searched (it can be retrieved from methods in
229	SearchInfoUtils, or UI component ScopeComboBox), <code>	245	<code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfoUtils.html">SearchInfoUtils</a></code>,
230	SearchListener</code> that you should inform about events that	246	or UI component controller <code><a href="@TOP@/org/netbeans/api/search/ui/ScopeController.html">ScopeController</a></code>),
231	happen during searching, and helper classes <code>FileInfoUtils	247	<code><a href="@TOP@/org/netbeans/api/search/provider/SearchListener.html">SearchListener</a></code>
232	</code> (getting SearchInfo objects for nodes) and	248	that you should inform about events that happen during searching, and helper classes
233	<code>FileNameMatcher</code> (filtering files by file name).	249	<code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfoUtils.html">SearchInfoUtils</a></code>
		250	(getting SearchInfo objects for nodes) and
		251	<code><a href="@TOP@/org/netbeans/api/search/provider/FileNameMatcher.html">FileNameMatcher</a></code>
		252	(filtering files by file name).
234	</api>	253	</api>
235	<api group="java"	254	<api group="java"
236	name="SearchProviderUIAPI"	255	name="SearchProviderUIAPI"
237	type="export"	256	type="export"
238	category="devel"	257	category="stable"
239	url="@TOP@org/netbeans/api/search/ui/package-summary.html">	258	url="@TOP@org/netbeans/api/search/ui/package-summary.html">
240		259
241	Several UI components that can be used in presenters of search	260	Several UI components that can be used in presenters of search
Lines 251-257 Link Here
251	<api group="java"	270	<api group="java"
252	name="SearchAPI"	271	name="SearchAPI"
253	type="export"	272	type="export"
254	category="devel"	273	category="stable"
255	url="@TOP@org/netbeans/api/search/package-summary.html">	274	url="@TOP@org/netbeans/api/search/package-summary.html">
256		275
257	Contains classes for controlling search, passing search	276	Contains classes for controlling search, passing search

Lines 1-3 Link Here

(-)a/api.search/src/org/netbeans/api/search/Bundle.properties (-1 / +1 lines)
1	OpenIDE-Module-Display-Category=Infrastructure	1	OpenIDE-Module-Display-Category=Infrastructure
2	OpenIDE-Module-Name=Search in Projects API	2	OpenIDE-Module-Name=Search API
3	OpenIDE-Module-Short-Description=API for controlling search in projects and for implementing custom search providers	3	OpenIDE-Module-Short-Description=API for controlling search in projects and for implementing custom search providers

Lines 61-68 Link Here

(-)a/api.search/src/org/netbeans/api/search/ReplacePattern.java (-2 / +2 lines)
61	/**	61	/**
62	* Creates a new ReplacePattern in accordance with given parameters	62	* Creates a new ReplacePattern in accordance with given parameters
63	*	63	*
64	* @param searchExpression non-null String of a searched text	64	* @param replaceExpression non-null String of a replace expression
65	* @param wholeWords if true, only whole words were searched	65	* @param preserveCase if true, the case of original text will be preserved
66	*/	66	*/
67	public static ReplacePattern create(String replaceExpression, boolean preserveCase) {	67	public static ReplacePattern create(String replaceExpression, boolean preserveCase) {
68	return new ReplacePattern(replaceExpression, preserveCase);	68	return new ReplacePattern(replaceExpression, preserveCase);




<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2013 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Other names may be trademarks of their respective owners.

The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2013 Sun Microsystems, Inc.
-->
<!DOCTYPE html>
<html>
    <body>
        <p>
            This package contains classes that can be used by modules that need
            to work with <i>Search in Projects</i> dialog, or want to share
            information about what data was recently searched.
            There are also some utility classes for general usage.
        </p>
        <p>
            If you want to get or store recently searched items, see
            <code><a href="@TOP@/org/netbeans/api/search/SearchHistory.html">SearchHistory</a></code>,
            <code><a href="@TOP@/org/netbeans/api/search/SearchPattern.html">SearchPattern</a></code>
            and <code><a href="@TOP@/org/netbeans/api/search/ReplacePattern.html">ReplacePattern</a></code>
        </p>
        <p>
            To display <i>Find in Project</i> dialog, and start a search with
            predefine criteria, use
            <code><a href="@TOP@/org/netbeans/api/search/SearchControl.html">SearchControl</a></code>
            with <code><a href="@TOP@/org/netbeans/api/search/SearchScopeOptions.html">SearchScopeOptions</a></code>.
        </p>
        <p>
            Class <code><a href="@TOP@/org/netbeans/api/search/SearchRoot.html">SearchRoot</a></code> defines
            a location in a filesystem where the search should start.
            <code><a href="@TOP@/org/netbeans/api/search/RegexpUtil.html">RegexpUtil</a></code> can create a pattern
            for matching file names. These classes can be useful when implementing some custom search infrastructure.
        </p>
    </body>
</html>




<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2013 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Other names may be trademarks of their respective owners.

The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2013 Sun Microsystems, Inc.
-->
<!DOCTYPE html>
<html>
    <body>
        <p>
            Classes that you may need to work with if you are implementing
            a custom search provider.
        </p>
        <p>
            <code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfo.html">SearchInfo</a></code>
            defines what should be searched. It contains set of files or folders (what should be searched)
            with associated
            <code><a href="@TOP@/org/netbeans/api/search/provider/SearchFilter.html">SearchFilter</a></code>s
            (what should be skipped in those folders).
        </p>
        <p>
            <code><a href="@TOP@/org/netbeans/api/search/provider/SearchListener.html">SearchListener</a></code>
            is an object that will be passed to your implementation of
            <code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfo.html">SearchInfo</a></code>
            and that you should inform about interesting events that occur during the search.
        </p>
        <p>
            <code><a href="@TOP@/org/netbeans/api/search/provider/SearchInfoUtils.html">SearchInfoUtils</a></code>
            contains utility methods for creation of search info for nodes or for files.
            <code><a href="@TOP@/org/netbeans/api/search/provider/FileNameMatcher.html">FileNameMatcher</a></code>
            matches files to current search options.
        </p>
    </body>
</html>

Lines 323-329 Link Here

(-)a/api.search/src/org/netbeans/api/search/ui/SearchPatternController.java (-1 / +1 lines)
323	*	323	*
324	* @param comboBox Combo box to control and display the match type. The	324	* @param comboBox Combo box to control and display the match type. The
325	* model of the combo box can contain only items of type {@link MatchType}.	325	* model of the combo box can contain only items of type {@link MatchType}.
326	* {@link MatchType.LITERAL} and {@link MatchType.REGEXP} are mandatory in	326	* {@link MatchType#LITERAL} and {@link MatchType#REGEXP} are mandatory in
327	* the model.	327	* the model.
328	*	328	*
329	* @since api.search/1.11	329	* @since api.search/1.11




<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2013 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Other names may be trademarks of their respective owners.

The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2013 Sun Microsystems, Inc.
-->
<!DOCTYPE html>
<html>
    <body>
        <p>
            This package contains class <code><a href="@TOP@/org/netbeans/api/search/ui/ComponentUtils.html">ComponentUtils</a></code>
            that can adjust fresh UI components to be used in panels for
            <code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.Presenter.html">SearchProvider.Presenter</a></code>.
        </p>
        <p>
            The advantage of modifying of existing components and returning
            controller objects (instead of using subclasses of swing components)
            is that it can be comfortably used with NetBeasn GUI Builder.
        </p>
    </body>
</html>




<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2013 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Other names may be trademarks of their respective owners.

The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2013 Sun Microsystems, Inc.
-->
<!DOCTYPE html>
<html>
    <body>
        <p>
            This package contains classes that you can subclass and register to
            lookups of nodes if you want to specify how the nodes should be
            searched. For this, use
            <code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinition.html">SearchInfoDefinition</a></code>
            or <code><a href="@TOP@/org/netbeans/spi/search/SubTreeSearchOptions.html">SubTreeSearchOptions</a></code>,
            and possibly <code><a href="@TOP@/org/netbeans/spi/search/SearchFilterDefinition.html">SearchFilterDefinition</a></code>
            and <code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinitionFactory.html">SearchInfoDefinitionFactory</a></code>.
        </p>
        <p>
            To add a custom search scope to <i>Find in Projects</i> dialog,
            you will need to subclass
            <code><a href="@TOP@/org/netbeans/spi/search/SearchScopeDefinition.html">SearchScopeDefinition</a></code>
            and <code><a href="@TOP@/org/netbeans/spi/search/SearchScopeDefinitionProvider.html">SearchScopeDefinitionProvider</a></code>.
        </p>
    </body>
</html>




<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2013 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Other names may be trademarks of their respective owners.

The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2013 Sun Microsystems, Inc.
-->
<!DOCTYPE html>
<html>
    <body>
        <p>
            This package contains classes that are needed to add a custom panel
            to <i>Find in Projects</i> dialog, that can have customized search
            criteria, search algorithm and results panel.
        </p>
        <p>
            The entry point for such custom search provider is class
            <code><a href="@TOP@/org/netbeans/spi/search/provider/SearchProvider.html">SearchProvider</a></code>.
        </p>
    </body>
</html>

Lines 146-151 Link Here

(-)a/nbbuild/build.properties (-1 / +1 lines)
146	api.visual,\	146	api.visual,\
147	api.java,\	147	api.java,\
148	api.java.classpath,\	148	api.java.classpath,\
		149	api.search,\
149	java.platform,\	150	java.platform,\
150	java.project,\	151	java.project,\
151	java.source,\	152	java.source,\
Lines 168-174 Link Here
168	nbjunit,\	169	nbjunit,\
169	jellytools.platform,\	170	jellytools.platform,\
170	jellytools.ide,\	171	jellytools.ide,\
171	api.search,\
172	core.netigso,\	172	core.netigso,\
173	o.n.swing.outline,\	173	o.n.swing.outline,\
174	o.n.swing.tabcontrol,\	174	o.n.swing.tabcontrol,\

Lines 40-46 Link Here

(-)a/o.openidex.util/src/org/openidex/resources/Bundle.properties (-1 / +1 lines)
40	# Version 2 license, then the option applies only if the new code is	40	# Version 2 license, then the option applies only if the new code is
41	# made subject to such option by the copyright holder.	41	# made subject to such option by the copyright holder.
42		42
43	OpenIDE-Module-Name=Search API	43	OpenIDE-Module-Name=Deprecated, old search API
44	OpenIDE-Module-Display-Category=Infrastructure	44	OpenIDE-Module-Display-Category=Infrastructure
45	OpenIDE-Module-Short-Description=Search API for use by various modules.	45	OpenIDE-Module-Short-Description=Search API for use by various modules.
46	OpenIDE-Module-Long-Description=\	46	OpenIDE-Module-Long-Description=\

Return to bug 160415

Line 0 Link Here

(-)a/api.search/src/org/netbeans/api/search/package.html (+70 lines)
		1	<!--
		2	DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
		3
		4	Copyright 2013 Oracle and/or its affiliates. All rights reserved.
		5
		6	Oracle and Java are registered trademarks of Oracle and/or its affiliates.
		7	Other names may be trademarks of their respective owners.
		8
		9	The contents of this file are subject to the terms of either the GNU
		10	General Public License Version 2 only ("GPL") or the Common
		11	Development and Distribution License("CDDL") (collectively, the
		12	"License"). You may not use this file except in compliance with the
		13	License. You can obtain a copy of the License at
		14	http://www.netbeans.org/cddl-gplv2.html
		15	or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
		16	specific language governing permissions and limitations under the
		17	License. When distributing the software, include this License Header
		18	Notice in each file and include the License file at
		19	nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
		20	particular file as subject to the "Classpath" exception as provided
		21	by Oracle in the GPL Version 2 section of the License file that
		22	accompanied this code. If applicable, add the following below the
		23	License Header, with the fields enclosed by brackets [] replaced by
		24	your own identifying information:
		25	"Portions Copyrighted [year] [name of copyright owner]"
		26
		27	If you wish your version of this file to be governed by only the CDDL
		28	or only the GPL Version 2, indicate your decision by adding
		29	"[Contributor] elects to include this software in this distribution
		30	under the [CDDL or GPL Version 2] license." If you do not indicate a
		31	single choice of license, a recipient has the option to distribute
		32	your version of this file under either the CDDL, the GPL Version 2 or
		33	to extend the choice of license to its licensees as provided above.
		34	However, if you add GPL Version 2 code and therefore, elected the GPL
		35	Version 2 license, then the option applies only if the new code is
		36	made subject to such option by the copyright holder.
		37
		38	Contributor(s):
		39
		40	Portions Copyrighted 2013 Sun Microsystems, Inc.
		41	-->
		42	<!DOCTYPE html>
		43	<html>
		44	<body>
		45	<p>
		46	This package contains classes that can be used by modules that need
		47	to work with <i>Search in Projects</i> dialog, or want to share
		48	information about what data was recently searched.
		49	There are also some utility classes for general usage.
		50	</p>
		51	<p>
		52	If you want to get or store recently searched items, see
		53	<code><a href="@TOP@/org/netbeans/api/search/SearchHistory.html">SearchHistory</a></code>,
		54	<code><a href="@TOP@/org/netbeans/api/search/SearchPattern.html">SearchPattern</a></code>
		55	and <code><a href="@TOP@/org/netbeans/api/search/ReplacePattern.html">ReplacePattern</a></code>
		56	</p>
		57	<p>
		58	To display <i>Find in Project</i> dialog, and start a search with
		59	predefine criteria, use
		60	<code><a href="@TOP@/org/netbeans/api/search/SearchControl.html">SearchControl</a></code>
		61	with <code><a href="@TOP@/org/netbeans/api/search/SearchScopeOptions.html">SearchScopeOptions</a></code>.
		62	</p>
		63	<p>
		64	Class <code><a href="@TOP@/org/netbeans/api/search/SearchRoot.html">SearchRoot</a></code> defines
65	a location in a filesystem where the search should start.
66	<code><a href="@TOP@/org/netbeans/api/search/RegexpUtil.html">RegexpUtil</a></code> can create a pattern
67	for matching file names. These classes can be useful when implementing some custom search infrastructure.
68	</p>
69	</body>
70	</html>

Line 0 Link Here

(-)a/api.search/src/org/netbeans/spi/search/package.html (+61 lines)
	1	<!--
	2	DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
	3
	4	Copyright 2013 Oracle and/or its affiliates. All rights reserved.
	5
	6	Oracle and Java are registered trademarks of Oracle and/or its affiliates.
	7	Other names may be trademarks of their respective owners.
	8
	9	The contents of this file are subject to the terms of either the GNU
	10	General Public License Version 2 only ("GPL") or the Common
	11	Development and Distribution License("CDDL") (collectively, the
	12	"License"). You may not use this file except in compliance with the
	13	License. You can obtain a copy of the License at
	14	http://www.netbeans.org/cddl-gplv2.html
	15	or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
	16	specific language governing permissions and limitations under the
	17	License. When distributing the software, include this License Header
	18	Notice in each file and include the License file at
	19	nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
	20	particular file as subject to the "Classpath" exception as provided
	21	by Oracle in the GPL Version 2 section of the License file that
	22	accompanied this code. If applicable, add the following below the
	23	License Header, with the fields enclosed by brackets [] replaced by
	24	your own identifying information:
	25	"Portions Copyrighted [year] [name of copyright owner]"
	26
	27	If you wish your version of this file to be governed by only the CDDL
	28	or only the GPL Version 2, indicate your decision by adding
	29	"[Contributor] elects to include this software in this distribution
	30	under the [CDDL or GPL Version 2] license." If you do not indicate a
	31	single choice of license, a recipient has the option to distribute
	32	your version of this file under either the CDDL, the GPL Version 2 or
	33	to extend the choice of license to its licensees as provided above.
	34	However, if you add GPL Version 2 code and therefore, elected the GPL
	35	Version 2 license, then the option applies only if the new code is
	36	made subject to such option by the copyright holder.
	37
	38	Contributor(s):
	39
	40	Portions Copyrighted 2013 Sun Microsystems, Inc.
	41	-->
	42	<!DOCTYPE html>
	43	<html>
	44	<body>
	45	<p>
	46	This package contains classes that you can subclass and register to
	47	lookups of nodes if you want to specify how the nodes should be
	48	searched. For this, use
	49	<code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinition.html">SearchInfoDefinition</a></code>
	50	or <code><a href="@TOP@/org/netbeans/spi/search/SubTreeSearchOptions.html">SubTreeSearchOptions</a></code>,
	51	and possibly <code><a href="@TOP@/org/netbeans/spi/search/SearchFilterDefinition.html">SearchFilterDefinition</a></code>
	52	and <code><a href="@TOP@/org/netbeans/spi/search/SearchInfoDefinitionFactory.html">SearchInfoDefinitionFactory</a></code>.
	53	</p>
	54	<p>
	55	To add a custom search scope to <i>Find in Projects</i> dialog,
	56	you will need to subclass
	57	<code><a href="@TOP@/org/netbeans/spi/search/SearchScopeDefinition.html">SearchScopeDefinition</a></code>
	58	and <code><a href="@TOP@/org/netbeans/spi/search/SearchScopeDefinitionProvider.html">SearchScopeDefinitionProvider</a></code>.
	59	</p>
	60	</body>
	61	</html>