プラグイン (JA)

/*
 * T-Plan Robot , automated testing tool based on remote desktop technologies.
 * Copyright (C) 2010 T-Plan Ltd (http://www.t-plan.com),
 */
package com.tplan.robot.scripting.commands.impl;

import com.tplan.robot.scripting.ScriptingContext;
import com.tplan.robot.scripting.SyntaxErrorException;
import com.tplan.robot.scripting.commands.AbstractCommandHandler;
import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
 * Example of a simple custom command which prints out a message into
 * the console using <code>System.out.println()</code>.
 */
public class ConsoleMessageCommand extends AbstractCommandHandler {

    /**
 * Get the command name ("msg").
 * @return command name.
     */
    public String[] getCommandNames() {
        return new String[] {"msg"};
    }

    /**
 * Compile command arguments and parameters. This command accepts just one
 * mandatory argument which represents the text to be printed out into the console.
 *
 * @param params list of arguments and parameter names.
 * @param values map of parameters and their values parsed from the [param]=[value] pairs 
 * @param variableContainer optional container for processed parameters.
 * Not used by this command.
 * @param context scripting context.
 * @throws com.tplan.robot.scripting.SyntaxErrorException on invalid command syntax.
     */
    public void validate(List params, Map values, Map variableContainer, ScriptingContext context) throws SyntaxErrorException {
        if (params.size() != 1) {
            throw new SyntaxErrorException("The Msg command must have exactly one argument.");
        }
    }

    /**
 * Execute command.
 *
 * @param params list of arguments and parameter names.
 * @param values map of parameters and their values parsed from the [param]=[value] pairs 
 * @param context scripting context.
 * @throws com.tplan.robot.scripting.SyntaxErrorException on invalid command syntax.
     */
    public int execute(List params, Map values, ScriptingContext context) throws SyntaxErrorException, IOException {
        validate(params, values, values, context);
        System.out.println(params.get(0));
        return 0;
    }

    /**
 * Overriden method to indicate that this command can execute even if the
 * tool is not connected to any desktop.
 * @return always returns true.
     */
    @Override
    public boolean canRunWithoutConnection() {
        return true;
    }
}

/*
 * T-Plan Robot , automated testing tool based on remote desktop technologies.
 * Copyright (C) 2010 T-Plan Ltd (http://www.t-plan.com),
 */
package pluginexamples;

import com.tplan.robot.ApplicationSupport;
import com.tplan.robot.gui.ActionManager;
import com.tplan.robot.gui.GuiComponent;
import com.tplan.robot.gui.MainFrame;
import com.tplan.robot.plugin.DependencyMissingException;
import com.tplan.robot.plugin.Plugin;
import com.tplan.robot.plugin.PluginManager;
import com.tplan.robot.util.Utils;
import java.awt.Component;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Date;
import javax.swing.AbstractButton;
import javax.swing.JButton;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JToolBar;

/**
 * <p>Example of a T-Plan Robot  plugin which adds a new item called "Hello"
 * to the Tools menu and a new button labeled "Hello" to the tool bar. The action
 * will open a dummy message window saying "Hello".</p>
 *
 * <p>To change the message window modify the content of the
 * {@link #actionPerformed(java.awt.event.ActionEvent)}
 * method of this class. Note that you don't have to reinstall the plugin after
 * every code change as long as you keep the plugin code ({@link #getCode()}) and
 * the unique ID ({@link #getUniqueId()}) untouched. You only have to restart
 * the Robot's GUI to pick up the recompiled classes or JAR.</p>
 */
public class GuiPluginExample implements Plugin, GuiComponent, ActionListener {

    JMenuItem mi;
    JButton btn;

