Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2000, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
package org.eclipse.help.ui;
Descriptor of a concrete instance of a search engine. It describes the search engine instance that is either loaded from the plug-in extension point contribution, or created by the user in the scope settings dialog. Engines created by the user are marked as such. Only user-defined engines will permit their label or description changed.

This interface is not intended to be extended or implemented by clients.

Since:
3.1
Noimplement:
This interface is not intended to be implemented by clients.
Noextend:
This interface is not intended to be extended by clients.
public interface IEngineDescriptor {
Returns the unique identifier of this engine instance.

Returns:
the unique engine identifier
Returns the unique identifier of the engine type of which this is an instance.

Returns:
the engine type identifier
Returns the label of this engine for rendering in the UI.

Returns:
the engine label
Changes the label of this engine. This method does nothing for engine descriptors that are not user-defined.

Parameters:
label the new engine label
	void setLabel(String label);

Returns the description of this engine instance. It is initialized from the engine type description.

Returns:
the engine instance description.
Changes the description of this engine. This method does nothing for engine descriptors that are not user-defined.

Parameters:
desc the new engine description
	void setDescription(String desc);

Returns the parameters used to configure this engine according to the valid parameters for the associated engine type.

Returns:
the parameter dictionary
Tests whether this engine is provided as an extension point contribution or is created by the user in the scope settings dialog. Only user-defined engine instances can have their label and/or description changed.

Returns:
true if the engine is user defined, or false otherwise.
	boolean isUserDefined();
New to GrepCode? Check out our FAQ X