org.eclipse.ercp.eworkbench
Class ApplicationDescriptor

java.lang.Object
  extended by org.eclipse.ercp.eworkbench.ApplicationDescriptor
All Implemented Interfaces:
IApplicationDescriptor, IPluginContribution

public class ApplicationDescriptor
extends java.lang.Object
implements IApplicationDescriptor, IPluginContribution

class used to describe an eRCP application


Constructor Summary
ApplicationDescriptor(java.lang.String id, IConfigurationElement configElement)
          Create a descriptor from a config element.
ApplicationDescriptor(java.lang.String id, java.lang.String label)
          Create a new empty descriptor.
 
Method Summary
 java.lang.String getClassName()
          Returns the factory class name for this descriptor.
 IConfigurationElement getConfigElement()
          Return the configuration element used to create this perspective, if one was used.
 java.lang.String getDescription()
           
 java.lang.String getId()
           
 ImageDescriptor getImageDescriptor()
           
 java.lang.String getLabel()
           
 java.lang.String getLocalId()
           
 java.lang.String getPluginId()
           
 java.lang.String getViewId(java.lang.String type)
           
 boolean isSingleton()
          Returns true if this perspective is a singleton.
 void setViewId(java.lang.String type, java.lang.String id)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApplicationDescriptor

public ApplicationDescriptor(java.lang.String id,
                             java.lang.String label)
Create a new empty descriptor.

Parameters:
id - the id of the new descriptor
label - the label of the new descriptor
originalDescriptor - the descriptor that this descriptor is based on

ApplicationDescriptor

public ApplicationDescriptor(java.lang.String id,
                             IConfigurationElement configElement)
                      throws CoreException
Create a descriptor from a config element.

Parameters:
id - the id of the element to create
configElement - the element to base this perspective on
Throws:
CoreException - thrown if there are any missing attributes
Method Detail

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface IApplicationDescriptor

getId

public java.lang.String getId()
Specified by:
getId in interface IApplicationDescriptor

getImageDescriptor

public ImageDescriptor getImageDescriptor()
Specified by:
getImageDescriptor in interface IApplicationDescriptor

getLabel

public java.lang.String getLabel()
Specified by:
getLabel in interface IApplicationDescriptor

isSingleton

public boolean isSingleton()
Returns true if this perspective is a singleton.

Specified by:
isSingleton in interface IApplicationDescriptor
Returns:
whether this perspective is a singleton

getConfigElement

public IConfigurationElement getConfigElement()
Return the configuration element used to create this perspective, if one was used.

Returns:
the configuration element used to create this perspective

getLocalId

public java.lang.String getLocalId()
Specified by:
getLocalId in interface IPluginContribution
Returns:
the local id of the contribution. Must not be null. This should correspond to the extension-specific identifier for a given contribution.

getPluginId

public java.lang.String getPluginId()
Specified by:
getPluginId in interface IPluginContribution
Returns:
the id of the originating plugin. Can be null if this contribution did not originate from a plugin.

getClassName

public java.lang.String getClassName()
Returns the factory class name for this descriptor.

Returns:
the factory class name for this descriptor

setViewId

public void setViewId(java.lang.String type,
                      java.lang.String id)

getViewId

public java.lang.String getViewId(java.lang.String type)