    /**
 * Method from the GuiComponent interface. It gets called when the GUI starts
 * up and the main window (MainFrame) gets initialized.
 * @param frame the Robot's GUI window.
     */
    public void setMainFrame(MainFrame frame) {

        // The name is "Tools" but we rather load the string from the resource bundle.
        // This makes the plugin robust against menu name changes and/or eventual
        // localization into another language. Labels of Robot's menu items are located
        // in the Messages_en.properties file and they are always in form of "menu.<action>Text".
        // See the "Data And Text File List"document in Robot's documentation.
        // http://www.t-plan.com/robot/docs/v2.2ee/api/docs/files.html
        String name = ApplicationSupport.getString("menu.ToolsText");

        // Remove the evenual hot key which is typically after comma
        if (name.contains(ActionManager.HOT_KEY_SEPARATOR)) {
            name = name.substring(0, name.indexOf(ActionManager.HOT_KEY_SEPARATOR));
        }

        // Locate the Tools menu
        JMenu m, toolsMenu = null;
        JMenuBar mb = frame.getJMenuBar();

        // Iterate over all menus of the main window and locate the "Tools" one
        for (int i = 0; i < mb.getMenuCount(); i++) {
            m = mb.getMenu(i);
            if (m.getText().equals(name)) {
                toolsMenu = m;
                break;
            }
        }

        // Fallback mechanism - if "Tools" is not found, use the first menu group
        if (toolsMenu == null) {
            toolsMenu = mb.getMenu(0);
        }

        // Create and add the "Hello" menu item.
        mi = new JMenuItem("Hello");
        mi.addActionListener(this);
        toolsMenu.add(mi);

        // Create the tool bar button.
        btn = new JButton("Hello");
        btn.setBorderPainted(false);
        btn.setOpaque(false);
        btn.setMargin(new Insets(1, 1, 1, 1));
        btn.addActionListener(this);

        // This piece of code shows how to insert the new tool bar button
        // to a certain place in the tool bar. This example will put the tool
        // bar button right after the "Preferences" one.
        // The code uses the action command "preferences" to find the button.
        // The action commands are defined together with the default tool bar
        // structure in the MenuAndToolbar.properties file. See the "Data And Text File List"
        // document in Robot's documentation.
        // http://www.t-plan.com/robot/docs/v2.2ee/api/docs/files.html
        JToolBar toolBar = frame.getToolBar();
        final int cnt = toolBar.getComponentCount();
        Component c;
        for (int i = 0; i < cnt; i++) {
            c = toolBar.getComponent(i);
            if (c instanceof AbstractButton && "preferences".equals(((AbstractButton) c).getActionCommand())) {
                toolBar.add(btn, i + 1);
                return;
            }
        }

        // Default location -> end of tool bar
        toolBar.add(btn);
    }

    // ActionListener INTERFACE METHODS ========================================
    /**
 * Implementation of the {@link ActionListener} interface which gets called
 * when either the menu item or the tool bar button are selected. The method
 * just displays a dummy message box saying "Hello"
 * @param e an action event.
     */
    public void actionPerformed(ActionEvent e) {
        JOptionPane.showMessageDialog(MainFrame.getInstance(), "Hello");
    }

    // Plugin INTERFACE METHODS ================================================
    public String getCode() {
        return "hello GUI plugin";
    }

    public String getDisplayName() {
        return "GUI Plugin Example";
    }

    public String getDescription() {
        return "Example of a GUI plugin which installs both into the menu " +
                "and tool bar and displays a simple message of \"Hello\"";
    }

    public String getVendorName() {
        return ApplicationSupport.APPLICATION_NAME;
    }

    public String getSupportContact() {
        return ApplicationSupport.APPLICATION_SUPPORT_CONTACT;
    }

    public int[] getVersion() {
        return Utils.getVersion();
    }

    public Class getImplementedInterface() {
        return GuiComponent.class;
    }

    public boolean requiresRestart() {
        return true;
    }

    public String getVendorHomePage() {
        return ApplicationSupport.APPLICATION_HOME_PAGE;
    }

    public Date getDate() {
        return Utils.getReleaseDate();
    }

    public String getUniqueId() {
        return "TPlan_examples_GUI_plugin";
    }

    public int[] getLowestSupportedVersion() {
        return Utils.getVersion();
    }

    public String getMessageBeforeInstall() {
        return null;
    }

    public String getMessageAfterInstall() {
        return null;
    }

    public void checkDependencies(PluginManager manager) throws DependencyMissingException {
    }
}