Package org.eclipse.pde.core.plugin
Interface IPluginObject
- 
- All Superinterfaces:
- IAdaptable,- IWritable
 - All Known Subinterfaces:
- IExtensions,- IFragment,- IPlugin,- IPluginAttribute,- IPluginBase,- IPluginElement,- IPluginExtension,- IPluginExtensionPoint,- IPluginImport,- IPluginLibrary,- IPluginParent
 
 public interface IPluginObject extends IWritable, IAdaptable A base interface for all the objects in the plug-in model.- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description ISharedPluginModelgetModel()Returns the model that owns this object.StringgetName()Returns the name of this model objectIPluginObjectgetParent()Returns the parent of this model object.IPluginBasegetPluginBase()Returns the top-level model object.IPluginModelBasegetPluginModel()Returns the model that owns this object.StringgetResourceString(String key)Returns a string by locating the provided key in the resource bundle associated with the model.StringgetTranslatedName()Returns the translated name of this model object using the result of 'getName()' call as a resource key.booleanisInTheModel()Returns true if this object is currently part of a model.booleanisValid()Returns true if this object has all the required attributes set, false otherwise.voidsetInTheModel(boolean inModel)Set the value indicating whether the object is currently part of a model.voidsetName(String name)Chances the name of this model object.- 
Methods inherited from interface org.eclipse.core.runtime.IAdaptablegetAdapter
 
- 
 
- 
- 
- 
Field Detail- 
P_NAMEstatic final String P_NAME A property name that will be used to notify that the "name" field has changed.- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getModelISharedPluginModel getModel() Returns the model that owns this object.- Returns:
- the model instance
 
 - 
getPluginModelIPluginModelBase getPluginModel() Returns the model that owns this object.- Returns:
- the model instance
 
 - 
getNameString getName() Returns the name of this model object- Returns:
- the object name
 
 - 
isInTheModelboolean isInTheModel() Returns true if this object is currently part of a model. It is useful to ignore modification events of objects that have not yet being added to the model or if they have been removed.- Returns:
- whether this object is currently part of a model
 
 - 
setInTheModelvoid setInTheModel(boolean inModel) Set the value indicating whether the object is currently part of a model. It is useful to ignore modification events of objects that have not yet being added to the model or if they have been removed.- Parameters:
- inModel- whether the object is currently part of a model
 
 - 
getTranslatedNameString getTranslatedName() Returns the translated name of this model object using the result of 'getName()' call as a resource key.- Returns:
- the translated name or the original name if not found
 
 - 
getParentIPluginObject getParent() Returns the parent of this model object.- Returns:
- the object's parent
 
 - 
getPluginBaseIPluginBase getPluginBase() Returns the top-level model object.- Returns:
- the top-level model object
 
 - 
getResourceStringString getResourceString(String key) Returns a string by locating the provided key in the resource bundle associated with the model.- Parameters:
- key- the name to use for resource bundle lookup
- Returns:
- value in the resource bundle for the provided key, or the key itself if not found.
 
 - 
setNamevoid setName(String name) throws CoreException Chances the name of this model object. This method may throw a CoreException if the model is not editable.- Parameters:
- name- the new object name
- Throws:
- CoreException- if the model is not editable
 
 - 
isValidboolean isValid() Returns true if this object has all the required attributes set, false otherwise.- Returns:
- true if all the required attributes are set.
 
 
- 
 
-