com.igormaznitsa.mindmap.plugins.api.AbstractImporter 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.StandardMmdAttributes;
import com.igormaznitsa.mindmap.model.Topic;
import com.igormaznitsa.mindmap.model.logger.Logger;
import com.igormaznitsa.mindmap.model.logger.LoggerFactory;
import com.igormaznitsa.mindmap.plugins.PopUpSection;
import com.igormaznitsa.mindmap.swing.ide.IDEBridgeFactory;
import com.igormaznitsa.mindmap.swing.panel.MindMapPanel;
import com.igormaznitsa.mindmap.swing.panel.utils.MindMapUtils;
import java.io.File;
import java.util.Locale;
import javax.swing.Icon;
import javax.swing.JMenuItem;
import javax.swing.SwingUtilities;

/**
 * Abstract auxiliary class automates way to implement an abstract importer.
 *
 * @since 1.2
 */
public abstract class AbstractImporter extends AbstractPopupMenuItem implements HasMnemonic {

  private static final Logger LOGGER = LoggerFactory.getLogger(AbstractImporter.class);

  private static String normalizeExtension(final String extension) {
    String result = extension.toUpperCase(Locale.ENGLISH);
    if (!result.startsWith(".")) {
      result = '.' + result;
    }
    return result;
  }

  @Override
  public JMenuItem makeMenuItem(
      final PluginContext context,
      final Topic activeTopic
  ) {
    final JMenuItem result = UI_COMPO_FACTORY.makeMenuItem(getName(context), getIcon(context));
    result.setToolTipText(getReference(context));

    result.addActionListener(e -> {
      try {
        if (AbstractImporter.this instanceof ExternallyExecutedPlugin) {
          context.processPluginActivation((ExternallyExecutedPlugin) AbstractImporter.this,
              activeTopic);
        } else {
          context.getPanel().removeAllSelection();
          final MindMap map = doImport(context);
          if (map != null) {
            map.putAttribute(StandardMmdAttributes.MMD_ATTRIBUTE_GENERATOR_ID, IDEBridgeFactory.findInstance()
                .getIDEGeneratorId());
            SwingUtilities.invokeLater(() -> context.getPanel().setModel(map, true));
            SwingUtilities.invokeLater(() -> {
              final Topic root = map.getRoot();
              if (root != null) {
                final MindMapPanel panel = context.getPanel();
                panel.doLayout();
                panel.revalidate();
                panel.focusTo(root);
                panel.repaint();
              }
            });
          }
        }
      } catch (Exception ex) {
        LOGGER.error("Error during map import", ex);
        context.getDialogProvider()
            .msgError(IDEBridgeFactory.findInstance().findApplicationComponent(),
                String.format(
                    this.getResourceBundle().getString("MMDGraphEditor.makePopUp.errMsgCantImport"),
                    ex.getMessage()));
      }
    });
    return result;
  }

  @Override
  public PopUpSection getSection() {
    return PopUpSection.IMPORT;
  }

  @Override
  public boolean needsTopicUnderMouse() {
    return false;
  }

  @Override
  public boolean needsSelectedTopics() {
    return false;
  }

  protected File selectFileForExtension(final PluginContext context,
                                        final String dialogTitle,
                                        final File defaultFolder,
                                        final String fileExtension,
                                        final String fileFilterDescription,
                                        final String approveButtonText) {
    return MindMapUtils.selectFileToOpenForFileFilter(
        context.getPanel(),
        context,
        this.getClass().getName(),
        dialogTitle,
        defaultFolder,
        normalizeExtension(fileExtension), fileFilterDescription, approveButtonText);
  }

  @Override
  public String getMnemonic() {
    return null;
  }

  public abstract MindMap doImport(PluginContext context) throws Exception;

  public abstract String getName(PluginContext context);

  public abstract String getReference(PluginContext context);

  public abstract Icon getIcon(PluginContext context);


}