CActionHelp.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

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.google.security.zynamics.binnavi.Gui.MainWindow.ProjectTree.Actions;

import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;

import javax.swing.AbstractAction;
import javax.swing.JFrame;

import com.google.common.base.Preconditions;
import com.google.security.zynamics.binnavi.Gui.HotKeys;
import com.google.security.zynamics.binnavi.Gui.MainWindow.Implementations.CWindowFunctions;


/**
 * Action class that invokes the help file.
 */
public final class CActionHelp extends AbstractAction {
  /**
   * Used for serialization.
   */
  private static final long serialVersionUID = -5087781925618227065L;

  /**
   * Parent window used for dialogs.
   */
  private final JFrame m_parent;

  /**
   * Creates a new action object.
   * 
   * @param parent Parent window used for dialogs.
   */
  public CActionHelp(final JFrame parent) {
    super("Help Contents");
    m_parent = Preconditions.checkNotNull(parent, "IE02864: parent argument can not be null");
    putValue(MNEMONIC_KEY, KeyEvent.VK_H);
    putValue(ACCELERATOR_KEY, HotKeys.HELP_HK.getKeyStroke());
  }

  @Override
  public void actionPerformed(final ActionEvent event) {
    CWindowFunctions.showHelpFile(m_parent);
  }
}