/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2009 Pentaho Corporation. All rights reserved.
*/
package org.pentaho.reporting.designer.core.actions.global;
import java.awt.event.ActionEvent;
import java.net.URL;
import javax.help.CSH;
import javax.help.HelpBroker;
import javax.help.HelpSet;
import javax.swing.Action;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.pentaho.reporting.designer.core.ReportDesignerBoot;
import org.pentaho.reporting.designer.core.actions.AbstractDesignerContextAction;
import org.pentaho.reporting.designer.core.actions.ActionMessages;
import org.pentaho.reporting.libraries.base.config.Configuration;
import org.pentaho.reporting.libraries.base.util.StringUtils;
/**
* Todo: Document Me
*
* @author Thomas Morgner
*/
public final class LaunchHelpAction extends AbstractDesignerContextAction
{
private static final Log log = LogFactory.getLog(LaunchHelpAction.class);
public LaunchHelpAction()
{
putValue(Action.NAME, ActionMessages.getString("LaunchHelpAction.Text"));
putValue(Action.SHORT_DESCRIPTION, ActionMessages.getString("LaunchHelpAction.Description"));
putValue(Action.MNEMONIC_KEY, ActionMessages.getOptionalMnemonic("LaunchHelpAction.Mnemonic"));
putValue(Action.ACCELERATOR_KEY, ActionMessages.getOptionalKeyStroke("LaunchHelpAction.Accelerator"));
}
/**
* Invoked when an action occurs.
*/
public void actionPerformed(final ActionEvent e)
{
HelpSet hs = locateHelpSet("org.pentaho.reporting.designer.core.helpsets.UserGuide"); // NON-NLS
HelpBroker hb = null;
if (hs != null)
{
hb = hs.createHelpBroker();
}
if (hb == null)
{
hs = locateHelpSet("org.pentaho.reporting.designer.core.helpsets.EvalGuide"); // NON-NLS
if (hs != null)
{
hb = hs.createHelpBroker();
}
}
if (hb != null)
{
new CSH.DisplayHelpFromSource(hb).actionPerformed(e);
}
}
/**
* find the helpset file and create a HelpSet object
*/
public static HelpSet locateHelpSet(final String configKey)
{
final Configuration config = ReportDesignerBoot.getInstance().getGlobalConfig();
final String helpsetfile = config.getConfigProperty(configKey);
if (StringUtils.isEmpty(helpsetfile))
{
return null;
}
try
{
log.debug("Attempting to find the helpsetfile [" + helpsetfile + "]"); // NON-NLS
final ClassLoader cl = LaunchHelpAction.class.getClassLoader();
final URL hsURL = HelpSet.findHelpSet(cl, helpsetfile);
log.debug("Found the helpsetfile [" + hsURL.toString() + "]"); // NON-NLS
return new HelpSet(null, hsURL);
}
catch (Exception ee)
{
log.warn("Could not find the helpsetfile [" + helpsetfile + "] - " + ee.getMessage()); // NON-NLS
}
return null;
}
}