public interface IPluginModelBase extends ISharedExtensionsModel, IModelChangeProvider
The plug-in model can be disabled. Disabling the model will not change its data. Users of the model will have to decide if the disabled state if of any importance to them or not.
The model is capable of notifying listeners about changes. An attempt to change a read-only model will result in a CoreException.
Modifier and Type | Method and Description |
---|---|
IPluginBase |
createPluginBase()
Creates and return a top-level plugin model object
|
IBuildModel |
getBuildModel()
Deprecated.
This method has always returned
null .
Since 3.7, use PluginRegistry.createBuildModel(IPluginModelBase) instead. |
BundleDescription |
getBundleDescription()
Returns the bundle description of the plug-in
in case the plug-in uses the new OSGi bundle layout.
|
URL |
getNLLookupLocation()
Deprecated.
The URL returned is not encoded. If the file
path contains special characters such as
#
this URL cannot be used for opening streams. Instead use
ISharedPluginModel.getInstallLocation() and create the URL using
an encoding tool such as URIUtil . Deprecated in
4.3. |
IPluginBase |
getPluginBase()
Returns a top-level model object.
|
IPluginBase |
getPluginBase(boolean createIfMissing)
Returns a top-level model object.
|
IPluginModelFactory |
getPluginFactory()
Returns the factory that can be used to
create new objects for this model
|
boolean |
isEnabled()
Returns true if this model is currently enabled.
|
boolean |
isFragmentModel()
Tests if this model is for the plug-in fragment.
|
void |
setBundleDescription(BundleDescription description)
Associates the bundle description of the plug-in
with this model in case the plug-in uses the new
OSGi bundle layout.
|
void |
setEnabled(boolean enabled)
Sets the enable state of the model.
|
getExtensions, getExtensions
getFactory, getInstallLocation
getResourceString, getTimeStamp, getUnderlyingResource, isInSync, isLoaded, isReconcilingModel, load, load, reload
dispose, isDisposed, isEditable, isValid
getAdapter
addModelChangedListener, fireModelChanged, fireModelObjectChanged, removeModelChangedListener
IPluginBase createPluginBase()
IBuildModel getBuildModel()
null
.
Since 3.7, use PluginRegistry.createBuildModel(IPluginModelBase)
instead.
This method always returns null
null
IPluginBase getPluginBase()
getPluginBase(true).
IPluginBase getPluginBase(boolean createIfMissing)
createIfMissing
- if true, root model object will
be created if not defined.boolean isEnabled()
boolean isFragmentModel()
true
if the model is for the fragment,
false
otherwise.void setEnabled(boolean enabled)
enabled
- the new enable stateIPluginModelFactory getPluginFactory()
URL getNLLookupLocation()
#
this URL cannot be used for opening streams. Instead use
ISharedPluginModel.getInstallLocation()
and create the URL using
an encoding tool such as URIUtil
. Deprecated in
4.3.BundleDescription getBundleDescription()
null
if the plug-in is in a classic
format.void setBundleDescription(BundleDescription description)
description
- bundle description to associate
with this model
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.