openide/source/com/intellij/ide/util/TipPanel.java

package com.intellij.ide.util;

import com.intellij.ide.GeneralSettings;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.components.ApplicationComponent;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.IconLoader;
import com.intellij.openapi.util.JDOMUtil;
import com.intellij.featureStatistics.ProductivityFeaturesProvider;
import com.intellij.featureStatistics.FeatureDescriptor;
import org.jdom.Document;
import org.jdom.Element;

import javax.swing.*;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;
import javax.swing.text.html.HTMLEditorKit;
import java.awt.*;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.HashMap;

public class TipPanel extends JPanel {
  private static final Logger LOG = Logger.getInstance("#com.intellij.ide.util.TipPanel");
  private static final int DEFAULT_WIDTH = 400;
  private static final int DEFAULT_HEIGHT = 200;
  private JCheckBox myCheckBox;
  private JEditorPane browser;
  private ArrayList<String> myTipPaths = new ArrayList<String>();
  private HashMap<String, Class< ? extends ProductivityFeaturesProvider>> myPathsToProviderMap = new HashMap<String, Class<? extends ProductivityFeaturesProvider>>();
  public TipPanel() {
    setLayout(new BorderLayout());
    JLabel jlabel = new JLabel(IconLoader.getIcon("/general/tip.png"));
    jlabel.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 5));
    JLabel jlabel1 = new JLabel("Did you know ... ?");
    Font font = jlabel1.getFont();
    jlabel1.setFont(font.deriveFont(Font.PLAIN, font.getSize() + 4));
    JPanel jpanel = new JPanel();
    jpanel.setLayout(new BorderLayout());
    jpanel.add(jlabel, BorderLayout.WEST);
    jpanel.add(jlabel1, BorderLayout.CENTER);
    jpanel.setBorder(BorderFactory.createEmptyBorder(5, 0, 5, 0));
    add(jpanel, BorderLayout.NORTH);
    browser = new JEditorPane();
    browser.setEditable(false);
    browser.setEditorKit(new HTMLEditorKit());
    browser.setBackground(Color.white);
    browser.addHyperlinkListener(
      new HyperlinkListener() {
        public void hyperlinkUpdate(HyperlinkEvent e) {
          if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
            //TODO: Open url in browser
          }
        }
      }
    );
    JScrollPane scrollPane = new JScrollPane(browser);
    add(scrollPane, BorderLayout.CENTER);
    myCheckBox = new JCheckBox("Show Tips on Startup", true);
    myCheckBox.setBorder(BorderFactory.createEmptyBorder(5, 0, 0, 0));
    final GeneralSettings settings = GeneralSettings.getInstance();
    myCheckBox.setSelected(settings.showTipsOnStartup());
    myCheckBox.addItemListener(new ItemListener() {
      public void itemStateChanged(ItemEvent e) {
        settings.setShowTipsOnStartup(e.getStateChange() == ItemEvent.SELECTED);
      }
    });
    add(myCheckBox, BorderLayout.SOUTH);
    try {
      readTips();
    }
    catch (Exception exception) {

    }
  }

  public Dimension getPreferredSize() {
    return new Dimension(DEFAULT_WIDTH, DEFAULT_HEIGHT);
  }

  public void prevTip() {
    if (myTipPaths.size() == 0) {
      browser.setText("Tips not found.  Make sure you installed IntelliJ IDEA correctly.");
      return;
    }
    GeneralSettings settings = GeneralSettings.getInstance();
    int lastTip = settings.getLastTip();

    String path;
    lastTip--;
    if (lastTip <= 0) {
      path = myTipPaths.get(myTipPaths.size() - 1);
      lastTip = myTipPaths.size();
    }
    else {
      path = myTipPaths.get(lastTip - 1);
    }

    setTip(path, lastTip, browser, settings);
  }

  private void setTip (String path, int lastTip, JEditorPane browser, GeneralSettings settings) {
    TipUIUtil.openTipInBrowser(path, browser, myPathsToProviderMap.get(path));

    settings.setLastTip(lastTip);
  }

  public void nextTip() {
    if (myTipPaths.size() == 0) {
      browser.setText("Tips not found.  Make sure you installed IntelliJ IDEA correctly.");
      return;
    }
    GeneralSettings settings = GeneralSettings.getInstance();
    int lastTip = settings.getLastTip();
    String path;
    lastTip++;
    if (lastTip - 1 >= myTipPaths.size()) {
      path = myTipPaths.get(0);
      lastTip = 1;
    }
    else {
      path = myTipPaths.get(lastTip - 1);
    }

    setTip(path, lastTip, browser, settings);
    /*
    try {
      String appName = ApplicationUtil.getApplicationName();
      String tipsPath = ResourceUtil.getHomePath() + File.separator + "help" + File.separator + appName + File.separator + "tips" + File.separator;
      File file = new File(tipsPath + "tip" + lastTip + ".html");
      if (!file.exists()) {
        if (lastTip == 1) {
          browser.setText("Tips not found.  Make sure you installed IntelliJ IDEA correctly.");
          return;
        }
        lastTip = 1;
        file = new File(tipsPath + "tip" + lastTip + ".html");
        if (!file.exists()) {
          browser.setText("Tips not found.  Make sure you installed IntelliJ IDEA correctly.");
          return;
        }
      }
      browser.setPage(file.toURL());
      settings.setLastTip(lastTip);
    }
    catch (IOException ex) {
      ex.printStackTrace();
    }
    */
  }

  private void readTips() throws Exception {
    String tipsURL = "/tips/" + "tips.xml";
    Document document = JDOMUtil.loadDocument(getClass().getResource(tipsURL).openStream());
    if (document == null) return;
    for (Iterator iterator = document.getRootElement().getChildren("tip").iterator(); iterator.hasNext();) {
      Element element = (Element)iterator.next();
      myTipPaths.add(element.getAttributeValue("file"));
    }
    final ProductivityFeaturesProvider[] providers = ApplicationManager.getApplication().getComponents(ProductivityFeaturesProvider.class);
    for (int i = 0; i < providers.length; i++) {
      ProductivityFeaturesProvider provider = providers[i];
      final FeatureDescriptor[] featureDescriptors = provider.getFeatureDescriptors();
      for (int j = 0; featureDescriptors != null && j < featureDescriptors.length; j++) {
        FeatureDescriptor featureDescriptor = featureDescriptors[j];
        myPathsToProviderMap.put(featureDescriptor.getTipFileName(), featureDescriptor.getProvider());
      }
    }
  }

  public String getComponentName() {
    return "TipPanel";
  }

  public void initComponent() {

  }

  public void disposeComponent() {

  }

}