Class PluginDescriptor

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginDescriptor​(org.eclipse.ui.plugin.AbstractUIPlugin instance, IPluginInitialize callback, java.lang.String pluginTitle, java.lang.String pluginDescription, IPluginDescriptor<?> serverPluginDescriptor, java.lang.String propertiesSchema, java.lang.Class<? extends PropCnr> propertyClass)
      Constructor for data connector plug-in's.
      PluginDescriptor​(org.eclipse.ui.plugin.AbstractUIPlugin instance, IPluginInitialize callback, java.lang.String pluginTitle, java.lang.String pluginDescription, IPluginDescriptor<?> serverPluginDescriptor, java.lang.String propertiesSchema, java.lang.Class<? extends PropCnr> propertyClass, java.lang.String fileExtension, org.eclipse.jface.resource.ImageDescriptor fileImageDescriptor, java.lang.String fileTitle, java.lang.String directory, org.eclipse.jface.resource.ImageDescriptor directoryImageDescriptor, java.lang.String directoryTitle, java.lang.String directoryDescription)
      Constructor for data connector plug-in's.
    • Field Detail

      • pluginTitle

        public final java.lang.String pluginTitle
        The plug-in title.
      • pluginDescription

        public final java.lang.String pluginDescription
        The plug-in description.
      • serverPluginDescriptor

        public final IPluginDescriptor<?> serverPluginDescriptor
        The Server plug-in descriptor.
      • propertiesSchema

        public final java.lang.String propertiesSchema
        The file name for properties (on the class path of the bundle). Set to null if none is required.
      • propertyClass

        public final java.lang.Class<? extends PropCnr> propertyClass
        The class for the property containers for the files or the UI component.
      • fileExtension

        public final java.lang.String fileExtension
        The file name extension for new files, includes the ".".

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • fileImageDescriptor

        public final org.eclipse.jface.resource.ImageDescriptor fileImageDescriptor
        The image for files in the directory.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • fileTitle

        public final java.lang.String fileTitle
        The file title.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • directory

        public final java.lang.String directory
        The directory name for files.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • directoryImageDescriptor

        public final org.eclipse.jface.resource.ImageDescriptor directoryImageDescriptor
        The image for the directory.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • directoryTitle

        public final java.lang.String directoryTitle
        The Title for the directory.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • directoryDescription

        public final java.lang.String directoryDescription
        The directory description.

        This member is only filled in by data connector plug-in's, otherwise it is null.

      • symbolicName

        public final java.lang.String symbolicName
        The symbolic name of the plug-in.
    • Constructor Detail

      • PluginDescriptor

        public PluginDescriptor​(org.eclipse.ui.plugin.AbstractUIPlugin instance,
                                IPluginInitialize callback,
                                java.lang.String pluginTitle,
                                java.lang.String pluginDescription,
                                IPluginDescriptor<?> serverPluginDescriptor,
                                java.lang.String propertiesSchema,
                                java.lang.Class<? extends PropCnr> propertyClass)
        Constructor for data connector plug-in's.
        Parameters:
        instance - The plug-in instance.
        callback - The initialize plug-in callback.
        pluginTitle - The plug-in title.
        pluginDescription - The plug-in description.
        serverPluginDescriptor - The Server plug-in descriptor.
        propertiesSchema - The file name for properties (on the class path of the bundle).
        propertyClass - The class for the property containers for the files.
      • PluginDescriptor

        public PluginDescriptor​(org.eclipse.ui.plugin.AbstractUIPlugin instance,
                                IPluginInitialize callback,
                                java.lang.String pluginTitle,
                                java.lang.String pluginDescription,
                                IPluginDescriptor<?> serverPluginDescriptor,
                                java.lang.String propertiesSchema,
                                java.lang.Class<? extends PropCnr> propertyClass,
                                java.lang.String fileExtension,
                                org.eclipse.jface.resource.ImageDescriptor fileImageDescriptor,
                                java.lang.String fileTitle,
                                java.lang.String directory,
                                org.eclipse.jface.resource.ImageDescriptor directoryImageDescriptor,
                                java.lang.String directoryTitle,
                                java.lang.String directoryDescription)
        Constructor for data connector plug-in's.
        Parameters:
        instance - The plug-in instance.
        callback - The initialize plug-in callback.
        pluginTitle - The plug-in title.
        pluginDescription - The plug-in description.
        serverPluginDescriptor - The Server plug-in descriptor.
        propertiesSchema - The file name for properties (on the class path of the bundle).
        propertyClass - The class for the property containers for the files.
        fileExtension - The file name extension for new files, includes the ".".
        fileImageDescriptor - The image for files in the directory.
        fileTitle - The file title.
        directory - The directory name for files.
        directoryImageDescriptor - The image for the directory.
        directoryTitle - The Title for the directory.
        directoryDescription - The directory description.
    • Method Detail

      • getInstance

        public org.eclipse.ui.plugin.AbstractUIPlugin getInstance()
        Gets the plug-in instance.
      • isLoaded

        public boolean isLoaded()
        Checks if this plug-in's data has been loaded with an error or not.
      • initializeModule

        public final void initializeModule​(ModuleModel model)
                                    throws org.eclipse.core.runtime.CoreException
        Initializes the plug-in after the Module project has been loaded.
        Parameters:
        model - The Module project.
        Throws:
        org.eclipse.core.runtime.CoreException - For initialization failures.
      • onInitialLayout

        public final void onInitialLayout​(org.eclipse.ui.IPageLayout layout,
                                          org.eclipse.ui.IFolderLayout folder,
                                          org.eclipse.ui.IFolderLayout outlineFolder,
                                          org.eclipse.ui.IFolderLayout outputFolder)
        Called when the Module perspective has completed initializing itself with iizi-related items. Once the plug-ins complete their processing, additional Java and Java-EE items are added.
        Specified by:
        onInitialLayout in interface IModulePerspective
        Parameters:
        layout - The page layout.
        folder - The folder area, left side.
        outlineFolder - The outline folder on the right side, perhaps null (be careful!).
        outputFolder - The output folder area, bottom placement.
      • onProjectChanged

        public final void onProjectChanged​(org.eclipse.core.resources.IResourceDelta delta)
        Called during workspace change to inform the plug-in of a project change.
        Specified by:
        onProjectChanged in interface IProjectListener
        Parameters:
        delta - The resource delta.
      • registerActionActorProvider

        public void registerActionActorProvider​(IEditorActionActorProvider provider)
        Registers a new Action Actor provider.
      • getActionActorProviders

        public java.util.List<IEditorActionActorProvider> getActionActorProviders()
        Gets the list of Action Actors providers for the plug-in.
        Returns:
        The list of Action Actors providers.
      • getServerApplicationSetupInstances

        public IServerApplicationSetup[] getServerApplicationSetupInstances​(PropCnr moduleRoot)
        Queries for instances of the IServerApplicationSetup required. This call makes it possible to redirect the query to other properties. Most plug-ins would have a single instance.
        Specified by:
        getServerApplicationSetupInstances in interface IServerApplicationSetupProvider
        Parameters:
        moduleRoot - The root of the Module application.
        Returns:
        The IServerApplicationSetup instances that is participating in the setup.
      • getDesignerClasspathEntries

        public java.util.List<java.net.URL> getDesignerClasspathEntries()
        Gets the list of classpath URL's used for the designer.
        Returns:
        The classpath entries required for the plugin when in designer mode, as an unmodifiable list.
      • equals

        public boolean equals​(java.lang.Object o)
        Checks for two plug-in descriptors for equality.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - The other plug-in descriptor.
        Returns:
        true if the plug-in descriptor ID's match.
      • hashCode

        public int hashCode()
        The hash code.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code of the symbolic name of the plugin.