Class SetEquateDialog

    • Constructor Detail

      • SetEquateDialog

        public SetEquateDialog​(PluginTool tool,
                               Program program,
                               Scalar value)
        Constructor
        Parameters:
        tool - the EquatePlugin that launched this dialog(used to validate input)
        program - the program the equate is located in.
        value - the equate value to set.
    • Method Detail

      • buildMainPanel

        protected javax.swing.JPanel buildMainPanel()
      • showSetDialog

        public int showSetDialog()
        Invoke the dialog.
        Returns:
        the exit condition of the dialog. The return value can be one of: CANCELED - the user canceled the action. OK - the user pressed the "Ok" button or pressed the return key in the textfield.
      • showRenameDialog

        public int showRenameDialog()
        Invoke the dialog.
        Returns:
        the exit condition of the dialog. The return value can be one of: CANCELED - the user canceled the action. OK - the user pressed the "Ok" button or pressed the return key in the textfield.
      • getEquateName

        public java.lang.String getEquateName()
      • getEnumDataType

        public Enum getEnumDataType()
        Get's the user selected entry in the dialog and returns the enum data type for that entry
        Returns:
        the enum data type for the selected entry, or null if there is no enum.
      • getSelectionType

        public SetEquateDialog.SelectionType getSelectionType()
        Returns the type of selection the user has chosen.
        Returns:
        the selection type
      • getOverwriteExisting

        public boolean getOverwriteExisting()
        Returns true if the user has chosen to overwrite any existing equate rules.
        Returns:
        true if the user has chosen to overwrite any existing equate rules.
      • setHasSelection

        public void setHasSelection​(ListingActionContext context)
        Set the state of the some buttons on the dialog. ie: if the user has selected a range of addresses we should automatically set the "selection" radio button to the selected state.
        Parameters:
        context - The current context.
      • disableHasSelection

        public void disableHasSelection()
        For using the dialog outside of the EquatePlugin, the "Apply to Current" radio button can be selected and the other buttons disabled.