com.tplan.robot.imagecomparison.text

Class CharsetCaptureGuiInstaller

java.lang.Object

com.tplan.robot.imagecomparison.text.CharsetCaptureGuiInstaller

All Implemented Interfaces:

com.tplan.robot.gui.GuiComponent, com.tplan.robot.gui.MenuStateListener, Plugin

public class CharsetCaptureGuiInstaller
extends Object
implements com.tplan.robot.gui.GuiComponent, Plugin, com.tplan.robot.gui.MenuStateListener

The Character Capture plugin installer.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
CharsetCaptureGuiInstaller()

Method Summary

Modifier and Type	Method and Description
void	checkDependencies(PluginManager manager) Check whether the current product installation contains all dependencies (other plugins) required to install this plugin.
static AbstractAction	getAction()
String	getCode() Get plugin code.
Date	getDate() Get plugin release date.
String	getDescription() Get plugin description to be displayed in the GUI.
String	getDisplayName() Get short plugin name to be displayed in the GUI.
Class	getImplementedInterface() Get Class of the exposed functional interface that this plugin implements.
int[]	getLowestSupportedVersion() Get the lowest required version of T-Plan Robot Enterprise.
String	getMessageAfterInstall() Get text of a message to be displayed after installation of this plugin.
String	getMessageBeforeInstall() Get text of a message to be displayed before installation of this plugin.
String	getSupportContact() Get support contact.
String	getUniqueId() Get unique ID associated with the plugin.
String	getVendorHomePage() Get the vendor home page.
String	getVendorName() Get vendor (provider) name to be displayed in the GUI.
int[]	getVersion() Get plugin version in form of an integer array.
void	menuStateChanged(com.tplan.robot.gui.MainFrame mainFrame) Availability of menu or tool bar button has changed.
boolean	requiresRestart() Indicate whether installation of this plugin requires application restart.
void	setMainFrame(com.tplan.robot.gui.MainFrame frame) Set the main frame.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharsetCaptureGuiInstaller

public CharsetCaptureGuiInstaller()

Method Detail

setMainFrame

public void setMainFrame(com.tplan.robot.gui.MainFrame frame)

Description copied from interface: com.tplan.robot.gui.GuiComponent

Set the main frame. This method will be called just once when the main application GUI is created and initialized and is about to become visible. The component implementing this interface is supposed to add itself to the menu and/or tool bar accessible through the JFrame.getJMenuBar() and MainFrame.getToolBar() methods.

Specified by:

setMainFrame in interface com.tplan.robot.gui.GuiComponent

Parameters:

frame - main application GUI instance.

getAction

public static AbstractAction getAction()

getCode

public String getCode()

Description copied from interface: Plugin

Get plugin code. This string serves as an identifier of the functionality delivered by the plugin. For example, desktop client plugins return protocol name like "RFB" or "RDP" as their code.

Plugin code is used by pluggable instance factories to identify a particular plugin. It may be used to replace internal plugins with third party code. For example if you develop a class which implements this and the com.tplan.robot.remoteclient.RemoteDesktop interfaces and the getCode() method returns "RFB", it will replace the internal implementation of the RFB (VNC) client.

Specified by:

getCode in interface Plugin

Returns:

plugin code (identifier). The name must not be null.

getDisplayName

public String getDisplayName()

Description copied from interface: Plugin

Get short plugin name to be displayed in the GUI.

Specified by:

getDisplayName in interface Plugin

Returns:

short plugin name.

getDescription

public String getDescription()

Description copied from interface: Plugin

Get plugin description to be displayed in the GUI.

Specified by:

getDescription in interface Plugin

Returns:

plugin description. May be null.

getVendorName

public String getVendorName()

Description copied from interface: Plugin

Get vendor (provider) name to be displayed in the GUI.

Specified by:

getVendorName in interface Plugin

Returns:

vendor name. May be null.

getSupportContact

public String getSupportContact()

Description copied from interface: Plugin

Get support contact. If the contact is a valid mail link like "mailto:<mailaddress>" or an HTTP link like "http://<link>", the application may follow it with appropriate program (mail client or web browser).

