com.igormaznitsa.mindmap.plugins.api.PluginContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mind-map-swing-panel Show documentation

Swing based panel to show and interact with mind map

The newest version!

/*
 * Copyright (C) 2015-2022 Igor A. Maznitsa
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.igormaznitsa.mindmap.plugins.api;

import com.igormaznitsa.mindmap.model.MindMap;
import com.igormaznitsa.mindmap.model.Topic;
import com.igormaznitsa.mindmap.swing.panel.DialogProvider;
import com.igormaznitsa.mindmap.swing.panel.MindMapPanel;
import com.igormaznitsa.mindmap.swing.panel.MindMapPanelConfig;
import java.io.File;

/**
 * Interface describes context where executed or activated plug-in.
 *
 * @since 1.4.7
 */
public interface PluginContext {
  MindMapPanelConfig getPanelConfig();

  MindMapPanel getPanel();

  default MindMap getModel() {
    return this.getPanel().getModel();
  }

  DialogProvider getDialogProvider();

  File getProjectFolder();

  File getMindMapFile();

  Topic[] getSelectedTopics();

  void openFile(final File file, boolean preferSystemBrowser);

  void processPluginActivation(ExternallyExecutedPlugin plugin, Topic activeTopic);
}