Class DataTypeArchiveMergeManagerPlugin

    • Constructor Detail

      • DataTypeArchiveMergeManagerPlugin

        public DataTypeArchiveMergeManagerPlugin​(PluginTool tool,
                                                 DataTypeArchiveMergeManager mergeManager,
                                                 DataTypeArchive dataTypeArchive)
        Constructor for plugin that handles multi-user merge of programs.
        tool - the tool with the active program to be merged
        mergeManager - the merge manager that will control the merge process
        program - the current program
    • Method Detail

      • createProvider

        public createProvider()
        Description copied from class: MergeManagerPlugin
        Creates the provider that will be displayed in the merge tool. This shows the merge progress to the user and lets the user resolve conflicts. Any class that extends this plugin must provide its own MergeManagerProvider here that will be shown to the user for the merge.
        Specified by:
        createProvider in class MergeManagerPlugin
        the merge provider associated with this plugin.
      • processEvent

        public void processEvent​(PluginEvent event)
        Description copied from class: Plugin
        Method called to process a plugin event. Plugins should override this method if the plugin processes PluginEvents;
        Specified by:
        processEvent in class MergeManagerPlugin
        event - plugin to process
      • dispose

        protected void dispose()
        Description copied from class: Plugin
        Tells a plugin that it is no longer needed. The plugin should release any resources that it has. All actions, components, services will automatically be cleaned up.
        dispose in class MergeManagerPlugin
      • getDescription

        public static java.lang.String getDescription()
      • getDescriptiveName

        public static java.lang.String getDescriptiveName()
      • getCategory

        public static java.lang.String getCategory()
      • closeAllPrograms

        public boolean closeAllPrograms​(boolean ignoreChanges)
      • closeProgram

        public boolean closeProgram()
      • closeProgram

        public boolean closeProgram​(Program program,
                                    boolean ignoreChanges)
      • getAllOpenDataTypeArchives

        public DataTypeArchive[] getAllOpenDataTypeArchives()
      • getCurrentDataTypeArchive

        public DataTypeArchive getCurrentDataTypeArchive()
      • getSearchPriority

        public int getSearchPriority​(Program p)
      • isVisible

        public boolean isVisible​(Program program)
      • openProgram

        public Program openProgram​(DomainFile domainFile,
                                   int version,
                                   int state)
      • openProgram

        public void openProgram​(Program program)
      • openProgram

        public void openProgram​(Program program,
                                boolean current)
      • openProgram

        public void openProgram​(Program program,
                                int state)
      • releaseProgram

        public void releaseProgram​(Program program,
                                   java.lang.Object persistentOwner)
      • setCurrentProgram

        public void setCurrentProgram​(Program p)
      • setPersistentOwner

        public boolean setPersistentOwner​(Program program,
                                          java.lang.Object owner)
      • setSearchPriority

        public void setSearchPriority​(Program p,
                                      int priority)