Class PlugInConsole

  • All Implemented Interfaces:
    Referenceable

    public final class PlugInConsole
    extends Action
    Contains the information necessary to invoke a console panel plug-in.
    • Constructor Detail

      • PlugInConsole

        public PlugInConsole()
    • Method Detail

      • setSourceJarPath

        public void setSourceJarPath​(java.lang.String sourceJarPath)
        Defines the source plug-in JAR path.
      • getSourceJarPath

        public java.lang.String getSourceJarPath()
        Returns the source plug-in JAR path.
      • setDescriptiveName

        public void setDescriptiveName​(java.lang.String descriptiveName)
        Defines the name of the plug-in.
      • getDescriptiveName

        public java.lang.String getDescriptiveName()
        Returns the name of the plug-in.
      • getComment

        public java.lang.String getComment()
        Returns the plug-in comment. The comment is a description of the plug-in behavior.
      • setComment

        public void setComment​(java.lang.String comment)
        Defines the plug-in comment. The comment is a description of the plug-in behavior.
      • getVariables

        public java.util.Vector<KeyedData> getVariables()
        The list of variables to pass to the plug-in.
      • getHasHelp

        public boolean getHasHelp()
        Whether or not the plug-in has help.
      • setHasHelp

        public void setHasHelp​(boolean hasHelp)
        Whether or not the plug-in has help.
      • getHasSpecialImage

        public boolean getHasSpecialImage()
        Whether or not the plug-in has special image.
      • setHasSpecialImage

        public void setHasSpecialImage​(boolean specialImage)
        Whether or not the plug-in has special image.
      • getSpecialImagePath

        public java.lang.String getSpecialImagePath()
        Returns the path to the plug-in special image.
      • setSpecialImagePath

        public void setSpecialImagePath​(java.lang.String specialImagePath)
        Defines the path of the plug-in special image.
      • getClassName

        public java.lang.String getClassName()
        The plug-in java class that implements the console panel.
      • setClassName

        public void setClassName​(java.lang.String ClassName)
        The plug-in java class that implements the console panel.
      • getDependencies

        public java.util.Vector<DependencyProperty> getDependencies()
        The list of DependencyProperty that defines the Jar/Zip plug-in dependencies.
      • setSourceFile

        public void setSourceFile​(java.lang.String path)
        The JAR file with the plug-in java class.
      • getSourceFile

        public java.lang.String getSourceFile()
        The JAR file with the plug-in java class.