Class PlugInPanel

  • All Implemented Interfaces:
    Referenceable

    public final class PlugInPanel
    extends InstallPanelAction
    Close extension of InstallPanelAction that represents custom code panels loaded through the plugin method (see Plugin and PlugInDetector) Will be initialized with information from the properties file inside a plugin jar. This will set the main class, descriptive name, and initial values for the advertised properties. This information will then become "part of the object" meaning it will be serialized and can be changed. The advertised properties become variables that are set when the custom action is run.
    • Constructor Detail

      • PlugInPanel

        public PlugInPanel()
    • Method Detail

      • setSourceJarPath

        public void setSourceJarPath​(java.lang.String sourceJarPath)
        sets the Source path to the JAR file that contains the plugin classes.
      • getSourceJarPath

        public java.lang.String getSourceJarPath()
        gets the Source path to the JAR file that contains the plugin classes.
      • setDescriptiveName

        public void setDescriptiveName​(java.lang.String descriptiveName)
        sets the descriptive name of the plugin panel.
      • getDescriptiveName

        public java.lang.String getDescriptiveName()
        gets the descriptive name of the plugin panel.
      • getComment

        public java.lang.String getComment()
        gets the comment text.
      • setComment

        public void setComment​(java.lang.String comment)
        sets the comment text.
      • getVariables

        public java.util.Vector<KeyedData> getVariables()
        gets the list of variables
      • setVariables

        public void setVariables​(java.util.Vector<KeyedData> variablesVector)
        sets the list of variables
      • getHasHelp

        public boolean getHasHelp()
        gets whether there should be a help button.
      • setHasHelp

        public void setHasHelp​(boolean hasHelp)
        sets whether there should be a help button.
      • getHasSpecialImage

        public boolean getHasSpecialImage()
        gets whether this panel should use a specific image.
      • setHasSpecialImage

        public void setHasSpecialImage​(boolean specialImage)
        sets whether this panel should use a specific image.
      • getStepTitle

        public java.lang.String getStepTitle()
        accesces the title of the panel
      • setStepTitle

        public void setStepTitle​(java.lang.String StepTitle)
        accesces the title of the panel
      • getPrompt

        public java.lang.String getPrompt()
        accesses the prompt of the panel
      • setPrompt

        public void setPrompt​(java.lang.String Prompt)
        accesses the prompt of the panel
      • getAdditionalText

        public java.lang.String getAdditionalText()
        accesses additional text for the panel
      • setAdditionalText

        public void setAdditionalText​(java.lang.String AdditionalText)
        accesses additional text for the panel