Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> pde >> core >> [ plugin overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.pde.core.plugin
Interface IPluginModelBase  

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.pde.core.IBaseModel, org.eclipse.pde.core.IModel, org.eclipse.pde.core.IModelChangeProvider, ISharedExtensionsModel, ISharedPluginModel

All Known Subinterfaces:

IFragmentModel, IPluginModel

---

public interface IPluginModelBase

extends ISharedExtensionsModel, org.eclipse.pde.core.IModelChangeProvider

This type of model is created by parsing the manifest file. It serves as a base interface for both plug-in and fragment models by holding data common to both. If the file is a workspace resource, it will be available as the underlying resource of the model. The model may be read-only or editable. It will also make a reference to the build.properties model when created. The reference will be of the same type as the model itself: if the model is editable, it will attempt to obtain an exclusive editable copy of build.properties model.

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.

---

Method Summary
IPluginBase	createPluginBase()
org.eclipse.pde.core.build.IBuildModel	getBuildModel()           Returns an associated build.properties model that works in conjunction with this model.
org.eclipse.osgi.service.resolver.BundleDescription	getBundleDescription()           Returns the bundle description of the plug-in in case the plug-in uses the new OSGi bundle layout.
java.net.URL	getNLLookupLocation()           Returns the location where property file containing translations of names in this model can be found.
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(org.eclipse.osgi.service.resolver.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.

 

Methods inherited from interface org.eclipse.pde.core.plugin.ISharedExtensionsModel

getExtensions, getExtensions

 

Methods inherited from interface org.eclipse.pde.core.plugin.ISharedPluginModel

getFactory, getInstallLocation

 

Methods inherited from interface org.eclipse.pde.core.IModel

getResourceString, getTimeStamp, getUnderlyingResource, isInSync, isLoaded, isReconcilingModel, load, load, reload

 

Methods inherited from interface org.eclipse.pde.core.IBaseModel

dispose, isDisposed, isEditable, isValid

 

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

 

Methods inherited from interface org.eclipse.pde.core.IModelChangeProvider

addModelChangedListener, fireModelChanged, fireModelObjectChanged, removeModelChangedListener

 

Method Detail

createPluginBase

public IPluginBase createPluginBase()

---

getBuildModel

public org.eclipse.pde.core.build.IBuildModel getBuildModel()

Returns an associated build.properties model that works in conjunction with this model.

---

getPluginBase

public IPluginBase getPluginBase()

Returns a top-level model object. Equivalent to calling

getPluginBase(true)

.

---

getPluginBase

public IPluginBase getPluginBase(boolean createIfMissing)

Returns a top-level model object.

---

isEnabled

public boolean isEnabled()

Returns true if this model is currently enabled.

---

isFragmentModel

public boolean isFragmentModel()

Tests if this model is for the plug-in fragment.

---

setEnabled

public void setEnabled(boolean enabled)

Sets the enable state of the model.

---

getPluginFactory

public IPluginModelFactory getPluginFactory()

Returns the factory that can be used to create new objects for this model

---

getNLLookupLocation

public java.net.URL getNLLookupLocation()

Returns the location where property file containing translations of names in this model can be found.

---

getBundleDescription

public org.eclipse.osgi.service.resolver.BundleDescription getBundleDescription()

Returns the bundle description of the plug-in in case the plug-in uses the new OSGi bundle layout.

Since:

3.0

---

setBundleDescription

public void setBundleDescription(org.eclipse.osgi.service.resolver.BundleDescription description)

Associates the bundle description of the plug-in with this model in case the plug-in uses the new OSGi bundle layout.

Since:

3.0

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> pde >> core >> [ plugin overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---