Specified by:

getSupportContact in interface Plugin

Returns:

support contact. May be null or a text to be displayed by the GUI or a valid URI.

getVersion

public int[] getVersion()

Description copied from interface: Plugin

Get plugin version in form of an integer array. Major version numbers are first. For example, version 1.2.3 should be represented as new int[] { 1, 2, 3 }.

Specified by:

getVersion in interface Plugin

Returns:

version number.

getImplementedInterface

public Class getImplementedInterface()

Description copied from interface: Plugin

Get Class of the exposed functional interface that this plugin implements. For example remote desktop clients return com.tplan.robot.remoteclient.RemoteDesktopClient.class.

Specified by:

getImplementedInterface in interface Plugin

Returns:

class instance of the implemented functional interface.

requiresRestart

public boolean requiresRestart()

Description copied from interface: Plugin

Indicate whether installation of this plugin requires application restart. If it returns true, users are asked to restart after plugin installation via GUI.

Specified by:

requiresRestart in interface Plugin

Returns:

true if installation of the plugin requires application restart, false otherwise.

getVendorHomePage

public String getVendorHomePage()

Description copied from interface: Plugin

Get the vendor home page. If the contact is a valid HTTP link like "http://<link>", the application may follow it with appropriate program (typically web browser).

Specified by:

getVendorHomePage in interface Plugin

Returns:

vendor home page URL.

getDate

public Date getDate()

Description copied from interface: Plugin

Get plugin release date.

Specified by:

getDate in interface Plugin

Returns:

plugin release date.

getUniqueId

public String getUniqueId()

Description copied from interface: Plugin

Get unique ID associated with the plugin. The plugin manager uses the ID together with the version string to identify whether a plugin is already installed and whether a newer version of the same plugin is available.

The unique ID in fact identifies a particular plugin delivered by a particular vendor. Plugin developers are recommended to choose an ID and keep it constant for all versions of one particular plugin. The ID is never displayed in the GUI so it doesn't have to be a readable text. To avoid conflicts with other vendors it is recommended to elaborate vendor or author name and feature description into the ID, for example "custom RFB client implemented by John Doe".

Specified by:

getUniqueId in interface Plugin

Returns:

unique plugin ID.

getLowestSupportedVersion

public int[] getLowestSupportedVersion()

Description copied from interface: Plugin

Get the lowest required version of T-Plan Robot Enterprise. If user attempts to install the plugin on a lower version, an error is reported.

Specified by:

getLowestSupportedVersion in interface Plugin

Returns:

the lowest T-Plan Robot Enterprise version supported by this plugin.

getMessageBeforeInstall

public String getMessageBeforeInstall()

Description copied from interface: Plugin

Get text of a message to be displayed before installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageBeforeInstall in interface Plugin

Returns:

message to be displayed before installation.

getMessageAfterInstall

public String getMessageAfterInstall()

Description copied from interface: Plugin

Get text of a message to be displayed after installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageAfterInstall in interface Plugin

Returns:

message to be displayed after installation.

checkDependencies

public void checkDependencies(PluginManager manager)
                       throws DependencyMissingException

Description copied from interface: Plugin

Check whether the current product installation contains all dependencies (other plugins) required to install this plugin. This method is called before the plugin is installed and it should throw a DependencyMissingException if one or more dependencies are missing.

Specified by:

checkDependencies in interface Plugin

Parameters:

manager - shared instance of the plugin manager.

Throws:

DependencyMissingException - when one or more dependencies requested by this plugin is missing.

menuStateChanged

public void menuStateChanged(com.tplan.robot.gui.MainFrame mainFrame)

Description copied from interface: com.tplan.robot.gui.MenuStateListener

Availability of menu or tool bar button has changed. This method is called whenever the state of the application changes and it is necessary to enable or disable particular menu items and/or tool bar buttons. If the component implementing this interface adds some items to the menu or tool bar, this method should enable/disable them.

Specified by:

menuStateChanged in interface com.tplan.robot.gui.MenuStateListener

Parameters:

mainFrame - the main GUI.