diff options
Diffstat (limited to 'rse/doc/org.eclipse.rse.doc.isv/guide/api')
41 files changed, 0 insertions, 3257 deletions
diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/actions/uiActionsAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/actions/uiActionsAPI.html deleted file mode 100755 index 7bb76c000..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/actions/uiActionsAPI.html +++ /dev/null @@ -1,89 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Actions API</title> -<STYLE type="text/css"> -<!-- -TH { - background-color: #e5e5e5 -} ---> -</STYLE> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Actions API</h1> -<p>In Eclipse, we typically launch our dialogs and wizards and menu items from an action, which is -a class that implements the JFace <samp>IAction</samp> interface. The Remote System Explorer offers classes to -help simplify the creation of action classes, especially when used together with the RSE classes for -<a href="../dialogs/uiDialogsAPI.html">dialogs</a> and <a href="../wizards/uiWizardsAPI.html">wizards</a>. -</p> -<p>There are two ways the Remote System Explorer API set can help you when it comes to actions: -<ol> -<li>A set of base action classes from which to base your own action classes. -<li>A set of re-usable actions for specific requirements. -</ol> -</p> - -<h2>RSE-Supplied Base Classes for Actions</h2> -<p>Here are the primary base classes the RSE supplies for actions, all of which are found in the -package <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/package-summary.html">org.eclipse.rse.ui.actions</A></samp> -in the plugin <samp>org.eclipse.rse.ui</samp>:</p> -<TABLE border="1"> - <TBODY> - <TR> - <TH>Class</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html">SystemBaseAction</A></samp></TD> - <TD>This is the base action class for the other classes, and is only used directly for actions that do not - result in a dialog or wizard being presented to the user. It extends the JFace <samp>Action</samp> class, - adding to it support for properties such as the current shell and viewer and selection, as well as - overridable methods for easily enabling/disabling the action based on the selection, and a method for - setting the context help for the action. There are many other useful methods, such - as <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html#allowOnMultipleSelection(boolean)">allowOnMultipleSelection(boolean)</A></samp> - and <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html#setContextMenuGroup(java.lang.String)">setContextMenuGroup(String)</A></samp>, to - simplify when the action is enabled and where it appears in a popup menu. - </TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseSubMenuAction.html">SystemBaseSubMenuAction</A></samp></TD> - <TD>This base action class extends <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html">SystemBaseAction</A></samp>, and is used as the parent class when - for popup menu actions that are to cascade. A cascading menu is itself another menu, really, containing actions just like the primary - menu does. So, to create a cascading menu action, you simply subclass this class and override the method - <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseSubMenuAction.html#populateSubMenu(org.eclipse.jface.action.IMenuManager)">populateSubMenu</A></samp>, where - you add all the actions to show in this cascading menu. And yes, one or more of those can themselves be cascading. The RSE views will - automatically call the method <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseSubMenuAction.html#getSubMenu()">getSubMenu</A></samp> when populating the initial popup menu, but your own views will need to do this.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseDialogAction.html">SystemBaseDialogAction</A></samp></TD> - <TD>This base action class extends <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html">SystemBaseAction</A></samp>, and is used when the action presents the - user with a dialog, preferably a dialog that extends the RSE - <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html">SystemPromptDialog</A></samp> class. To use this class, subclass it and override the methods </TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseWizardAction.html">SystemBaseWizardAction</A></samp></TD> - <TD>This base action class extends <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseAction.html">SystemBaseAction</A></samp>, and is used when the action presents the - user with a wizard, preferably a wizard that extends the RSE <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html">AbstractSystemWizard</A></samp> class.</TD> - </TR> - - </TBODY> -</TABLE> - -<h2>Actions Pre-Supplied by RSE</h2> -<p>You may find some of the actions supplied by the RSE to be immediately re-usable in your own code, saving some -development and test effort. -All these actions can be found in package -<samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/package-summary.html">org.eclipse.rse.ui.actions</A></samp>. -Further, you can find many useful actions related to the selection of remote files or folders, in package -<samp><A href="../../../reference/api/org/eclipse/rse/files/ui/actions/package-summary.html">org.eclipse.rse.files.ui.actions</A></samp>. -</p> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/browseFolderDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/browseFolderDialog.gif Binary files differdeleted file mode 100755 index 07af5fc43..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/browseFolderDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/deleteDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/deleteDialog.gif Binary files differdeleted file mode 100755 index 2119a5357..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/deleteDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/dialogSample.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/dialogSample.html deleted file mode 100755 index 05d6a717f..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/dialogSample.html +++ /dev/null @@ -1,265 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" CHARSET="UTF-8" TYPE="text/css"> -<title>RSE Validator Sample One</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Dialog Sample</h1> -<p>This is an example of a sample<A href="sampleDlg.gif"> dialog</A> written on top of the RSE base dialog class, and with -typical full error checking. -<pre> - -package org.eclipse.rse.samples.ui.frameworks.dialogs; - -import org.eclipse.swt.widgets.*; -import org.eclipse.swt.events.*; - -import org.eclipse.rse.samples.*; - -import org.eclipse.rse.ui.dialogs.SystemPromptDialog; -import org.eclipse.rse.ui.*; -import org.eclipse.rse.ui.widgets.*; -import org.eclipse.rse.ui.messages.*; -import org.eclipse.rse.ui.validators.*; - -/** - * <I>A simple example of using the SystemPromptDialog class as the basis for a new dialog</I>. - */ -public class <B>SampleDialog</B> extends SystemPromptDialog -{ - // <I>gui widgets</I> - private SystemHistoryCombo namePrompt; - private Text yearPrompt, monthPrompt, dayPrompt; - // <I>input</I> - private SampleCustomer inpCust; - // <I>validators</I> - private ISystemValidator nameValidator, yearValidator, monthValidator, dayValidator; - // <I>message</I> - private SystemMessage errorMessage; - - /** - * <I>Constructor for SampleDialog</I>. - */ - public <B>SampleDialog</B>(Shell shell) - { - super(shell, SamplesPlugin.getString("org.eclipse.rse.samples.ui.dialogs.dialog1.title")); - setHelp(SamplesPlugin.HELPPREFIX + "dlg11000"); - nameValidator = new <A href="../validators/validatorSample1.html">SampleNameValidator</A>(); - yearValidator = new <A href="../validators/validatorSample2.html">SampleBirthYearValidator</A>(); - monthValidator = new <A href="../validators/validatorSample3.html">SampleBirthMonthValidator</A>(); - dayValidator = new <A href="../validators/validatorSample4.html">SampleBirthDayValidator</A>(); - } - - /** - * <I>Required parent override.</I> - * <I>This is where we populate the client area</I> - */ - protected Control <B>createInner</B>(Composite parent) - { - int nbrColumns = 2; - Composite parentComposite = SystemWidgetHelpers.createComposite(parent, nbrColumns); - - // <I>add gui widgets</I>... - SystemWidgetHelpers.createLabel(parentComposite, SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.name."); - boolean readonly = false; - namePrompt = SystemWidgetHelpers.createHistoryCombo(parentComposite, null, "name.history.key", readonly, - SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.name.tooltip"); - - addSeparatorLine(parentComposite, nbrColumns); - boolean wantBorder = false; - SystemWidgetHelpers.createLabel(parentComposite, SamplesPlugin.getResourceBundle(), - "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.verbiage.", nbrColumns, wantBorder); - - yearPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null, - SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.year."); - monthPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null, - SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.month."); - dayPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null, - SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.day."); - - // <I>if given an existing object, prefill it</I>... - inpCust = (SampleCustomer)getInputObject(); - if (inpCust != null) - { - namePrompt.setText(inpCust.getName()); - yearPrompt.setText(inpCust.getYear()); - monthPrompt.setText(inpCust.getMonth()); - dayPrompt.setText(inpCust.getDay()); - } - - - // <I>add modify listeners</I>... - namePrompt.addModifyListener( new ModifyListener() - { - public void modifyText(ModifyEvent event) - { - if (validateName()) - validate(namePrompt.getCombo()); - } - } ); - yearPrompt.addModifyListener( new ModifyListener() - { - public void modifyText(ModifyEvent event) - { - if (validateYear()) - validate(yearPrompt); - } - } ); - monthPrompt.addModifyListener( new ModifyListener() - { - public void modifyText(ModifyEvent event) - { - if (validateMonth()) - validate(monthPrompt); - } - } ); - dayPrompt.addModifyListener( new ModifyListener() - { - public void modifyText(ModifyEvent event) - { - if (validateDay()) - validate(monthPrompt); - } - } ); - - // <I>initialize enabled state</I>... - setPageComplete(isPageComplete()); - - return parentComposite; - } - - /** - * <I>Required parent override</I>. - * <I>This is where we return the first input control, to give it focus when the dialog appears</I>. - */ - protected Control <B>getInitialFocusControl</B>() - { - return namePrompt.getCombo(); - } - - /** - * <I>Typical parent override</I>. - * <I>This is where we get control when the user presses OK</I>. - */ - protected boolean <B>processOK</B>() - { - errorMessage = null; - Control controlInError = validate(null); - if (controlInError != null) - controlInError.setFocus(); - else - { - SampleCustomer newCust = inpCust; - if (newCust == null) - newCust = new SampleCustomer(); - newCust.setName(namePrompt.getText().trim()); - newCust.setYear(yearPrompt.getText().trim()); - newCust.setMonth(monthPrompt.getText().trim()); - newCust.setDay(dayPrompt.getText().trim()); - setOutputObject(newCust); - - SystemMessage completionMsg = null; - if (inpCust == null) - completionMsg = SamplesPlugin.getPluginMessage("SPPD1010"); - else - completionMsg = SamplesPlugin.getPluginMessage("SPPD1011"); - completionMsg.makeSubstitution(newCust.getName()); - SystemMessageDialog msgDlg = new SystemMessageDialog(getShell(), completionMsg); - msgDlg.open(); - } - return isPageComplete(); - } - - // --------------------- - // <I>Validation methods</I>... - // --------------------- - /** - * <I>Do full validation of all entry fields, optionally skipping a given one</I>. - * <I>@return first control that is found to contain errors. Can be used to set focus</I>. - */ - protected Control <B>validate</B>(Control controlToSkip) - { - Control controlInError = null; - - if ((controlToSkip != namePrompt.getCombo()) && !validateName()) - controlInError = namePrompt.getCombo(); - if ((controlInError==null) && (controlToSkip != yearPrompt) && !validateYear()) - controlInError = yearPrompt; - if ((controlInError==null) && (controlToSkip != monthPrompt) && !validateMonth()) - controlInError = monthPrompt; - if ((controlInError==null) && (controlToSkip != dayPrompt) && !validateDay()) - controlInError = dayPrompt; - - return controlInError; - } - /** - * <I>Validate the customer name prompt. We only ensure it is not-empty.</I> - */ - protected boolean <B>validateName</B>() - { - String input = namePrompt.getText().trim(); - setErrorMessageAndPageCompletionStatus(nameValidator.validate(input)); - return (errorMessage==null); - } - /** - * <I>Validate the customer birth year prompt</I>. - */ - protected boolean <B>validateYear</B>() - { - String input = yearPrompt.getText().trim(); - setErrorMessageAndPageCompletionStatus(yearValidator.validate(input)); - return (errorMessage==null); - } - /** - * <I>Validate the customer birth month prompt</I>. - */ - protected boolean <B>validateMonth</B>() - { - String input = monthPrompt.getText().trim(); - setErrorMessageAndPageCompletionStatus(monthValidator.validate(input)); - return (errorMessage==null); - } - /** - * <I>Validate the customer birth day prompt</I>. - */ - protected boolean <B>validateDay</B>() - { - String input = dayPrompt.getText().trim(); - setErrorMessageAndPageCompletionStatus(dayValidator.validate(input)); - return (errorMessage==null); - } - - /** - * <I>A convenience method that issues or clears the error message on the message line</I>, - * <I>and sets the page completion status</I> - */ - protected void <B>setErrorMessageAndPageCompletionStatus</B>(SystemMessage errorMessage) - { - this.errorMessage = errorMessage; - if (errorMessage == null) - clearErrorMessage(); - else - setErrorMessage(errorMessage); - setPageComplete(isPageComplete()); - } - /** - * <I>Return true if the OK button can be enabled</I>. - */ - protected boolean <B>isPageComplete</B>() - { - return ((errorMessage == null) && - (namePrompt.getText().trim().length()>0) && - (yearPrompt.getText().trim().length()>0) && - (monthPrompt.getText().trim().length()>0) && - (dayPrompt.getText().trim().length()>0)); - } -}</pre> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameManyDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameManyDialog.gif Binary files differdeleted file mode 100755 index cfeb0c6cd..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameManyDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameOneDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameOneDialog.gif Binary files differdeleted file mode 100755 index cc6256c23..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/renameOneDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/sampleDlg.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/sampleDlg.gif Binary files differdeleted file mode 100755 index 0d55573b3..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/sampleDlg.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/selectTypesDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/selectTypesDialog.gif Binary files differdeleted file mode 100755 index be5361af4..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/selectTypesDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/simpleSelectDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/simpleSelectDialog.gif Binary files differdeleted file mode 100755 index b9bfca608..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/simpleSelectDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/uiDialogsAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/uiDialogsAPI.html deleted file mode 100755 index 2a4725238..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/dialogs/uiDialogsAPI.html +++ /dev/null @@ -1,180 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Dialogs API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Dialogs API</h1> -<p>There are two ways the Remote System Explorer API set can help you when it comes to dialogs: -<ol> -<li>A base dialog class from which to base your own dialog classes. -<li>A set of re-usable dialogs for specific requirements. -</ol> -</p> - -<h2>RSE-Supplied Base Class for Dialogs</h2> -<p>Dialogs are secondary windows that prompt the user for information or display information to the user. They are typically -<i>modal</i>, meaning the rest of the application (in this case eclipse) is disabled while the dialog is showing. -Eclipse supplies a raw dialog class in SWT, as well as more robust dialog class in JFace. The RSE supplies its own -class, -<samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html">SystemPromptDialog</A></samp> -in package -<samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/package-summary.html">org.eclipse.rse.ui.dialogs</A></samp> -, that extends -the JFace dialog class and adds to it the following capabilities inherited by all classes which extend it: -</p> -<ul> -<li>Support for an optional visual message line at the bottom, on which messages can be displayed to the user. These can be either -<samp>SystemMessage</samp> objects, or simple string messages. <samp><A - href="../messages/uiMessageAPI.html#SystemMessage">SystemMessage</A></samp> objects are preferred, as using these enables a button -beside the message line which users can press to see the details for the message. This is supported via the <samp><A - href="../messages/uiMessageAPI.html#ISystemMessageLine">ISystemMessageLine</A></samp> -interface, and so offers a consistent programming interface with the RSE property page and wizard page classes. -<li>Support of automatic assignment of mnemonics for input-capable widgets such as buttons. This saves tremendous development -effort if your user interface is translated as the assignment of unique mnemonics can be difficult after translation. -<li>Built-in support for a number of typical push buttons at the bottom of the dialog: OK, Cancel, Browse, Test, Add and -Details. You control via setters which buttons to show, and you can affect their label and tooltip text, although the -default labels and tips are already translated for you. To program what happens when pressed, override the appropriate -<samp>processXXX()</samp> method, such as <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#processOK()">processOK()</A></samp>. By default, you get OK and Cancel buttons. -<li>Support for an optional built-in progress monitor at the bottom of the dialog, just like what eclipse offers for wizards. -<li>Support of a simple <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#wasCancelled()">wasCancelled()</A></samp> method to easily test if the dialog was cancelled or not. -<li>Support for methods to set an input object, and retrieving an output object, making it easy to pass in data and -get back data. Your calling code sets the input object, your subclass code sets the output object (typically in -its <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#processOK()">processOK()</A></samp> method) and your calling code gets the output object, -if <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#wasCancelled()">wasCancelled()</A></samp> returns false. -<li>Support of a <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#setPageComplete(boolean)">setPageComplete(boolean)</A></samp> method, consistent with wizard pages, to enable/disable the OK button. -This is typically called by your keystroke and button validators. That is, if an error is detected as input is entered, a message -is issued to the message line and the OK button is disabled. -<li>Support of a simple <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#setHelp(java.lang.String)">setHelp(String helpId)</A></samp> method to set the dialog's popup help. -<li>A simple way to toggle the cursor between busy and normal, using -<samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#setBusyCursor(boolean)">setBusyCursor(boolean)</A></samp> -<li>Helper methods for adding <A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#addFillerLine(org.eclipse.swt.widgets.Composite, int)">filler lines</A> -and <A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#addSeparatorLine(org.eclipse.swt.widgets.Composite, int)">separator lines</A>. -</ul> -<p>To create your own dialog:</p> -<ol> -<li>Subclass <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html">SystemPromptDialog</A></samp>, picking the appropriate constructor, the simplest -of which simply requires the shell of the parent window and the title string for this dialog. -<li>If buttons beyond OK and Cancel are desired, in your own constructor call the appropriate <samp>setShowXXXButton(true)</samp> methods to enable -these buttons, and override the appropriate <samp>processXXX()</samp> methods to process these buttons when pressed by the user. -<li>If a progress monitor is desired, in your own constructor call <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#setNeedsProgressMonitor(boolean)">setNeedsProgressMonitor(true)</A></samp>. Later, to run -a long-running operation that displays the progress monitor, use <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#getProgressMonitor()">getProgressMonitor()</A></samp>. -<li>Override the <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#createInner(org.eclipse.swt.widgets.Composite)">createInner(Composite)</A></samp> method to populate the client area of the dialog with SWT widgets. Typically -you create your composite with a GridLayout layout, populate it, and return it. To ease this programming burden, use the many -static helper methods in <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemWidgetHelpers.html">SystemWidgetHelpers</A></samp>. -<li>Override the <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#getInitialFocusControl()">getInitialFocusControl()</A></samp> method to supply the control to get initial focus when the dialog is displayed. -<li>Override the <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#processOK()">processOK()</A></samp> method to supply the processing for when OK is pressed. You typically first validate -the user input, and then return true if there are no errors found. -<li>To allow the caller to get user-entered information out of the dialog, either supply getter methods, -or call <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#setOutputObject(java.lang.Object)">setOuputObject(Object)</A></samp> -in your processOK logic so that your caller can code <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html#getOutputObject()">getOutputObject()</A></samp>. -</ol> -<P>One of the more difficult efforts in building a dialog with multiple entry fields, is the code to do the validation of those entry fields. A common strategy is to add modify listeners to the entry fields, and for each one validate the data as it typed. If the validation fails, a message is issued. If the validation succeeds, then the other fields on the dialog are validated. At the end of the validation, the OK button is enabled or disabled depending on the error message status, and whether the required information has been supplied. The RSE can help with this effort, somewhat, through the use of re-usable <A - href="../validators/uiValidatorsAPI.html">validators</A> for various types of input.<BR> -<BR> -Follow this <A href="dialogSample.html">link</A> for an example of a fully-formed dialog class written on top of this RSE base class, complete with -error checking.</P> - -<p>Typically, after creating your dialog, you will create an action to invoke it. The RSE can help with this too, via the -supplied <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseDialogAction.html">SystemBaseDialogAction</A></samp> base class. - -<h2>Dialogs Pre-Supplied by RSE</h2> -<p>You may find some of the dialogs supplied by the RSE to be immediately re-usable in your own code, saving some -development and test effort. All these dialogs are in package <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/package-summary.html">org.eclipse.rse.ui.dialogs</A></samp>: -</p> - - -<TABLE border="1"> - <TBODY> - <TR> - <TH>Class</TH> - <TH>Description</TH> - <TH>Sample</TH> - <TH>Action</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemRenameDialog.html">SystemRenameDialog</A></samp></TD> - <TD>Rename multiple items. Provides a table listing the old names and new names, which are editable. If your input objects - do not adapt to <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemViewElementAdapter.html">ISystemViewElementAdapter</A></samp> - or <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemRemoteElementAdapter.html">ISystemRemoteElementAdapter</A></samp>, - you should call <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemRenameDialog.html#setNameValidator(org.eclipse.rse.ui.validators.ISystemValidator)">setNameValidator</A></samp> to specify a validator that ensures the new name is correct, and your - input objects should also either be IResource objects or implement - <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/ISystemTypedObject.html">ISystemTypedObject</A></samp>. - </TD> - <TD align="center"><A href="renameManyDialog.gif">Sample image</A></TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemCommonRenameAction.html">SystemCommonRenameAction</A></samp></TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemRenameSingleDialog.html">SystemRenameSingleDialog</A></samp></TD> - <TD>Rename a single item. Provides a simple entry field for the new name. If your input object - does not adapt to <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemViewElementAdapter.html">ISystemViewElementAdapter</A></samp> or - <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemRemoteElementAdapter.html">ISystemRemoteElementAdapter</A></samp>, - you should call <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemRenameSingleDialog.html#setNameValidator(org.eclipse.rse.ui.validators.ISystemValidator)">setNameValidator</A></samp> to specify a validator that ensures the new name is correct, and your - input object should also either be an IResource object or implement <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/ISystemTypedObject.html">ISystemTypedObject</A></samp>. - </TD> - <TD align="center"><A href="renameOneDialog.gif">Sample image</A></TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemCommonRenameAction.html">SystemCommonRenameAction</A></samp></TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemDeleteDialog.html">SystemDeleteDialog</A></samp></TD> - <TD>Confirm delete of one or more items. Provides a table listing the names of input objects. If your input objects - do not adapt to <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemViewElementAdapter.html">ISystemViewElementAdapter</A></samp> or - <samp><A href="../../../reference/api/org/eclipse/rse/ui/view/ISystemRemoteElementAdapter.html">ISystemRemoteElementAdapter</A></samp>, - your input objects should either be IResource objects or implement <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/ISystemTypedObject.html">ISystemTypedObject</A></samp>. - </TD> - <TD align="center"><A href="deleteDialog.gif">Sample image</A></TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemCommonDeleteAction.html">SystemCommonDeleteAction</A></samp></TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemSelectFileTypesDialog.html">SystemSelectFileTypesDialog</A></samp></TD> - <TD>Presents a dialog listing all the file types defined in the eclipse File Associations preferences page, and - allows the user to select one or more of these types, or enter additional types not defined in eclipse.</TD> - <TD align="center"><A href="selectTypesDialog.gif">Sample image</A></TD> - <TD><samp></samp></TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemSimpleSelectDialog.html">SystemSimpleSelectDialog</A></samp></TD> - <TD>Eclipse has a CheckboxTreeViewer that is designed to allow the user to select multiple items from a hierarchical model. - This is a nice viewer, but very difficult to program to, as you have to handle reflecting the state of the selected children - for each parent node yourself. This dialog makes that trivial. The trick is to create wrappers of your model objects using - <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemSimpleContentElement.html">SystemSimpleContentElement</A></samp>, maintaining the parent/child hierarchy, and pass the root element to the dialog. The rest is - done for you, and the result is the selected state set for those elements selected by the user. Note this can also be used - as a simple flat list checkbox selection dialog, just by passing a non-visible root with a flat list of children.</TD> - <TD align="center"><A href="simpleSelectDialog.gif">Sample image</A></TD> - <TD>None</TD> - </TR> - - </TBODY> -</TABLE> - <P><BR>While the dialogs can be instantiated directly, it is perhaps best to use them by instantiating their action class, and calling the run method on it. -The action classes are all in <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/package-summary.html">org.eclipse.rse.ui.actions</A></samp> package. -</P> - <p>In addition to these universal dialogs, there are dialogs specific to the predefined Files subsystem. These enable selection of remote files or folders. They can be found in the <a href="../../../reference/api/org/eclipse/rse/files/ui/dialogs/package-summary.html"><samp>org.eclipse.rse.files.ui.dialogs</samp></a> package.</p> - <TABLE border="1"> - <TBODY> - <TR> - <TH>Class</TH> - <TH>Description</TH> - <TH>Sample</TH> - <TH>Action</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/files/ui/dialogs/SystemSelectRemoteFileOrFolderDialog.html">SystemSelectRemoteFileOrFolderDialog</A></samp></TD> - <TD>Allows users to select a remote file, or folder (configurable) using a dialog similar to what is used in Eclipse for local file or - folder selection. Can be configured to allow user to select from any existing connection, or to be scoped to a particular connection, - or even a particular folder in a particular connection. - </TD> - <TD align="center"><A href="browseFolderDialog.gif">Sample image</A></TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/files/ui/actions/SystemSelectRemoteFileAction.html">SystemSelectRemoteFileAction</A></samp> or - <samp><A href="../../../reference/api/org/eclipse/rse/files/ui/actions/SystemSelectRemoteFolderAction.html">SystemSelectRemoteFolderAction</A></samp></TD> - </TR> - </TBODY> -</TABLE> - <P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/logPreferences.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/logPreferences.gif Binary files differdeleted file mode 100755 index 9d465a218..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/logPreferences.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/uiLoggerAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/uiLoggerAPI.html deleted file mode 100755 index 346a58651..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/logger/uiLoggerAPI.html +++ /dev/null @@ -1,23 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Logger API</title> -</head> - -<body> -<h1>RSE Logger API</h1> -<p>To log your messages to the workbench log file in <samp>.metadata\.log</samp>, -either base your plugin class on the <samp>org.eclipse.rse.ui.SystemBasePlugin</samp> class and use -the inherited logging methods, or instead of instantiating your own <samp>Logging</samp> object, re-use the -RSE-supplied logging object by calling <samp>getDefault().getLog()</samp> in the <samp>org.eclipse.rse.ui.RSEUIPlugin</samp> -class. -</p> - - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/massagers/uiMassagersAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/massagers/uiMassagersAPI.html deleted file mode 100755 index 38216f1c0..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/massagers/uiMassagersAPI.html +++ /dev/null @@ -1,54 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Massagers API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Massagers API</h1> -<p>In addition to <a href="../validators/uiValidatorsAPI.html">validating</a> what a user types, we often need -to transform it prior to saving. For example, we may need to fold it to uppercase or lowercase. The RSE abstracts -and encapsulates this concept into massagers which can be re-used. A few are pre-supplied by RSE. -</p> - -<h2>RSE Massager Interfaces</h2> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/ISystemMassager.html">ISystemMassager</A></samp> interface is in package -<samp><A href="../../../reference/api/org/eclipse/rse/ui/package-summary.html">org.eclipse.rse.ui</A></samp>. -It is a very simple interface with one method: -<samp><A href="../../../reference/api/org/eclipse/rse/ui/ISystemMassager.html#massage(java.lang.String)">public String massage(String text)</A></samp>. -Given input text, return the massaged text. While simple, by encapsulating this operation into an interface, -you will be able to write re-usable dialogs that take a massager as input. Further, tricky massaging can be -built as a re-usable object. -</p> - -<h2>RSE-Supplied Massagers</h2> -<p>The RSE supplies the following massagers in package <samp><A href="../../../reference/api/org/eclipse/rse/ui/package-summary.html">org.eclipse.rse.ui</A></samp>: -</p> -<BR> -<TABLE border="1"> - <TBODY> - <TR> - <TH>Massager Class</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/MassagerFoldCase.html">MassagerFoldCase</A></samp></TD> - <TD>Simply folds the text to uppercase or lowercase</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/MassagerFoldCaseOutsideQuotes.html">MassagerFoldCaseOutsideQuotes</A></samp></TD> - <TD>Folds the text to uppercase or lowercase, except parts of the text that are surrounded by quotes or any given delimiter characters</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/MassagerFoldCaseUnlessQuoted.html">MassagerFoldCaseUnlessQuoted</A></samp></TD> - <TD>Folds the text to uppercase or lowercase, unless the whole text is surrounded by quotes or any given delimiter character</TD> - </TR> - </TBODY> -</TABLE> -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgDialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgDialog.gif Binary files differdeleted file mode 100755 index 7098dd018..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgDialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_dialog.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_dialog.gif Binary files differdeleted file mode 100755 index 846ba78ae..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_dialog.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_properties.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_properties.gif Binary files differdeleted file mode 100755 index f293841e6..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_properties.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_wizard.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_wizard.gif Binary files differdeleted file mode 100755 index 9b9d58300..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgLine_wizard.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgDlg.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgDlg.gif Binary files differdeleted file mode 100755 index 36829fe99..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgDlg.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgline.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgline.gif Binary files differdeleted file mode 100755 index 970377d5b..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/msgSample_msgline.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/sampleMessageFile.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/sampleMessageFile.html deleted file mode 100755 index 5888bfc06..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/sampleMessageFile.html +++ /dev/null @@ -1,81 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>Sample Message File</title> -</head> - -<body bgcolor="#ffffff"> -<h1>Sample Message File</h1> -<p>This is an example of a simple message file, say in <samp>sampleMessages.xml</samp>, which has defined messages for only a single component. -<pre> - -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE MessageFile SYSTEM "../org.eclipse.rse.ui/messageFile.dtd"> -<!-- <I>This is an exammple of a message file used by SystemMessage and SystemMessageDialog</I> --> -<MessageFile Version="1.0"> - <Component Name="Samples Plugin" Abbr="<B>SPP</B>"> - <Subcomponent Name="Dialogs" Abbr="<B>D</B>"> - <!-- Component 'D' for dialog sample messages --> - <MessageList> -<A name="SPPD1000"></A> <Message ID="<B>1000</B>" Indicator="E"> - <LevelOne>You must enter a name</LevelOne> - <LevelTwo>You have left the customer name empty. Specify a name.</LevelTwo> - </Message> -<A name="SPPD1001"></A> <Message ID="<B>1001</B>" Indicator="E"> - <LevelOne>You must enter a birth year</LevelOne> - <LevelTwo>You have left the birth year empty. Specify a year.</LevelTwo> - </Message> -<A name="SPPD1002"></A> <Message ID="<B>1002</B>" Indicator="E"> - <LevelOne>%1 is not a valid year</LevelOne> - <LevelTwo>The birth year specified is not within the valid range of %2 to %3.</LevelTwo> - </Message> -<A name="SPPD1003"></A> <Message ID="<B>1003</B>" Indicator="E"> - <LevelOne>Year %1 is out of range</LevelOne> - <LevelTwo>The value you specified for the birth year is not a valid number.</LevelTwo> - </Message> -<A name="SPPD1004"></A> <Message ID="<B>1004</B>" Indicator="E"> - <LevelOne>You must enter a birth month</LevelOne> - <LevelTwo>You have left the birth month empty. Specify a month.</LevelTwo> - </Message> -<A name="SPPD1005"></A> <Message ID="<B>1005</B>" Indicator="E"> - <LevelOne>%1 is not a valid month</LevelOne> - <LevelTwo>The value you specified for the birth month is not a valid number.</LevelTwo> - </Message> -<A name="SPPD1006"></A> <Message ID="<B>1006</B>" Indicator="E"> - <LevelOne>Month %1 is out of range</LevelOne> - <LevelTwo>The birth month specified is not within the valid range of %2 to %3.</LevelTwo> - </Message> -<A name="SPPD1007"></A> <Message ID="<B>1007</B>" Indicator="E"> - <LevelOne>You must enter a birth day</LevelOne> - <LevelTwo>You have left the birth day empty. Specify a day.</LevelTwo> - </Message> -<A name="SPPD1008"></A> <Message ID="<B>1008</B>" Indicator="E"> - <LevelOne>%1 is not a valid day</LevelOne> - <LevelTwo>The value you specified for the birth day is not a valid number.</LevelTwo> - </Message> -<A name="SPPD1009"></A> <Message ID="<B>1009</B>" Indicator="E"> - <LevelOne>Day %1 is out of range</LevelOne> - <LevelTwo>The birth day specified is not within the valid range of %2 to %3.</LevelTwo> - </Message> -<A name="SPPD1010"></A> <Message ID="<B>1010</B>" Indicator="I"> - <LevelOne>Customer %1 created successfully. Re-run to see update mode.</LevelOne> - <LevelTwo>The customer was created. Re-running the same sample action will show the dialog in update mode.</LevelTwo> - </Message> -<A name="SPPD1011"></A> <Message ID="<B>1011</B>" Indicator="I"> - <LevelOne>Customer %1 updated successfully.</LevelOne> - <LevelTwo>Congratulations!</LevelTwo> - </Message> - </MessageList> - </Subcomponent> - </Component> -</MessageFile> -</pre> - - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageAPI.html deleted file mode 100755 index b0d252be7..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageAPI.html +++ /dev/null @@ -1,154 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Message API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Message API</h1> -<p>To work with messages, which are defined in an xml <a href="uiMessageFile.html">message file</a>, -you use: -</p> -<ul> -<li>Static methods in the -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html">org.eclipse.rse.ui.SystemBasePlugin</A></samp> -class to load the message file and extract messages from it. -<li>Classes in the -<samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/package-summary.html">org.eclipse.rse.ui.messages</A></samp> -package to do variable substitution, and display the messages to the user. -</ul> - -<h2>Methods for Parsing the Message File</h2> -<p>Once you have defined your message file, you must update your plugin class to load it at startup time. -To do this, simply call the static method -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadMessageFile(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadMessageFile</a></samp> -in the RSE-supplied <samp><a href="../plugin/uiPluginAPI.html">SystemBasePlugin</a></samp> class. -<BR> -<BR> -After the message file is loaded into memory, you can extract messages from it by calling the static method -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getMessage(org.eclipse.rse.ui.messages.SystemMessageFile, java.lang.String)">getMessage</a></samp> -from the same <samp><a href="../plugin/uiPluginAPI.html">SystemBasePlugin</a></samp> class. -</p> - -<h2>Classes for Displaying Messages</h2> -<p>The following classes are all defined in the <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/package-summary.html">org.eclipse.rse.ui.messages</a></samp> package. </p> - -<h3><A name="SystemMessageFile"></A>The <samp>SystemMessageFile</samp> Class</h3> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadMessageFile(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadMessageFile</a></samp> method in <samp>SystemBasePlugin</samp>, returns an instance of -<samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessageFile.html">SystemMessageFile</a></samp>, -representing the parsed message file. It is methods in this which return individual messages. -<h3><A name="SystemMessage"></A>The <samp>SystemMessage</samp> Class</h3> -The <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getMessage(org.eclipse.rse.ui.messages.SystemMessageFile, java.lang.String)">getMessage</a></samp> method in <samp>SystemBasePlugin</samp> returns an instance of -<samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessage.html">SystemMessage</a></samp>, -representing an individual message from the message file. -</p> -<p>To do message <i>variable substitution</i>, call the appropriate overload of the <samp>makeSubstitution</samp> method in -the <A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessage.html">message</A> object, passing as many parameters as there are unique substitution variables in the message. -</p> -<p>To get the first level message text, call <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessage.html#getLevelOneText()">getLevelOneText</a></samp> on the message object. To get -the second level help, call <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessage.html#getLevelTwoText()">getLevelTwoText</a></samp>. -</p> - -<h3><A name="SystemMessageDialog"></A>The <samp>SystemMessageDialog</samp> Class</h3> -<p>To display a message in a dialog, instantiate <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/SystemMessageDialog.html">SystemMessageDialog</a></samp>, passing -in a parent shell and the message object, and then call the appropriate <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/SystemMessageDialog.html#open()">open</a></samp> method in the dialog object. Here is what the message -dialog looks like, for a message of type Error (the type dictates the error icon): -</p> -<P><IMG border="0" src="msgDialog.gif" width="457" height="190"></P> - -<h3><A name="ISystemMessageLine"></A>The <samp>ISystemMessageLine</samp> Interface</h3> -<p>If you are extending the RSE class <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html">SystemPromptDialog</a></samp> for dialogs, -or <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html">AbstractSystemWizardPage</a></samp> for wizard pages -or <samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemBasePropertyPage.html">SystemBasePropertyPage</a></samp> for property pages, you can display the message to the -user by calling the <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/ISystemMessageLine.html#setErrorMessage(org.eclipse.rse.ui.messages.SystemMessage)">setErrorMessage</a></samp> method all these classes support. These classes all implement -the interface <b><samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/ISystemMessageLine.html">ISystemMessageLine</a></samp></b>, which also includes the method <samp>clearErrorMessage</samp>. For non-error -messages, use <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/ISystemMessageLine.html#setMessage(org.eclipse.rse.ui.messages.SystemMessage)">setMessage</a></samp> -and <samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/ISystemMessageLine.html#clearMessage()">clearMessage</a></samp>.</p> -<p> -Here is what a system message issued in a <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemPromptDialog.html">SystemPromptDialog</a></samp> dialog looks like:</p> -<P><IMG border="0" src="msgLine_dialog.gif" width="264" height="125"></P> -<p>The user can select the question mark icon on the right to see the full message dialog, and hence access the second level help for the message. -<p>Here is what a system message issued in an <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html">AbstractSystemWizardPage</a></samp> looks like:</p> -<P><IMG border="0" src="msgLine_wizard.gif" width="439" height="98"></P> -<p>If the user clicks the mouse on the message or icon, they will see the full message dialog for the message.</p> - -<p>Here is what a system message issued in a <samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemBasePropertyPage.html">SystemBasePropertyPage</a></samp> looks like:</p> -<P><IMG border="0" src="msgLine_properties.gif" width="491" height="75"></P> -<p>Again, if the user clicks the mouse on the message or icon, they will see the full message dialog for the message.</p> - -<h2>Classes for Displaying Message Exceptions</h2> -<p>The following class is defined in the <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/package-summary.html">org.eclipse.rse.services.clientserver.messages</a></samp> package. - -<h3>The <samp>SystemMessageDialog</samp> Class</h3> -<p>Many of the RSE APIs throw <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessageException.html">org.eclipse.rse.services.clientserver.messages.SystemMessageException</a></samp>, which -encapsulates a system message object. To get the encapsulated message, call <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessageException.html#getSystemMessage()">getSystemMessage()</a></samp>. -To display the message in an RSE message dialog box, simply call <samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessageException.html#displayMessage()">displayMessage()</a></samp> on the exception object. -To get the first-level text, call <samp>getMessage()</samp>, or <samp>getSystemMessage().getLevelOneText()</samp> -</p> - -<h1>Message Example</h1> -<h2>Declaring the Messages</h2> -<p>Declare the messages via the <samp>Message</samp> tag in a <a href="uiMessageFile.html">message file</a>, such as <samp>sampleMessages.xml</samp> -<pre><?xml version="1.0" encoding='UTF-8'?> -<!DOCTYPE MessageFile SYSTEM "../org.eclipse.rse.ui/messageFile.dtd"> -<!-- This is an exammple of a message file used by SystemMessage and SystemMessageDialog --> -<MessageFile Version="1.0"> - <Component Name="Samples Plugin" Abbr="<B>SPP</B>"> - <Subcomponent Name="Dialogs" Abbr="<B>D</B>"> - <!-- Component 'D' for dialog sample messages --> - <MessageList> - <Message ID="<B>1003</B>" Indicator="E"> - <LevelOne>%1 is not a valid year</LevelOne> - <LevelTwo>The birth year specified is not within the valid range of %2 to %3.</LevelTwo> - </Message> - <!-- <I>repeat Message elements as needed</I> --> - </MessageList> - </Subcomponent> - </Component> -</MessageFile> -</pre> - -<h2>Processing the Message File</h2> -In your plugin class, declare a message file static variable, load the message file in the constructor, and -supply a static method for retrieving a message from the file. -<pre>import org.eclipse.rse.ui.messages.*; // <I>for message file classes</I> -import org.eclipse.rse.ui.*; // <I>for SystemBasePlugin</I> -<B>...</B> -private static SystemMessageFile messageFile = null; -<B>...</B> -messageFile = SystemBasePlugin.loadMessageFile(descriptor, "sampleMessages.xml"); // <I>in constructor</I> -<B>...</B> - -/** - * <I>Retrieve a message from this plugin's message file</I> - * <I>@param msgId - the ID of the message to retrieve. This is the concatenation of the</I> - * <I>message's component abbreviation, subcomponent abbreviation, and message ID as declared</I> - * <I>in the message xml file.</I> - */ -<A name="getPluginMessage"></A>public static SystemMessage <B>getPluginMessage</B>(String msgId) -{ - return SystemBasePlugin.getMessage(messageFile, msgId); -}</pre> - -<h2>Retrieving the Message</h2> -<pre>SystemMessage errorMessage = SamplesPlugin.getPluginMessage("SPPD1003"); -errorMessage.makeSubstitution(input, "1900", "2003");</pre> - -<h2>Displaying the Message</h2> -<h3>On a Message Line</h3> -<pre>setErrorMessage(errorMessage);</pre> - -<P><IMG border="0" src="msgSample_msgline.gif" width="227" height="208"></P> -<h3>In a Message Dialog</h3> -<pre>SystemMessageDialog msgDlg = new SystemMessageDialog(shell, errorMessage);</br>msgDlg.open(); // <I>to open with details not showing</I> -//msgDlg.openWithDetails(); // <I>to open with details already showing</I> </pre> - -<P><IMG border="0" src="msgSample_msgDlg.gif" width="457" height="190"></P> -<P><BR> -</P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageFile.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageFile.html deleted file mode 100755 index af83cab09..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessageFile.html +++ /dev/null @@ -1,79 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<html>
-<head>
-<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
-<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
-<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css">
-<title>RSE Message File</title>
-</head>
-
-<body bgcolor="#ffffff">
-<h1>RSE Message File</h1>
-<p>To exploit the message framework in RSE, you start by create an message file, named
-say <samp>mymessages.xml</samp>, which looks something like this:
-<pre>
-<?xml version="1.0" encoding='UTF-8'?>
-<!-- This is a sample message file -->
-<MessageFile Version="1.0">
- <Component Name="ACME Tools" Abbr="ACME">
- <Subcomponent Name="General" Abbr="G">
- <MessageList>
- <Message ID="1001" Indicator="E">
- <LevelOne>You made a mistake</LevelOne>
- <LevelTwo>Fix your mistake, then re-attempt the operation.</LevelTwo>
- </Message>
- </MessageList>
- </Subcomponent>
- </Component>
-</MessageFile>
-</pre>
-
-<h2>RSE Message File Elements</h2>
-<p>Typically, this file is created in plugin project's root folder.</p>
-<p>The important elements in this file are:
-</p><TABLE border="1">
- <TBODY>
- <TR>
- <TH>Element</TH>
- <TH>Description</TH>
- </TR>
- <TR>
- <TD>MessageFile</TD>
- <TD>The overall element for the file. There is only one of these tags.</TD>
- </TR>
- <TR>
- <TD>Component</TD>
- <TD>Identifies a course-grained component within your plugin. You can specify multiple component tags. It is up to you to decide<BR>how many components to divide your plugin into. The abbreviation (Abbr) of the component constitutes the first part of the message ID for messages defined in this component, aiding in servicing when an error message is reported.
- </TD>
- </TR>
- <TR>
- <TD>Subcomponent</TD>
- <TD>Identifies a fine-grained subcomponent within a component. The abbreviation (Abbr) of the subcomponent is appended to the component's abbreviation when the message ID is created for messages in this subcomponent. It is up to you to decide how many subcomponents to divide your component into, and what to name them.</TD>
- </TR>
- <TR>
- <TD>MessageList</TD>
- <TD>Simply encapsulates the list of Message elements for this subcomponent.</TD>
- </TR>
- <TR>
- <TD>Message</TD>
- <TD>Defines a message. <BR>
- The <b>ID</b> attribute can be anything you like, but following a naming or numbering convention is a good idea. The ID is appended to the component and subcomponent abbreviations to form the message ID the user will see.
- <BR>The <b>Indicator</b> attribute identifies the severity of the message: <b>I</b> for Information, <b>E</b> for Error, <b>W</b> for Warning, <b>U</b> for Unexpected, and <b>Q</b> for Question. This affects the icon that will be used for this message, and the buttons allowed on the message dialog.
- </TD>
- </TR>
- <TR>
- <TD>LevelOne</TD>
- <TD>The first-level message the user will initially see. Use %n for substitution variables, where n is a positive integer incrementing up from 1.</TD>
- </TR>
- <TR>
- <TD>LevelTwo</TD>
- <TD>The second-level help for the message, the user will only see if they ask to see it. Use %n for substitution variables. Any variable used here and in the LevelOne text will be consistently substituted with the same value.</TD>
- </TR>
- </TBODY>
-</TABLE>
-
-<h2>RSE Message File Sample</h2>
-<p>This is a bigger <A href="sampleMessageFile.html">sample</A>.</p>
-</body>
-</html>
diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessagesCore.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessagesCore.html deleted file mode 100755 index 1995258e5..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/messages/uiMessagesCore.html +++ /dev/null @@ -1,1338 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<HTML> -<HEAD> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<TITLE> Message File systemmessages.xml </TITLE> -<style type="text/css"> -h2 { background-color: #CCCCFF } -</style> -</HEAD> -<BODY> -<H1>Remote System Explorer Messages</H1> -<br> -<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> -<TR BGCOLOR="#CCCCFF"> -<TD COLSPAN=2><FONT SIZE="+2"> -<B>Sub-Component Summary</B></FONT></TD> -</TR> -<TR BGCOLOR="white"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"> -<A href=#General>General</A></TD> -<TD><b>Message prefix</b>=RSEG</TD></TR> -<TR BGCOLOR="white"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"> -<A href=#Other>Other</A></TD> -<TD><b>Message prefix</b>=RSEO</TD></TR> -<TR BGCOLOR="white"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"> -<A href=#Files>Files</A></TD> -<TD><b>Message prefix</b>=RSEF</TD></TR> -<TR BGCOLOR="white"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"> -<A href=#Communications>Communications</A></TD> -<TD><b>Message prefix</b>=RSEC</TD></TR> -</TABLE> -<A NAME="General"><!-- --></A><H2>General Messages</H2> -<H3>RSEG0402</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1 must be between %2 and %3.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1001</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Under construction<br> -<b>LevelTwo: </b>This function is not yet available.<br> -<H3>RSEG1002</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>This will reload the Remote System Explorer. Are you sure?<br> -<b>LevelTwo: </b>This action should only be used after receiving files from a team repository. It reloads the RSE from the workspace, incorporating the new files.<br> -<H3>RSEG1003</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>An unexpected exception has occurred<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEG1006</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter name<br> -<b>LevelTwo: </b>You must enter a name in the field where the cursor is positioned.<br> -<H3>RSEG1007</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name in use<br> -<b>LevelTwo: </b>This name is already used by another resource. Enter a unique name.<br> -<H3>RSEG1008</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name not valid<br> -<b>LevelTwo: </b>The name entered does not have valid syntax<br> -<H3>RSEG1009</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>You must rename %1<br> -<b>LevelTwo: </b>You have left the new name the same as the old name. Enter a new name that is different from the old name.<br> -<H3>RSEG1010</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name %1 is specified more than once<br> -<b>LevelTwo: </b>Two or more resources have been renamed to the same new name. Each resource must have a unique name.<br> -<H3>RSEG1011</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name %1 not valid<br> -<b>LevelTwo: </b>The name %1 does not have valid syntax<br> -<H3>RSEG1012</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter new name<br> -<b>LevelTwo: </b>You have the new name entry field empty. You must enter a unique new name.<br> -<H3>RSEG1013</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Expand failed or cancelled. Try again.<br> -<b>LevelTwo: </b>When expanding a node in the tree, and retrieving the resources, either an error occurred or you cancelled the operation. The expand is cancelled.<br> -<H3>RSEG1014</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter profile name<br> -<b>LevelTwo: </b>You must enter a name for the profile. Profiles contain all connections, filters and user defined actions. They are shared by the team, but each team member sees only those profiles which are active. Each profile can be private to you, or used by the whole team if all team members make the profile active. The name should reflect this. That is, if the profile is to be private to you, pick a name that is least likely to collide with a name chosen by other team members.<br> -<H3>RSEG1015</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Profile of that name already exists<br> -<b>LevelTwo: </b>There is already a profile of that name. Choose a unique name for the profile.<br> -<H3>RSEG1016</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Not a valid profile name<br> -<b>LevelTwo: </b>Profiles are stored as folders in the file system, so profile names must be valid folder names for the workbench. Furthermore, they must not contain pound signs (#) or exceed 100 characters in length. Profile names are not case sensitive, but are case tolerant.<br> -<H3>RSEG1017</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter number<br> -<b>LevelTwo: </b>The value %1 you entered is not numeric. Enter only numeric input.<br> -<H3>RSEG1018</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name not valid as folder name<br> -<b>LevelTwo: </b>The name must be a valid folder name within the workbench and the underlying file system.<br> -<H3>RSEG1019</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Name not valid as file name<br> -<b>LevelTwo: </b>The name must be a valid file name within the workbench and the underlying file system.<br> -<H3>RSEG1020</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Please enter a valid system type.<br> -<b>LevelTwo: </b>You must select a system type. The system type is the type of the operating system of the remote sytem.<br> -<H3>RSEG1021</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Please enter a valid connection name.<br> -<b>LevelTwo: </b>You must enter a connection name. This name is arbitrary, but must be unique to the selected profile.<br> -<H3>RSEG1022</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Connection name is not unique for the selected profile.<br> -<b>LevelTwo: </b>Connection names must be unique to the profile that contains the connection. Specify a name not already in use.<br> -<H3>RSEG1023</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Invalid connection name. Must be a valid folder name in the underlying file system.<br> -<b>LevelTwo: </b>The connection name is not syntactically valid. The name must be a valid folder name within the workbench and the underlying file system.<br> -<H3>RSEG1024</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter host name or IP address<br> -<b>LevelTwo: </b>You must specify a host name or TCP/IP address for the remote system.<br> -<H3>RSEG1025</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter user ID<br> -<b>LevelTwo: </b>You must specify a user ID to be used to connect to the system.<br> -<H3>RSEG1026</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Not a valid user ID<br> -<b>LevelTwo: </b>The user ID entered is not syntactically valid. The only restriction for a user ID is that it not use the characters '=' or ';'.<br> -<H3>RSEG1027</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter port number<br> -<b>LevelTwo: </b>You must specify a port number that is used to connect with the server-side communication layer.<br> -<H3>RSEG1028</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Not a valid port number<br> -<b>LevelTwo: </b>The value you entered is not a valid port number. It must be a positive integer between 1 and 65536.<br> -<H3>RSEG1029</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter value<br> -<b>LevelTwo: </b>You must enter a value in the field where the cursor is.<br> -<H3>RSEG1030</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Entry is not unique<br> -<b>LevelTwo: </b>The value you entered is already in use. Specify a value that is not already in use.<br> -<H3>RSEG1031</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Syntax is not valid<br> -<b>LevelTwo: </b>The syntax of the value at the cursor position is not valid.<br> -<H3>RSEG1032</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter path<br> -<b>LevelTwo: </b>You must specify a file system path.<br> -<H3>RSEG1033</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Path is not unique<br> -<b>LevelTwo: </b>The path you specified is already in use.<br> -<H3>RSEG1034</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Path syntax is not valid<br> -<b>LevelTwo: </b>The syntax of the path you specified is not valid. Enter a file system path that is valid for the remote operating system.<br> -<H3>RSEG1035</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter password<br> -<b>LevelTwo: </b>You must specify your password.<br> -<H3>RSEG1036</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Password has expired<br> -<b>LevelTwo: </b>Your password has expired, and must be reset before continuing.<br> -<H3>RSEG1037</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter filter pool name<br> -<b>LevelTwo: </b>You must specify a name for your filter pool. Filter pool names are arbitrary, but typically reflect the contents of the filters, such as "Release 1" or "Accounts Payable".<br> -<H3>RSEG1038</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter pool name already exists in this profile<br> -<b>LevelTwo: </b>A filter pool with this name already exists in the profile.<br> -<H3>RSEG1039</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter pool name not valid<br> -<b>LevelTwo: </b>The filter pool name you specified is not a valid name. The name must be a valid folder name in the workbench, and must not contain the pound sign '#'. It must also not exceed 50 characters in length.<br> -<H3>RSEG1040</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Profile name %1 is reserved<br> -<b>LevelTwo: </b>The given profile name is reserved. Specify another name for the profile.<br> -<H3>RSEG1041</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Connection of name %1 already exists in profile %2. Continue?<br> -<b>LevelTwo: </b>A connection of this name exists in another profile. While this allowed, it is discouraged as it may lead to confusion. Press Yes to create the connection, or No to cancel the creation.<br> -<H3>RSEG1042</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter filter name<br> -<b>LevelTwo: </b>You must specify a name for your filter. You can specify any name you like. Choose a name that tells others the contents of this filter. For example, "Source Files for Release 1".<br> -<H3>RSEG1043</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter name already exists in this filter pool<br> -<b>LevelTwo: </b>The filter name you specified is in use. You must specify a name unique for the parent filter pool.<br> -<H3>RSEG1044</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter name not valid<br> -<b>LevelTwo: </b>The filter name you specified is not a valid name. The name must be a valid file name in the workbench, and must not contain the pound sign '#'. It must also not exceed 100 characters in length.<br> -<H3>RSEG1045</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter filtering information<br> -<b>LevelTwo: </b>You must specify filtering information<br> -<H3>RSEG1046</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter string already exists<br> -<b>LevelTwo: </b>You specified a filter string which already exists in this filter. Having duplicate filter strings will result in duplicate resources in the expanded filter. Specify unique filter strings, preferably which result in unique resources. For example, don't specify both ABC* and A*.<br> -<H3>RSEG1047</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter string not valid<br> -<b>LevelTwo: </b>The filter string you specified is not syntactically correct.<br> -<H3>RSEG1048</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Duplicate filter string '%1'.<br> -<b>LevelTwo: </b>You have defined the same filter string twice or more. This will result in multiple copies of the same resource, when this filter is expanded. Delete the redundant filter strings.<br> -<H3>RSEG1049</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter string '%1' already exists in filter %2<br> -<b>LevelTwo: </b>This filter string cannot be copied or moved to the target filter. The same filter string already exists there<br> -<H3>RSEG1050</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Save to disk failed with an unexpected exception<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEG1051</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Restore of data failed with unexpected exception<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEG1052</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Delete selected resources?<br> -<b>LevelTwo: </b>This is a permanent deletion of the selected resources and cannot be undone<br> -<H3>RSEG1053</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Delete profile '%1'?<br> -<b>LevelTwo: </b>Do you want to delete this profile, including all of its connections, filters and user actions? Select Yes to delete, or No to cancel the delete request<br> -<H3>RSEG1054</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connecting to %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1055</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connecting to %1 at port %2<br> -<b>LevelTwo: </b><br> -<H3>RSEG1056</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Connect to %1 failed with an unexpected exception<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1057</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Connect failed. Host %1 not found or not responding<br> -<b>LevelTwo: </b><br> -<H3>RSEG1058</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connect to %1 was cancelled<br> -<b>LevelTwo: </b><br> -<H3>RSEG1059</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Disconnecting from %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1060</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Disconnecting from %1 at port %2<br> -<b>LevelTwo: </b><br> -<H3>RSEG1061</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Disconnect from %1 failed with exception<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1062</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Disconnect from %1 was cancelled<br> -<b>LevelTwo: </b><br> -<H3>RSEG1063</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Unexpected error deleting %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1064</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Unexpected error renaming %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1065</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unexpected error moving %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1066</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Operation failed with exception '%1'<br> -<b>LevelTwo: </b><br> -<H3>RSEG1067</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Operation cancelled.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1068</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Warning. Profile '%1' should be made active. Active connection '%2' contains a reference to it.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1069</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Warning. Profile '%1' should be active. Active connection '%2' contains a reference to it.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1070</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Resolving %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1071</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Running %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1072</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying '%1' to '%2'<br> -<b>LevelTwo: </b><br> -<H3>RSEG1073</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying connection %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1074</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying connections<br> -<b>LevelTwo: </b><br> -<H3>RSEG1075</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filter pools<br> -<b>LevelTwo: </b><br> -<H3>RSEG1076</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filter pool %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1077</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filters<br> -<b>LevelTwo: </b><br> -<H3>RSEG1078</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filter %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1079</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filter strings<br> -<b>LevelTwo: </b><br> -<H3>RSEG1080</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying filter string %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1081</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying subsystems<br> -<b>LevelTwo: </b><br> -<H3>RSEG1082</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Filter pool(s) successfully copied to '%1'. You must create a new filter pool reference to see it (them).<br> -<b>LevelTwo: </b><br> -<H3>RSEG1083</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving '%1' to '%2'<br> -<b>LevelTwo: </b><br> -<H3>RSEG1084</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving connection %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1085</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving connections<br> -<b>LevelTwo: </b><br> -<H3>RSEG1086</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving filter pools<br> -<b>LevelTwo: </b><br> -<H3>RSEG1087</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving filter pool %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1088</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving filters<br> -<b>LevelTwo: </b><br> -<H3>RSEG1089</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving filter %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1090</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving filter strings<br> -<b>LevelTwo: </b><br> -<H3>RSEG1091</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Moving filter string %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1092</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Filter pool(s) successfully moved to '%1'. You must create a new filter pool reference to see it (them).<br> -<b>LevelTwo: </b><br> -<H3>RSEG1093</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Setting %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1094</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Setting properties<br> -<b>LevelTwo: </b><br> -<H3>RSEG1095</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Querying %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1096</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Querying properties<br> -<b>LevelTwo: </b><br> -<H3>RSEG1097</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Running %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1098</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Expand failed. Try again<br> -<b>LevelTwo: </b><br> -<H3>RSEG1099</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Expand cancelled. Try again<br> -<b>LevelTwo: </b><br> -<H3>RSEG1100</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Empty list<br> -<b>LevelTwo: </b><br> -<H3>RSEG1101</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>List cancelled<br> -<b>LevelTwo: </b><br> -<H3>RSEG1102</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Filter created successfully. Expand this again to create another<br> -<b>LevelTwo: </b><br> -<H3>RSEG1103</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Connection %1 not found<br> -<b>LevelTwo: </b>No connection named %1 currently exists<br> -<H3>RSEG1104</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Profile %1 not found<br> -<b>LevelTwo: </b>No profile named %1 currently exists<br> -<H3>RSEG1105</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Folder %1 not found on host %2<br> -<b>LevelTwo: </b><br> -<H3>RSEG1106</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File %1 not found on host %2<br> -<b>LevelTwo: </b><br> -<H3>RSEG1107</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File or folder %1 not found on host %2<br> -<b>LevelTwo: </b><br> -<H3>RSEG1108</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connection created successfully. Expand this again to create another<br> -<b>LevelTwo: </b><br> -<H3>RSEG1109</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Connection busy<br> -<b>LevelTwo: </b><br> -<H3>RSEG1110</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Command interrupted<br> -<b>LevelTwo: </b><br> -<H3>RSEG1111</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to run command<br> -<b>LevelTwo: </b>Possible causes: connection has been deleted, connection has been renamed, or connection has been disconnected<br> -<H3>RSEG1112</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Command cancelled<br> -<b>LevelTwo: </b><br> -<H3>RSEG1115</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1116</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1117</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Copying %1...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1118</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Moving %1...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1119</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Saving %1...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1120</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1 is not a valid archive name.<br> -<b>LevelTwo: </b>You must give a filename with an extension that is recognized as a valid archive type extension.<br> -<H3>RSEG1122</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The archive is corrupted or unreadable.<br> -<b>LevelTwo: </b>The archive cannot be opened because its format is unrecognized, or its contents are damaged in some way.<br> -<H3>RSEG1123</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Cannot create archive.<br> -<b>LevelTwo: </b>There was an error creating the empty archive. The archive was not created.<br> -<H3>RSEG1124</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Creation of the virtual file or folder %1 failed.<br> -<b>LevelTwo: </b>There was an error creating the virtual file or folder. The virtual file or folder was not created.<br> -<H3>RSEG1125</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Deletion of the virtual file or folder %1 failed.<br> -<b>LevelTwo: </b>There was an error deleting the virtual file or folder. The virtual file or folder was not deleted.<br> -<H3>RSEG1126</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Could not move the virtual file or folder %1.<br> -<b>LevelTwo: </b>There was an error moving the virtual file or folder. The virtual file or folder was not moved.<br> -<H3>RSEG1130</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Permanently delete selected remote resource(s)?<br> -<b>LevelTwo: </b>This is a permanent deletion of the selected remote resources from disk. This action cannot be undone<br> -<!-- [191013] commenting out user actions -<H3>RSEG1140</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Error occurred while loading the user-defined action information from file: %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1141</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>The xml file '%1' appears to be corrupted. It has been replaced<br> -<b>LevelTwo: </b>Expected root tag to be named '%2'. The corrupted file has been renamed to '%3' and a new file created for you<br> ---> -<H3>RSEG1150</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to perform action as the underlying file system folder is in use<br> -<b>LevelTwo: </b>The file system folder %1 is in use by another task and cannot be removed or modified<br> -<H3>RSEG1151</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to perform action as the underlying file system file is in use<br> -<b>LevelTwo: </b>The file system file %1 is in use by another task and cannot be removed or modified<br> -<H3>RSEG1160</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Filter pool %1 created. Create a reference to it in the selected subsystem?<br> -<b>LevelTwo: </b>New filter pools are not accessible until a reference is added to them in a subsystem. Select Yes to add a reference to the new filter pool in selected subsystem %2<br> -<H3>RSEG1161</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter update failed: %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1162</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter rename failed: %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEG1170</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter numeric value<br> -<b>LevelTwo: </b>You must enter a numeric value<br> -<H3>RSEG1171</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Value %1 not numeric<br> -<b>LevelTwo: </b>The value specified is not a valid number<br> -<H3>RSEG1172</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Value %1 not in range<br> -<b>LevelTwo: </b>The value specified is not within the valid range of %2 to %3<br> -<!-- [191013] commenting out user actions -<H3>RSEG1180</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter action name<br> -<b>LevelTwo: </b>You must enter a name for this action<br> -<H3>RSEG1181</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Action name is not unique<br> -<b>LevelTwo: </b>There is already an action with the given name in the selected profile. Specify a name that is not already in use<br> -<H3>RSEG1182</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Action name is not valid<br> -<b>LevelTwo: </b>The given name is not a valid action name<br> -<H3>RSEG1183</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter comment<br> -<b>LevelTwo: </b>You must enter a comment for this action<br> -<H3>RSEG1184</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Action comment is not valid<br> -<b>LevelTwo: </b>The given comment has syntactical errors<br> -<H3>RSEG1185</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter command<br> -<b>LevelTwo: </b>You must enter a command for this action<br> -<H3>RSEG1186</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Action command is not valid<br> -<b>LevelTwo: </b>The given command has syntactical errors<br> -<H3>RSEG1187</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter type name<br> -<b>LevelTwo: </b>You must enter a name for this collection of resource types<br> -<H3>RSEG1188</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Type name %1 in use<br> -<b>LevelTwo: </b>There is already a named type with the given name. Specify a name that is not already in use<br> -<H3>RSEG1189</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Type name %1 is not valid<br> -<b>LevelTwo: </b>The given name is not valid for a named type. It must not contain blanks<br> -<H3>RSEG1190</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Specify one or more resource types<br> -<b>LevelTwo: </b>You must specify one or more simple or generic resource types to constitute this named type<br> -<H3>RSEG1191</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Types not valid<br> -<b>LevelTwo: </b>Syntactical errors were found in the list of resource types<br> ---> -<H3>RSEG1192</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter source type<br> -<b>LevelTwo: </b>You must enter a source type<br> -<H3>RSEG1193</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Source type "%1" not valid<br> -<b>LevelTwo: </b>The source type you entered is not valid.<br> -<H3>RSEG1194</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Source type "%1" already exists<br> -<b>LevelTwo: </b>The source type you entered has already been specified. Specify a unique source type.<br> -<!-- [191013] commenting out user actions -<H3>RSEG1195</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter a label for this compile command<br> -<b>LevelTwo: </b>You must enter a label for this compile command, that will be shown in menus and lists<br> -<H3>RSEG1196</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Compile command label "%1" is in use<br> -<b>LevelTwo: </b>There is already a compile command with the given label. Specify a label that is not already in use<br> -<H3>RSEG1197</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Compile command label "%1" is not valid<br> -<b>LevelTwo: </b>The given label is not a valid compile label<br> -<H3>RSEG1198</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter command string for this compile command<br> -<b>LevelTwo: </b>You must enter a command string for this compile command. This is what is run when this compile command is selected.<br> -<H3>RSEG1199</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Compile command string "%1" is not valid<br> -<b>LevelTwo: </b>The given string is not a valid command.<br> ---> -<H3>RSEG1201</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Changes pending. Save changes?<br> -<b>LevelTwo: </b>You have changes pending. Select Yes to save those changes. Select No to discard those changes<br> -<H3>RSEG1202</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Changes pending. Continue?<br> -<b>LevelTwo: </b>You have changes pending. Select Yes to discard those changes. Select No to cancel the operation so you can first save your changes<br> -<H3>RSEG1220</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Host name '%1' not found or valid<br> -<b>LevelTwo: </b>A remote system of host name '%1' was not found. If you are working disconnected, de-select the checkbox to verify the host name<br> -<H3>RSEG1221</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Verifying host name...<br> -<b>LevelTwo: </b><br> -<!-- [191013] commenting out user actions -<H3>RSEG1230</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Delete selected user actions?<br> -<b>LevelTwo: </b>This is a permanent deletion of the selected actions and cannot be undone.Select Yes to delete and No to cancel the delete action<br> -<H3>RSEG1231</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Delete selected types?<br> -<b>LevelTwo: </b>This is a permanent deletion of the selected types and cannot be undone.Select Yes to delete and No to cancel the delete action<br> ---> -<H3>RSEG1240</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>There is an error on another page<br> -<b>LevelTwo: </b>Another page of the wizard has an error that must be corrected before the wizard can be finished<br> -<H3>RSEG1242</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Daemon failed to launch server on %1 using port %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEG1243</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>Failed to connect to the daemon on %1 using port %2 with an unexpected exception<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEG1244</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The selected encoding is not supported.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1250</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The pattern may not be blank<br> -<b>LevelTwo: </b><br> -<H3>RSEG1251</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Invalid regular expression<br> -<b>LevelTwo: </b>The value %1 you entered is not a valid regular expression<br> -<H3>RSEG1255</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1 - Running<br> -<b>LevelTwo: </b><br> -<H3>RSEG1256</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1 - Finished<br> -<b>LevelTwo: </b><br> -<H3>RSEG1257</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1 - Cancelled<br> -<b>LevelTwo: </b><br> -<H3>RSEG1258</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1 - Disconnected<br> -<b>LevelTwo: </b><br> -<H3>RSEG1260</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The invocation may not be blank<br> -<b>LevelTwo: </b><br> -<H3>RSEG1270</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Invalid transfer operation<br> -<b>LevelTwo: </b>The source %1 cannot be transferred into the target %2<br> -<H3>RSEG1280</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Downloading %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1281</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Uploading %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1282</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Synchronizing Resources...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1285</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Extracting %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1290</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1 of %2 complete (%3)<br> -<b>LevelTwo: </b><br> -<H3>RSEG1295</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Downloading resources...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1296</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Uploading resources...<br> -<b>LevelTwo: </b><br> -<H3>RSEG1297</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The new password is invalid.<br> -<b>LevelTwo: </b>The remote system indicated that the new password is unacceptable. Please ensure the new password follows all password rules for the remote system.<br> -<H3>RSEG1300</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The FTP service is unavailable on the remote system.<br> -<b>LevelTwo: </b>The RSE server needs to be installed manually.<br> -<H3>RSEG1301</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The Telnet service is unavailable on the remote system.<br> -<b>LevelTwo: </b>The RSE server needs to be started manually or a system administrator needs to install the RSE daemon.<br> -<H3>RSEG1302</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to start the RSE server.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1303</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to install the RSE server.<br> -<b>LevelTwo: </b><br> -<H3>RSEG1304</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Archive Management is not supported by the current File subsystem's configuration.<br> -<b>LevelTwo: </b>In the properties for the File subsystem, choose a configuration that supports Archive Management.<br> -<H3>RSEG1400</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>This action will take a few minutes. Proceed?<br> -<b>LevelTwo: </b>This action uncompresses a large number of HTML files from a zip file. It will take awhile, and require sufficient disk space. Press Yes to continue, No to cancel.<br> -<H3>RSEG1401</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Classic help already enabled.<br> -<b>LevelTwo: </b>The HTML files for the CODE and VisualAge RPG help have already been uncompressed.<br> -<H3>RSEG1500</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Remote Error List: %1<br> -<b>LevelTwo: </b><br> -<H3>RSEG1600</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Folder path must not be empty.<br> -<b>LevelTwo: </b>Select a folder from the dropdown list or click the Browse... button and select a folder from the dialog.<br> -<H3>RSEG1601</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Regular expression is not valid.<br> -<b>LevelTwo: </b>The value %1 you entered is not a valid regular expression.<br> -<br> -<hr> -<A NAME="Other"><!-- --></A><H2>Other Messages</H2> -<H3>RSEO1000</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEO1001</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEO1002</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEO1003</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEO1004</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEO1005</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEO1006</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>%1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEO1007</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEO1008</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>%1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEO1009</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>%1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEO1010</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b><br> -<H3>RSEO1011</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b><br> -<H3>RSEO1012</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b><br> -<H3>RSEO1013</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b><br> -<H3>RSEO1014</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>%1<br> -<b>LevelTwo: </b><br> -<br> -<hr> -<A NAME="Files"><!-- --></A><H2>Files Messages</H2> -<H3>RSEF1001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Operation failed. Security violation<br> -<b>LevelTwo: </b>Message reported from file system: %1<br> -<H3>RSEF1002</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Operation failed. File system input or output error<br> -<b>LevelTwo: </b>Message reported from file system: %1<br> -<H3>RSEF1003</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Folder is not empty. Cannot delete<br> -<b>LevelTwo: </b>The operation failed. One possible reason is that the folder is not empty<br> -<H3>RSEF1004</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Folder '%1' not found<br> -<b>LevelTwo: </b><br> -<H3>RSEF1005</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Folder '%1' not found. Would you like to create it?<br> -<b>LevelTwo: </b>The folder you specified does not exist. Select Yes to create it, No to cancel the operation<br> -<H3>RSEF1006</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File '%1' not found<br> -<b>LevelTwo: </b><br> -<H3>RSEF1011</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter file name pattern<br> -<b>LevelTwo: </b><br> -<H3>RSEF1007</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter string '%1' already exists in this filter<br> -<b>LevelTwo: </b><br> -<H3>RSEF1008</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Filter string name pattern not valid<br> -<b>LevelTwo: </b><br> -<H3>RSEF1009</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>You must include files or folders or both<br> -<b>LevelTwo: </b><br> -<H3>RSEF1010</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>No file types specified<br> -<b>LevelTwo: </b>Either specify one or more file types, or select to subset by file name<br> -<H3>RSEF1200</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Create a new File<br> -<b>LevelTwo: </b><br> -<H3>RSEF1201</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Create a new Folder<br> -<b>LevelTwo: </b><br> -<H3>RSEF1202</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Enter folder name<br> -<b>LevelTwo: </b><br> -<H3>RSEF1203</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Names cannot begin or end with whitespace.<br> -<b>LevelTwo: </b><br> -<H3>RSEF1204</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>%1 is an invalid character in a name.<br> -<b>LevelTwo: </b><br> -<H3>RSEF1205</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Enter file name<br> -<b>LevelTwo: </b><br> -<H3>RSEF1300</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Deletion of the object %1 failed<br> -<b>LevelTwo: </b>Either the object does not exist or you do not have enough authority to delete the object. If this is a folder, the folder may not be empty<br> -<H3>RSEF1301</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Renaming of the object %1 failed<br> -<b>LevelTwo: </b>Rename operation failed because, the object to rename does not exist, or the object with new object name already exists, or the user does not have enough authority to rename the object<br> -<H3>RSEF1302</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>No authority or file name not valid<br> -<b>LevelTwo: </b>The file could not be created because of one of the following reasons: - - the user does not have enough authority to create the file - - the file name is not valid<br> -<H3>RSEF1303</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File already exists<br> -<b>LevelTwo: </b>The new file %1 already exists<br> -<H3>RSEF1304</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Creation of the folder failed<br> -<b>LevelTwo: </b>The folder %1 could not be created because of one of the following reasons: - - the user does not have enough authority to create the folder - - the folder name is not valid<br> -<H3>RSEF1305</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The operation did not complete successfully. See additional messages in the Remote Shell view<br> -<b>LevelTwo: </b>The operation requested failed. Look in the Remote Shell view to see additional messages indicating the cause of the failure<br> -<H3>RSEF1306</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Copy of the file or folder %1 failed<br> -<b>LevelTwo: </b>The file system reported the copy operation failed. You may not have authority to the target folder, or it may be in use<br> -<H3>RSEF1307</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Move of the file or folder %1 failed<br> -<b>LevelTwo: </b>The file system reported the move operation failed. You may not have authority to the source folder or file, or you may not have authority to the target folder, or it may be in use<br> -<H3>RSEF1308</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Target folder cannot equal source folder<br> -<b>LevelTwo: </b>Attempting to move a file or folder to the same folder as it exists in is equivalent to a rename operation. Use the rename action for this<br> -<H3>RSEF1309</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Folder already exists<br> -<b>LevelTwo: </b>The new folder %1 already exists<br> -<H3>RSEF1310</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>New resource will not be visible due to subsetting. Create it anyway?<br> -<b>LevelTwo: </b>The name of the resource you are creating does not match the current filter criteria. If you select Yes to create the resource, it will not be visible within the current filter.<br> -<H3>RSEF1311</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Resource will not be visible due to subsetting. Rename it anyway?<br> -<b>LevelTwo: </b>The new name of the resource does not match the current filter criteria. If you select Yes to rename the resource, it will not be visible within the current filter.<br> -<H3>RSEF1312</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Target folder cannot descend from source folder<br> -<b>LevelTwo: </b>It is impossible to move a folder to one of its subfolders.<br> -<H3>RSEF1315</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Deleting %1...<br> -<b>LevelTwo: </b><br> -<H3>RSEF5001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File %1 on %2 can not be opened. You do not have read access to the file.<br> -<b>LevelTwo: </b>Change file permissions to ensure you have read access to the file.<br> -<H3>RSEF5002</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>You do not have write access to file %1 on %2. Do you want to open the file in browse mode?<br> -<b>LevelTwo: </b>You do not have write permission to the file %1 on %2. You can open the file in browse (read-only) mode. If you want to edit the file, change file permissions to allow write access to the file.<br> -<H3>RSEF5003</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File %1 can not be saved on %2. You do not have write access to the file.<br> -<b>LevelTwo: </b>Change file permissions to ensure you have write access to the file.<br> -<H3>RSEF5004</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File %1 can not be saved on %2. You do not have write access to the file.<br> -<b>LevelTwo: </b>Change file permissions to ensure you have write access to the file.<br> -<H3>RSEF5005</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>File %1 on %2 was modified since you opened this file or saved the file on the server. Do you want to replace the current contents of the file on the server?<br> -<b>LevelTwo: </b>The file %1 was changed on the server after it was retrieved from %2 or since the last time the file was saved on the server. Choose Yes to replace the contents of the file. Choose No to leave the file on the server with its current contents.<br> -<H3>RSEF5006</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File %1 was not completely saved on %2. The file was saved in the local file system.<br> -<b>LevelTwo: </b>An error occurred while saving the file on the server. A possible cause is the connection to the server was terminated. The file may only have been saved partially on the server. However, it was saved locally to help you recover. You will be asked to save the local copy to the server the next time you connect.<br> -<H3>RSEF5007</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>File %1 on %2 may not have been saved completely during an earlier edit session. The file was saved on the local file system. Do you want to replace the file with the local copy now?<br> -<b>LevelTwo: </b>An error occurred during an earlier attempt to save the file. But a local copy of the file was saved for recovery. Choose Yes to save the local copy on the server. Choose No if recovery is not required.<br> -<H3>RSEF5008</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>File %1 does not exist on %2. Do you want to create the file?<br> -<b>LevelTwo: </b>Choose Yes to create the file on the server and save the contents to the file. Choose No if you do not want the file to be created.<br> -<H3>RSEF5009</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>You are currently editing file %1 on %2. Do you want to open the file in browse mode?<br> -<b>LevelTwo: </b>You are allowed to edit a file in one editor only. You can, however, open the file in another editor for browsing. Browsing lets you view the file but does not allow you to edit its contents.<br> -<H3>RSEF5010</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Profile named %1 does not exist.<br> -<b>LevelTwo: </b>Profile may have been renamed or deleted.<br> -<H3>RSEF5011</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Connection named %1 does not exist.<br> -<b>LevelTwo: </b>Connection may have been renamed or deleted.<br> -<H3>RSEF5012</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>File %1 already exists. Do you want to replace it?<br> -<b>LevelTwo: </b><br> -<H3>RSEF5013</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Parent folder %1 does not exist. Do you want to create it?<br> -<b>LevelTwo: </b>The parent folder must be created for the file to be created.<br> -<H3>RSEF5014</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Parent folder %1 does not exist. Verify that the correct path was entered.<br> -<b>LevelTwo: </b><br> -<H3>RSEF5020</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Folder %1 is not readable. Cannot expand<br> -<b>LevelTwo: </b><br> -<H3>RSEF5101</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to use connection.<br> -<b>LevelTwo: </b>Please correct, or select alternate connection.<br> -<H3>RSEF5102</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unexpected exception received: %1.<br> -<b>LevelTwo: </b>Please see error log for details.<br> -<H3>RSEF5103</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>The file '%1' already exists on %2. Do you want to overwrite it?<br> -<b>LevelTwo: </b>Click Yes to overwrite the existing file, or click No to cancel the export.<br> -<H3>RSEF6001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File type extension can not be empty.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6002</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>File type extension must not contain '*' or '.'<br> -<b>LevelTwo: </b><br> -<H3>RSEF6003</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The encoding is not supported.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6101</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>One or more cached files have changes that have not been saved on the host.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6102</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Unable to synchronize cache changes to host. Operation cancelled.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6201</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The IP address or host name can not be empty.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6202</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The IP address is not valid.<br> -<b>LevelTwo: </b><br> -<H3>RSEF6203</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The host name is not valid.<br> -<b>LevelTwo: </b><br> -<H3>RSEF7001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Enter CCSID<br> -<b>LevelTwo: </b><br> -<H3>RSEF7002</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>CCSID must be a number between 0 and 65535<br> -<b>LevelTwo: </b><br> -<H3>RSEF8001</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>An unknown error occurred.<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8002</H3> -<b>Severity: </b>Unexpected<br> -<b>LevelOne: </b>An unexpected error occurred.<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8003</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Value is not valid<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8004</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Input %1 is not valid<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8050</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Can not copy root file system<br> -<b>LevelTwo: </b>The root is not something that can be copied<br> -<H3>RSEF8051</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Could not close import stream for %1<br> -<b>LevelTwo: </b><br> -<H3>RSEF8052</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to import %1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEF8053</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Creating folder %1<br> -<b>LevelTwo: </b><br> -<H3>RSEF8054</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Problems were encountered during import<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8055</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Error opening input stream for %1<br> -<b>LevelTwo: </b>%2<br> -<H3>RSEF8056</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to import %1<br> -<b>LevelTwo: </b>The file cannot be copied onto itself<br> -<H3>RSEF8057</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Error occurred while exporting %1: %2<br> -<b>LevelTwo: </b>%3<br> -<H3>RSEF8058</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Problems were encountered during export<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8059</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Cannot overwrite file %1<br> -<b>LevelTwo: </b>The file does not have its write attribute set, so it cannot be written to<br> -<H3>RSEF8060</H3> -<b>Severity: </b>Question<br> -<b>LevelOne: </b>Target folder does not exist. Would you like to create it?<br> -<b>LevelTwo: </b>Press Yes to create the folder %1, No to cancel<br> -<H3>RSEF8061</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Target folder already exists, as a file<br> -<b>LevelTwo: </b>The remote resource %1 already exists, but as a file, not a folder<br> -<H3>RSEF8062</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Destination folder conflicts with location of %1<br> -<b>LevelTwo: </b>You are attempting to export to the local file system, to a location that overlaps the resources being exported.<br> -<H3>RSEF8063</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Source is a file, not a folder<br> -<b>LevelTwo: </b>The remote resource %1 is a file, but a folder is required<br> -<H3>RSEF8064</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>There are no resources currently selected for import<br> -<b>LevelTwo: </b><br> -<H3>RSEF8065</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Select the source directory<br> -<b>LevelTwo: </b><br> -<H3>RSEF8066</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Enter or select a source folder<br> -<b>LevelTwo: </b>You have left the source folder empty, but it must be set to continue.<br> -<H3>RSEF8067</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Export problems<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8068</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>There are no resources currently selected for export<br> -<b>LevelTwo: </b>Select resources to be exported and try again<br> -<H3>RSEF8069</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Please enter a destination folder<br> -<b>LevelTwo: </b>The destination folder is empty. You must select a destination folder.<br> -<H3>RSEF8070</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Import problems<br> -<b>LevelTwo: </b>%1<br> -<H3>RSEF8071</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>There are no resources currently selected for import<br> -<b>LevelTwo: </b>Select resources to be imported and try again<br> -<H3>RSEF8072</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Filtering selection...<br> -<b>LevelTwo: </b><br> -<br> -<hr> -<A NAME="Communications"><!-- --></A><H2>Communications Messages</H2> -<H3>RSEC1001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Connection to %1 could not be established.<br> -<b>LevelTwo: </b>A socket connection to %1 could not be established. If you are connecting via the communications daemon make sure the daemon is running on the remote system. If you are connecting directly to the communications server make sure the server is started on the remote system. If you are connecting using REXEC, make sure that the server is installed on the remote system and that the REXEC service is running on that system.<br> -<H3>RSEC1002</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Invalid password or user ID<br> -<b>LevelTwo: </b>Authentication with %1 failed because the password or user ID is not correct.<br> -<H3>RSEC1003</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The user ID %1 is not valid<br> -<b>LevelTwo: </b>The user ID %1 on host %2 is not valid. Change the user ID and try again.<br> -<H3>RSEC1004</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The saved password is not correct.<br> -<b>LevelTwo: </b>The saved password for user ID %1 on host %2 is not correct. Please enter the password and try again.<br> -<H3>RSEC2001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Environment variable %1 is already defined<br> -<b>LevelTwo: </b>An environment variable %1 has already been defined. Change the new environment variable's name and press the Add button.<br> -<H3>RSEC2002</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Environment variable must have a name.<br> -<b>LevelTwo: </b>An attempt was made to define an environment variable with a blank name. Type a value for the environment variable name.<br> -<H3>RSEC2003</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Environment variable must have a name.<br> -<b>LevelTwo: </b>An attempt was made to clear the name of an environment variable. To remove an environment variable, select the variable in the list add press the Remove button.<br> -<H3>RSEC2004</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Environment variable name contains an invalid character.<br> -<b>LevelTwo: </b>The environment variable name cannot contain a space or the '=' character.<br> -<H3>RSEC2101</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Saved password for %1 on %2 already exists.<br> -<b>LevelTwo: </b>The password for user ID %1 on host %2 is already saved. Enter a different user ID or host name or change the existing saved password.<br> -<H3>RSEC2102</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>New and verify passwords do not match.<br> -<b>LevelTwo: </b>The new and verify passwords must match (case sensitive) in order to save the new password. Retype the new and verify passwords and try again.<br> -<H3>RSEC2103</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Entry field cannot be blank.<br> -<b>LevelTwo: </b>The hostname, user ID, system type and password entry fields cannot be blank. Type a value and press the Enter key to save the changes.<br> -<H3>RSEC2104</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>There are no tools installed which support saving password information.<br> -<b>LevelTwo: </b>The password information preference page is a centralized place for Workbench tools to save password information. Each tool registers and provides its own encryption algorithm. There are no tools installed that have registered with the password information preference page.<br> -<H3>RSEC2301</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to launch server on host %1.<br> -<b>LevelTwo: </b>Message from host: %2<br> -<H3>RSEC2302</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Invalid password or user ID for %1.<br> -<b>LevelTwo: </b>Message from host: %2<br> -<H3>RSEC2303</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Incompatible host server running on remote system %1.<br> -<b>LevelTwo: </b>The host server is not a Remote System Explorer server.<br> -<H3>RSEC2304</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Incompatible Remote System Explorer host server running on remote system %1.<br> -<b>LevelTwo: </b>The host server needs to be updated to work with the current client.<br> -<H3>RSEC2305</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to connect to REXEC host service on port %1 of host %2<br> -<b>LevelTwo: </b>Message from host: %3<br> -<H3>RSEC2306</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>Port %1 is normally used for the %2 service.<br> -<b>LevelTwo: </b><br> -<H3>RSEC2307</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>Unable to establish a secure connection with the Remote System Explorer host server.<br> -<b>LevelTwo: </b>Make sure both the client and server are configured to use SSL. The SSL handshake between client and server failed with the following exception: %1<br> -<H3>RSEC2308</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>The host server running on remote system %1 is an older version than the RSE client.<br> -<b>LevelTwo: </b>It is recommended that the client and server versions match.<br> -<H3>RSEC2309</H3> -<b>Severity: </b>Warning<br> -<b>LevelOne: </b>The host server running on remote system %1 is a newer version than the RSE client.<br> -<b>LevelTwo: </b>It is recommended that the client and server versions match.<br> -<H3>RSEC2310</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Starting Remote System Explorer host server using REXEC<br> -<b>LevelTwo: </b><br> -<H3>RSEC2311</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Starting Remote System Explorer host server using daemon<br> -<b>LevelTwo: </b><br> -<H3>RSEC2312</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connecting to Remote System Explorer host server on port %1<br> -<b>LevelTwo: </b><br> -<H3>RSEC2313</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Initializing Remote System Explorer host server<br> -<b>LevelTwo: </b><br> -<H3>RSEC2314</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Communication with the remote system %1 has been secured using SSL. Continue?<br> -<b>LevelTwo: </b><br> -<H3>RSEC2315</H3> -<b>Severity: </b>Information<br> -<b>LevelOne: </b>Connection %1 has not been secured using SSL. Proceed anyway?<br> -<b>LevelTwo: </b><br> -<H3>RSEC2316</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The specified server port is out of the allowed range: %1<br> -<b>LevelTwo: </b><br> -<H3>RSEC3001</H3> -<b>Severity: </b>Error<br> -<b>LevelOne: </b>The connection %1 is currently offline and cannot be connected.<br> -<b>LevelTwo: </b>You have performed an action which requires a live connection to the remote system. Switch the connection to online and perform the action again. To switch the connection online, right click on the connection %1 and deselect the Work Offline action.<br> -<br> -</BODY> -</HTML> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/modelAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/modelAPI.html deleted file mode 100755 index a6f2407d6..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/modelAPI.html +++ /dev/null @@ -1,23 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../book.css" TYPE="text/css"> -<title>RSE Model API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Model API</h1> -<p>The front door to accessing the elements of the RSE model is the <A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html">ISystemRegistry</A>, which is a -singleton object accessible via <A href="../../reference/api/org/eclipse/rse/core/model/SystemStartHere.html#getSystemRegistry()">SystemStartHere.getSystemRegistry()</A>. -</p> -<p>The system registry will get you access to profiles, connections and subsystem factories. -From a <A href="../../reference/api/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.html">subsystem configuration</A> you can access subsystems, filter pools, -user actions and compile commands. -From <A href="../../reference/api/org/eclipse/rse/core/subsystems/ISubSystem.html">ISubSystem</A> you can access remote resources, as well -as filter pools referenced by the subsystem. -</p> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/plugin/uiPluginAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/plugin/uiPluginAPI.html deleted file mode 100755 index 2d27c6cd9..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/plugin/uiPluginAPI.html +++ /dev/null @@ -1,80 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Base Plugin Class</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Base Plugin Class</h1> -<p>You may find it of value to base your own plugin class on the RSE-supplied base plugin class. -If so, there are some methods you are encouraged to create or override in your class. The benefits -of using this as your base class is the inherited methods you can access. -</p> -<h2>Methods required in your plugin subclass</h2> -<p>To use the RSE base plugin class -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html">org.eclipse.rse.ui.SystemBasePlugin</A></samp>, -you subclass it for your own plugin class, and supply some key static methods of your own: -</p> -<ul> -<li><samp>getDefault()</samp>. Return a singleton instance of your plugin. -<li><samp>getResourceBundle()</samp>. Return the resource bundle for your plugin. This is stored in -a static field, initialized in your constructor by calling the <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadResourceBundle(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadResourceBundle(...)</A></samp> inherited method. -<li><samp>getString(String key)</samp>. Return a translated string by calling the inherited method -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getString(java.util.ResourceBundle, java.lang.String)">getString(ResourceBundle rb, String key)</A></samp>, passing in the static resource bundle field. -<li><samp>getPluginMessageFile()</samp>. Return your RSE message file instance, initialized in your -constructor by calling <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadMessageFile(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadMessageFile(...)</A></samp>. -<li><samp>getPluginMessage(String msgID)</samp>. Return the -<samp><A href="../../../reference/api/org/eclipse/rse/services/clientserver/messages/SystemMessage.html">SystemMessage</A></samp> for the given ID, by -calling the inherited method -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getMessage(org.eclipse.rse.services.clientserver.messages.SystemMessageFile, java.lang.String)">getMessage(getPluginMessageFile(), msgId)</a></samp>. You will call this method often to get message objects. -</ul> -<p>You may also override some RSE-supplied instance methods: -<ul> -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#initializeImageRegistry()">initializeImageRegistry()</A></samp>. Call -<samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#putImageInRegistry(java.lang.String, java.lang.String)">putImageInRegistry(String id, String imageFileName)</A></samp> -to load each of your images. -</ul> -</p> -<p>Of course, there are the usual eclipse-supplied instance methods to override too: -<ul> -<li><samp>initializeDefaultPreferences()</samp>. Good place to call the <samp>initDefaults()</samp> method of your preference pages. Be sure to call <samp>super.initializeDefaultPreferences()</samp>. -<li><samp>startup()</samp>. Good place to register adapters and so forth. Be sure to call <samp>super.startup()</samp> at the beginning. -<li><samp>shutdown()</samp>. Good place to close any open communication layers. Be sure to call <samp>super.shutdown()</samp> at the end. -</ul> -</p> - -<h2>Methods inherited from the RSE base class</h2> -<p>The methods you get access to by using the RSE-supplied base plugin class include:</p> -<ul> -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getPluginId()">getPluginId()</A></samp>. Return this plugin's ID. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getActiveWorkbenchShell()">getActiveWorkbenchShell()</A></samp>. Return the shell of the active workbench window. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getActiveWorkbenchWindow()">getActiveWorkbenchWindow()</A></samp>. Return the active workbench window. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getWorkspaceRoot()">getWorkspaceRoot()</A></samp>. Return the root of the workspace. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getWorkspace()">getWorkspace()</A></samp>. Return the workspace root. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getInstallLocation()">getInstallLocation()</A></samp>. Return the install directory for this plugin. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getIconPath()">getIconPath()</A></samp>. Return the typical path for icons, relative to the plugin's folder: "icons/" -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#putImageInRegistry(java.lang.String, java.lang.String)">putImageInRegistry(String id, String fileName)</A></samp>. Load an image in the image registry, given the ID to retrieve it with, and its filename and path relative to this plugin's folder -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getImage(java.lang.String)">getImage(String id)</A></samp>. Return an Image given the ID with which it was registered in putImageInRegistry. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getImageDescriptor(java.lang.String)">getImageDescriptor(String id)</A></samp>. Return an ImageDescriptor given the ID with which it was registered in putImageInRegistry. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadResourceBundle(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadResourceBundle(IPluginDescriptor descriptor, String fileName)</A></samp>. Load a resource bundle, given its file name, relative to the given plugin's installation folder. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadResourceBundle(java.lang.String)">loadResourceBundle(String fileName)</A></samp>. Load a resource bundle, given its file name, relative to this plugin's installation folder. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getString(java.util.ResourceBundle, java.lang.String)">getString(ResourceBundle rb, String id)</A></samp>. Return a translated string from a resource bundle, given its key ID. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getString(java.util.ResourceBundle, java.lang.String, java.lang.String)">getString(ResourceBundle rb, String id, String default)</A></samp>. Return a translated string from a resource bundle, given its key ID. If key not found in the resource bundle, returns the given default string. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#loadMessageFile(org.eclipse.core.runtime.IPluginDescriptor, java.lang.String)">loadMessageFile(IPluginDescriptor descriptor,String fileName)</A></samp>. Parse an RSE-style message file into memory, given the plugin and message file name. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getMessage(org.eclipse.rse.services.clientserver.messages.SystemMessageFile, java.lang.String)">getMessage(SystemMessageFile msgFile, String msgId)</A></samp>. Retrieve a SystemMessage object, given the message file that contains it, and its message ID including component and subcomponent abbreviations. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#scanForDuplicateMessages(org.eclipse.rse.services.clientserver.messages.SystemMessageFile)">scanForDuplicateMessages(SystemMessageFile msgFile)</A></samp>. Scan given message file for duplicate IDs. Typically only called during the development cycle. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#printMessages(org.eclipse.rse.services.clientserver.messages.SystemMessageFile, java.lang.String)">printMessages(SystemMessageFile msgFile, String fullyQualifiedTargetFile)</A></samp>. Generate an HTML file documenting the messages in the given message file, given the fully qualified name of the target HTML file. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#showProgrammerErrorMessage(java.lang.String)">showProgrammerErrorMessage(String msg)</A></samp>. Show a message to the user, when the message file support is not available. -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#logInfo(java.lang.String)">logInfo(String message)</A></samp>. Log an informational message to the RSE's core log file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#logWarning(java.lang.String)">logWarning(String message)</A></samp>. Log a warning message to the RSE's core log file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#logError(java.lang.String)">logError(String message)</A></samp>. Log an error message to the RSE's core log file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#logError(java.lang.String, java.lang.Throwable)">logError(String message, Throwable exception)</A></samp>. Log an error message resulting from an exception to the RSE's core log file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#logDebugMessage(java.lang.String, java.lang.String)">logDebugMessage(String prefix, String message)</A></samp>. Log a debug (trace) message to the RSE's core log file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -<li><samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemBasePlugin.html#getLogger()">getLogger()</A></samp>.Return the Logger instance for the RSE default logging file (<samp>.....\.metadata\.plugins\org.eclipse.rse.core\.log</samp>). -</ul> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_checkBox.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_checkBox.gif Binary files differdeleted file mode 100755 index 19d23df68..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_checkBox.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_comboBox.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_comboBox.gif Binary files differdeleted file mode 100755 index 853d0082a..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_comboBox.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_keyValue.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_keyValue.gif Binary files differdeleted file mode 100755 index 26caa8048..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_keyValue.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_string.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_string.gif Binary files differdeleted file mode 100755 index f43c0681f..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/fldEditor_string.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/rsePreferences.gif b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/rsePreferences.gif Binary files differdeleted file mode 100755 index cc58177fb..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/rsePreferences.gif +++ /dev/null diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/uiPreferencesAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/uiPreferencesAPI.html deleted file mode 100755 index 9df581818..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/preferences/uiPreferencesAPI.html +++ /dev/null @@ -1,53 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Preferences API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Preferences API</h1> - -<h2>RSE Preference Pages Category</h2> -<p>All Remote System Explorer preference pages are rooted within the -preferences category <samp>org.eclipse.rse.ui.preferences.RemoteSystemsPreferencePage</samp>, -as shown here:</p> -<P><IMG border="0" src="rsePreferences.gif"></P> - -<h2>RSE Preference Pages Classes</h2> -<p>There is no RSE-supplied base class for preference pages, but we recommend -you extend <samp>FieldEditorPreferencePage</samp> in package <samp>org.eclipse.jface.preference</samp>. -This JFace class allows you to create a preferences page as a sequence of "field -editors" which know how to initialize, load and store their values from their preferences store. -</p> -<p>We also suggest the following when designing your preference pages: -<ol> -<li>A interface for your preferences constants. It should store two constants per preference: the preference store key, and its default value. -<li>Static getter and setter methods in your preference page classes, one per preference, to query or update the preference value in the preferences store. -<li>An <samp>initDefaults(IPreferenceStore store)</samp> method per preferences class, that initializes the preference store value of each preference on that page. -<li>In your plugin class, an override of the <samp>initializeDefaultPreferences(IPreferenceStore store)</samp> method, so it calls your -<samp>initDefaults(store)</samp> method for each preference page class. -</ol> -<p>Should you need to query, or update, any RSE preferences you can do so via -the getters and setters in <samp>org.eclipse.rse.core.SystemPreferencesManager</samp>. -</p> -<p>The RSE supplies a few field editors, complementing what JFace supplies -in <samp>org.eclipse.jface.preference</samp>. The RSE-supplied field editors, and the -RSE-supplied preferences pages, are all found in package <samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/package-summary.html">org.eclipse.rse.ui.propertypages</A></samp>: -</p> -<ul> -<li><b><samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemBooleanFieldEditor.html">SystemBooleanFieldEditor</A></samp></b>. Extends <samp>BooleanFieldEditor</samp> to add support for tooltip text. -<p><IMG border="0" src="fldEditor_checkBox.gif"></p> -<li><b><samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemComboBoxFieldEditor.html">SystemComboBoxFieldEditor</A></samp></b>. Shows a combo box allowing the user to choose from a finite list of discrete possibilities. -<p><IMG border="0" src="fldEditor_comboBox.gif"></p> -<li><b><samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemKeyValueFieldEditor.html">SystemKeyValueFieldEditor</A></samp></b>. Shows a list of hard-coded keys, each of which supports a user-specifiable value. -<p><IMG border="0" src="fldEditor_keyValue.gif"></p> -<li><b><samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemStringFieldEditor.html">SystemStringFieldEditor</A></samp></b>. For simple string preferences. Unlike the JFace string editor, this supports tooltip text and RSE validators and massagers on the typed text. -<p><IMG border="0" src="fldEditor_string.gif"></p> -</ul> -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/properties/uiPropertiesAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/properties/uiPropertiesAPI.html deleted file mode 100755 index b5dae9e86..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/properties/uiPropertiesAPI.html +++ /dev/null @@ -1,74 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Properties API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Properties API</h1> -<p>You can supply your own property pages to any node in the Remote Systems tree or table views. -As you author your property page classes, you may find the RSE-supplied base class for property pages -of value. - -<h2>RSE-Supplied Base Class for Property Pages</h2> -<p>The RSE supplies a base class for property pages, -<samp><A href="../../../reference/api/org/eclipse/rse/ui/propertypages/SystemBasePropertyPage.html">org.eclipse.rse.ui.propertypages.SystemBasePropertyPage</A></samp>, -that extends the base eclipse property page <samp>org.eclipse.ui.dialogs.PropertyPage</samp>. The advantages -of using this RSE-supplied class are: -</p> -<ul> -<li>Supports <samp><a href="../messages/uiMessageAPI.html">SystemMessage</A></samp> error messages, allowing the user to click on a message to see its details. -<li>Supports automatic assignment of mnemonics for input-capable fields. -<li>Supports automatic management of the "isValid" property based on current error message status in the message line. This -property is important to set correct, so eclipse knows when to prevent the user from switching focus to other property pages. -</ul> - - -<h2>Property Pages for RSE Non-Remote Resources</h2> -<p>You can simply use the eclipse-supplied extension point <samp>org.eclipse.ui.propertyPages</samp> to -contribute property pages to any of the non-remote artifacts from the RSE model. To use this extension -point, you need to know the class or, preferably, interface that the objects implement, which we describe here: -</p> - -<TABLE border="1" width="100%"> - <TBODY> - <TR> - <TH>RSE Resource</TH> - <TH>Implements Interface</TH> - </TR> - <TR> - <TD>Profile</TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/core/model/ISystemProfile.html">org.eclipse.rse.core.model.ISystemProfile</A></samp></TD> - </TR> - <TR> - <TD>Host</TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/core/model/IHost.html">org.eclipse.rse.core.model.IHost</A></samp></TD> - </TR> - <TR> - <TD>Subsystem</TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/core/subsystems/ISubSystem.html">org.eclipse.rse.core.subsystems.ISubSystem</A></samp></TD> - </TR> - <TR> - <TD>Filter pool reference</TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/core/filters/ISystemFilterPoolReference.html">org.eclipse.rse.core.filters.ISystemFilterPoolReference</A></samp></TD> - </TR> - <TR> - <TD>Filter reference</TD> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/core/filters/ISystemFilterReference.html">org.eclipse.rse.core.filters.ISystemFilterReference</A></samp></TD> - </TR> - </TBODY> -</TABLE> -<h2>Property Pages for RSE Remote Resources</h2> -<p>See <a href="../../../guide/plugin/propertypage.html">Plugging In Property Pages</a> -for information on how to contribute property pages for remote resources. -Because remote resources have no underlying eclipse resource, and typically all are instances of the same class, -Eclipse Filtering capabilities are used to allow very explicit scoping of the property page to very specific types of remote resources. -</p> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/resourceAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/resourceAPI.html deleted file mode 100755 index d5043eb7e..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/resourceAPI.html +++ /dev/null @@ -1,33 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../book.css" TYPE="text/css"> -<title>RSE Remote Resource API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Remote Resource API</h1> -<p>RSE supplies subsystems for accessing the file system and for executing commands, for -all system types ("universally"). -</p> -<p> -To programmatically access the files in a remote system -identified by a particular system connection, use the -<A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html">system registry</A> to get to the -<A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html#getSubSystemsBySubSystemConfigurationCategory(String, org.eclipse.rse.core.model.IHost)">file subsystem</A> -for that connection, by passing in the file category as a String. This <A href="../../reference/api/org/eclipse/rse/subsystems/files/core/subsystems/IRemoteFileSubSystem.html">file subsystem</A> offers methods for accessing the remote files. -</p> -<p> -Similarly, to programmatically run commands in a remote system -identified by a particular system connection, use the -<A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html">system registry</A> to get to the -<A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html#getSubSystemsBySubSystemConfigurationCategory(String, org.eclipse.rse.core.model.IHost)">command subsystem</A> -for that connection, by passing in the command category as a String. This <A href="../../reference/api/org/eclipse/rse/subsystems/shells/core/subsystems/IRemoteCmdSubSystem.html">command subsystem</A> offers methods for running remote commands, -either in a new command shell or an existing command shell. You can also set environment variables -using this subsytem object. -</p> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/uiAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/uiAPI.html deleted file mode 100755 index 42e409da3..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/uiAPI.html +++ /dev/null @@ -1,129 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../book.css" TYPE="text/css"> -<title>RSE User Interface API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE User Interface API</h1> -<p>The RSE provides a number of classes that can help with programming productivity when authoring -user interface artifacts, such as actions, dialogs, wizards, property pages and preferences pages. -Further, a common requirement in all of these artifacts is the need to display translated messages -to the user. The RSE supplies a framework for defining and displaying rich messages that have second -level help, severity and ID attributes. -</p> -<p> -In the following sections we introduce the support offered by the RSE for these UI constructs. -<h2>Plugin Class</h2> -<p>The RSE supplies a base plugin class <samp><a href="plugin/uiPluginAPI.html">SystemBasePlugin</a></samp> that offers -some advantages over the base eclipse <samp>AbstractUIPlugin</samp> class: -<ol> -<li>Simplified methods for registering images, and support for retrieving them either as an image -or an image descriptor. -<li>Support for <a href="logger/uiLoggerAPI.html">logging</a> error, warning and information messages, using the RSE logging framework. -<li>Support for loading a resource bundle, and easily retrieving translated strings from it. -<li>Support for loading an RSE <a href="messages/uiMessageFile.html">message file</a>, and easily retrieving translated messages from it. -<li>Helper methods for getting the active workbench window and shell. -</ol> -</p> -<p>To use the base plugin class effectively, you must subclass it and supply some critical -methods of your own. -</p> - -<h2>Messages</h2> -<p>The Java property file for messages is not very rich, as it offers only the ability to define a -single message string. Throughout the RSE perspective you will notice that the messages are richer -than this. They contain second level help, severity, and ID and more. Further, there is a unique -error message dialog for displaying messages, with their second level help, and specialized support -in the RSE dialog, wizard and property page classes for displaying messages on a message line. These -messages can be selected by the user, to bring up the specialized message dialog displaying the -additional properties of the message. Further, there is support for logging severe errors to a log -file, enabling better service support. -</p> -<p> -Your own plugins can enjoy this rich message support too, even independently of using the rest of -the RSE for remote resource access. This support involves defining an xml -<a href="messages/uiMessageFile.html">message file</a>, which defines -the messages, and using a set of -<a href="messages/uiMessageAPI.html">supplied classes</a> to work with the messages. -</p> -<p>Before defining your own messages, you may wish to peruse the list of <a href="messages/uiMessagesCore.html">RSE-supplied messages</a> that are -already defined. The key benefit to using an existing message is translation, as these are already -translated into many languages. -</p> - -<h2>Preference Pages</h2> -<p>When defining your own <a href="preferences/uiPreferencesAPI.html">preferences pages</a>, -you may want to place your preference pages within the Remote Systems preference page category. -As you author your preference page classes, you may find some of the RSE-supplied classes for -preference pages to be useful. -</p> - -<h2>Property Pages</h2> -<p>Property pages can appear in the Properties dialog of any object in eclipse. This dialog is available by selecting -"Properties" from the pop-up menu for the object. The RSE supports defining your own -<a href="properties/uiPropertiesAPI.html">property pages</a> for the resources in its model, although there is a -distinction between local and remote resources. -</p> - -<h2>Validators</h2> -<p>Validating user-entered text is a common and tedious task in any GUI programming. Using validators to encapsulate -the error checking for a particular type of data is a highly recommended practice. The -<a href="validators/uiValidatorsAPI.html">RSE validator</a> support is very -helpful for this, offering both a common interface for all manner of validators and a large list of pre-supplied -validators. -</p> - -<h2>Massagers</h2> -<p>While validating user-entered text is common, so is affecting user-entered text prior to saving it. For example, folding it -to upper or lower case. The <a href="massagers/uiMassagersAPI.html">RSE massager</a> support encapsulates this concept, and -supplies a few re-usable massagers for you. -</p> - -<h2>Widgets</h2> -<p>Populating preference pages, property pages, dialogs and wizards requires use of SWT widget programming. The RSE -<a href="widgets/uiWidgetsAPI.html">widget support</a> can help, with helper methods and classes, and re-usable widgets you may -find useful. -</p> - -<h2>Dialogs</h2> -<p>The RSE supplies rich support for <a href="dialogs/uiDialogsAPI.html">dialogs</a>, including a powerful base class -and, re-usable pre-built dialogs. -</p> - -<h2>Wizards</h2> -<p>Wizards are a common building block of an eclipse GUI. Typically, a wizard is used to prompt for information to create -something new, while a dialog is used to prompt for information for other purposes. -The RSE <a href="wizards/uiWizardsAPI.html">wizard support</a> includes base classes that can simplify the task of creating wizards. -</p> - -<h2>Actions</h2> -<p>Populating popup and pulldown menu items requires the creation of actions. These actions typically popup dialogs or wizards, -and need to be able to pass selections and inputs from the action to the dialog or wizard, and get outputs back. The RSE -<a href="actions/uiActionsAPI.html">action support</a> can significantly help with this programming task, especially when used -together with the RSE dialog and wizard support. -</p> - -<p>Often we want to refresh the contents of the Remote Systems view or Table view from within our actions, to visualize -changes to the selected resources. To do this, use the -<samp><A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html#fireRemoteResourceChangeEvent(int, java.lang.Object, java.lang.Object, org.eclipse.rse.core.subsystems.ISubSystem, java.lang.String)">method</a></samp>. -To get the system registry, use the -<samp><A href="../../reference/api/org/eclipse/rse/core/model/SystemStartHere.html#getSystemRegistry()">method</a></samp>. -</p> - -<p>At times, you may want to post events in a dispatch thread rather than using the -original client's thread; or you may need access to the System Clipboard. -Such operations are only possible when the UI -is loaded, and therefore you need to use -<samp><A href="../../reference/api/org/eclipse/rse/core/model/ISystemRegistry.html#fireRemoteResourceChangeEvent(int, java.lang.Object, java.lang.Object, org.eclipse.rse.core.subsystems.ISubSystem, java.lang.String, java.lang.Object)">ISystemRegistry.fireEvent()</a></samp> -method in that case. To get the system registry UI interface, use the -<samp><A href="../../reference/api/org/eclipse/rse/ui/RSEUIPlugin.html#getTheSystemRegistryUI()">RSEUIPlugin.getTheSystemRegistryUI()</a></samp> -method. -</p> - -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/uiValidatorsAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/uiValidatorsAPI.html deleted file mode 100755 index 6894a0a58..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/uiValidatorsAPI.html +++ /dev/null @@ -1,226 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Validators API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Validators API</h1> -<p>Throughout an eclipse UI there are times when we need to validate what the user has typed in. Validators -offer a way to encapsulate the error checking for a particular domain, so it can be re-used wherever the user -is prompted for this. This includes dialogs, property pages, preference pages, wizard pages and viewer -cells. Eclipse's JFace offers two interfaces for this, one for viewer cells and one for the rest. In RSE, -there is a single interface combining the requirements of both, so you can author a single validator that is -re-usable anywhere. Further, the RSE validator interface and sub-interfaces force additional information to be -supplied to enhance re-use, such as the maximum length, which can be used to set the text limit for a text field. -</p> - -<h2>RSE Validator Interfaces</h2> -<p>All RSE validator interfaces and classes are in package <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/package-summary.html">org.eclipse.rse.ui.validators</A></samp>. - -<h3>ISystemValidator Interface</h3> -<p>The primary validator interface is <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html">ISystemValidator</A></samp>, which is extends <samp>org.eclipse.jface.dialogs.IInputValidator</samp> -and <samp>org.eclipse.jface.viewers.ICellEditorValidator</samp>. Both parent interfaces define an <samp>isValid</samp> method, -but the former takes a String while the latter takes an Object. They both return a String which is the error message if an -error was detected, or null if no error detected. The <samp>ISystemValidator</samp> interface adds the following additional methods: -</p> - -<TABLE border="1"> - <TBODY> - <TR> - <TH>Method</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp>public int <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#getMaximumNameLength()">getMaximumNameLength()</A></samp></TD> - <TD>Returns the maximum length allowed for this text. Can be used to set text limit of text widgets.</TD> - </TR> - <TR> - <TD><samp>public SystemMessage <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#getSystemMessage()">getSystemMessage()</A></samp></TD> - <TD>If <samp>isValid</samp> returns false, this returns a <samp>SystemMessage</samp> object that offers richer message support than just a string. - Return null if you don't support <samp><A href="../messages/uiMessageAPI.html">SystemMessages</A></samp>. - Callers don't need to use this if they use <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#validate(java.lang.String)">validate(String)</A></samp> instead of <samp>isValid(String)</samp>.</TD> - </TR> - <TR> - <TD><samp>public SystemMessage <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#validate(java.lang.String)">validate(String text)</A></samp></TD> - <TD>An alternative to <samp>isValid</samp> if your validator does support <samp>SystemMessage</samp> objects versus simple strings for error messages.</TD> - </TR> - </TBODY> -</TABLE> - -<h3>ISystemValidatorUniqueString Interface</h3> -<p>Often our validation requires checking that the given text is unique, in some given list of existing things, like names say. To facilitate -this, there is an interface <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidatorUniqueString.html">ISystemValidatorUniqueString</A></samp>, which extends <samp>ISystemValidator</samp> and adds some additional -methods required for uniqueness validation: -</p> - -<TABLE border="1"> - <TBODY> - <TR> - <TH>Method</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp>public void <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidatorUniqueString.html#setCaseSensitive(boolean)">setCaseSensitive(boolean caseSensitive)</A></samp></TD> - <TD>Specifies whether the test for an existing string should consider case or not.</TD> - </TR> - <TR> - <TD><samp>public void <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidatorUniqueString.html#setExistingNamesList(java.lang.String[])">setExistingNamesList(String[] existingList)</A></samp></TD> - <TD>Sets the existing list to test against, as an array.</TD> - </TR> - <TR> - <TD><samp>public void <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidatorUniqueString.html#setExistingNamesList(java.util.Vector)">setExistingNamesList(Vector existingList)</A></samp></TD> - <TD>Sets the existing list to test against, as a vector of Strings.</TD> - </TR> - <TR> - <TD><samp>public String[] <A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidatorUniqueString.html#getExistingNamesList()">getExistingNamesList()</A></samp></TD> - <TD>Returns the existing list that is used to test against.</TD> - </TR> - </TBODY> -</TABLE> -<p>If you desire to create a unique string validator, you probably will start by subclassing <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUniqueString.html">ValidatorUniqueString</A></samp>. -</p> - -<h3>IValidatorRemoteSelection Interface</h3> -<p>The third validator interface is <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/IValidatorRemoteSelection.html">IValidatorRemoteSelection</A></samp>, which is specifically intended to be used -in the remote resource selection dialogs supplied by the RSE. It allows you to decide when to enable the OK button, based on what -is selected. It contains only the following method:</p> -<samp>public SystemMessage <A href="../../../reference/api/org/eclipse/rse/ui/validators/IValidatorRemoteSelection.html#isValid(org.eclipse.rse.core.model.IHost, java.lang.Object[], org.eclipse.rse.ui.view.ISystemRemoteElementAdapter[])">isValid(SystemConnection selectedConnection, Object[] selectedObjects, ISystemRemoteElementAdapter[] remoteAdaptersForSelectedObject)</A>;</samp> -<p>You typically won't implement this interface directly, but rather sublcass <samp>ValidatorRemoteSelection</samp>.</p> - -<h3>Validator Samples</h3> -<ul> -<li><A href="validatorSample1.html">Sample 1</A></li> -<li><A href="validatorSample2.html">Sample 2</A></li> -<li><A href="validatorSample3.html">Sample 3</A></li> -<li><A href="validatorSample4.html">Sample 4</A></li> -</ul> - -<h2>RSE-Supplied Validators</h2> -<p>You may be able to avoid creating a new validator if you find that RSE has already supplied one you need. Or, you may find it -appropriate to simply subclass one of these RSE-supplied validators. All of them are designed to be either used as-is, or configured -via setter calls, or subclassed, whichever is most convenient.</p> -<p>All of these validators support rich <samp><A href="../messages/uiMessageAPI.html">SystemMessage</A></samp> objects, versus just simple strings for the error message. When used with the -RSE dialog, property page or wizard page classes, you should call -<samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#validate(java.lang.String)">validate(String)</A></samp> and call -<samp><A href="../../../reference/api/org/eclipse/rse/ui/messages/ISystemMessageLine.html#setErrorMessage(org.eclipse.rse.ui.messages.SystemMessage)">setErrorMessage</A></samp> with the result. When used -in other places you should use <samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ISystemValidator.html#isValid(java.lang.String)">isValid(String)</A></samp> as it returns just the first-level text of the system message.</p> -<TABLE border="1"> - <TBODY> - <TR> - <TH>Validator Class</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorCompileCommandLabel.html">ValidatorCompileCommandLabel</A></samp></TD> - <TD>Validates the label for a compile command in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorConnectionName.html">ValidatorConnectionName</A></samp></TD> - <TD>Validates the name of a connection in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorFileName.html">ValidatorFileName</A></samp></TD> - <TD>Validates the name of a file in eclipse.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorFilterName.html">ValidatorFilterName</A></samp></TD> - <TD>Validates the name of a filter in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorFilterPoolName.html">ValidatorFilterPoolName</A></samp></TD> - <TD>Validates the name of a filter pool in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorFilterString.html">ValidatorFilterString</A></samp></TD> - <TD>Validates the contents of a filter string in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorFolderName.html">ValidatorFolderName</A></samp></TD> - <TD>Validates the name of a folder in eclipse.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorIntegerInput.html">ValidatorIntegerInput</A></samp></TD> - <TD>Validates the given string is a valid integer.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorIntegerRangeInput.html">ValidatorIntegerRangeInput</A></samp></TD> - <TD>Validates the given string is a valid integer within a given range.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorLongInput.html">ValidatorLongInput</A></samp></TD> - <TD>Validates the given string is a valid long integer.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorLongRangeInput.html">ValidatorLongRangeInput</A></samp></TD> - <TD>Validates the given string is a valid long integer within a given range.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorPathName.html">ValidatorPathName</A></samp></TD> - <TD>Validates the given string is a valid folder path in eclipse.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorPortInput.html">ValidatorPortInput</A></samp></TD> - <TD>Validates the given string is a valid TCP/IP port number.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorProfileName.html">ValidatorProfileName</A></samp></TD> - <TD>Validates the name of a system profile in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorRemoteSelection.html">ValidatorRemoteSelection</A></samp></TD> - <TD>This is a very special case abstract base class, for validators that decide the enablement of the OK button - in the RSE-supplied remote resource selection dialogs.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorSourceType.html">ValidatorSourceType</A></samp></TD> - <TD>A validator for source types, such as a file type or "*.java". It is intended to be subclassed.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorSpecialChar.html">ValidatorSpecialChar</A></samp></TD> - <TD>A base class for validators that need to ensure the given string doesn't contain certain characters.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorSystemName.html">ValidatorSystemName</A></samp></TD> - <TD>A name validator, to be used when the name being prompted for must follow Java identifier rules.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUniqueString.html">ValidatorUniqueString</A></samp></TD> - <TD>A base class, or configurable class, to be used for any validation that requires the string to be unique within a given list.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserActionCommand.html">ValidatorUserActionCommand</A></samp></TD> - <TD>Validates the command of a user defined action in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserActionComment.html">ValidatorUserActionComment</A></samp></TD> - <TD>Validates the comment of a user defined action in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserActionName.html">ValidatorUserActionName</A></samp></TD> - <TD>Validates the name of a user defined action in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserId.html">ValidatorUserId</A></samp></TD> - <TD>Validates a user ID. Does only basic checking, intended to be subclassed.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserTypeName.html">ValidatorUserTypeName</A></samp></TD> - <TD>Validates the name of a named type in the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/validators/ValidatorUserTypeTypes.html">ValidatorUserTypeTypes</A></samp></TD> - <TD>Validates the type list of a named type in the RSE.</TD> - </TR> - </TBODY> -</TABLE> - - - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample1.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample1.html deleted file mode 100755 index b323525fb..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample1.html +++ /dev/null @@ -1,97 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Validator Sample One</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Validator Sample One</h1> -<p>This is an example of a validator written from scratch, that just validates a customer name field is not empty. -Note that while that is all is does today, the power of encapsulation is that we can easily add additional error -checking in the future, and all dialogs or wizards that use the validator will pick up that change. -<pre> - -package org.eclipse.rse.samples.ui.frameworks.dialogs; -import org.eclipse.rse.samples.*; -import org.eclipse.rse.ui.messages.SystemMessage; -import org.eclipse.rse.ui.validators.ISystemValidator; - -/** - * <I>A validator for a customer name. We simply ensure it is not empty, but this could easily be expanded.</I> - */ -public class <B>SampleNameValidator</B> implements ISystemValidator -{ - private SystemMessage currentMsg; - private SystemMessage emptyMsg; - - /** - * <I>Constructor for SampleNameValidator.</I> - */ - public <B>SampleNameValidator</B>() - { - super(); - emptyMsg = SamplesPlugin.<A - href="../messages/uiMessageAPI.html#getPluginMessage">getPluginMessage</A>(<A - href="../messages/sampleMessageFile.html#SPPD1000">"SPPD1000"</A>); - } - - /** - * <I>Required ISystemValidator interface method.</I> - * <I>Return the maximum length for customer names. We return 100.</I> - */ - public int <B>getMaximumNameLength</B>() - { - return 100; - } - - /** - * <I>Required ISystemValidator interface method.</I> - * <I>@see org.eclipse.rse.ui.validators.ISystemValidator#getSystemMessage()</I> - */ - public SystemMessage <B>getSystemMessage</B>() - { - return currentMsg; - } - - /** - * <I>Required ISystemValidator interface method.</I> - * <I>@see org.eclipse.rse.ui.validators.ISystemValidator#validate(String)</I> - */ - public SystemMessage <B>validate</B>(String text) - { - isValid(text); - return currentMsg; - } - /** - * <I>@see org.eclipse.jface.dialogs.IInputValidator#isValid(String)</I> - */ - public String <B>isValid</B>(String newText) - { - if ((newText==null) || (newText.length()==0)) - currentMsg = emptyMsg; - // todo: more error checking - - if (currentMsg != null) - return currentMsg.getLevelOneText(); - else - return null; - } - /** - * <I>@see org.eclipse.jface.viewers.ICellEditorValidator#isValid(Object)</I> - */ - public String <B>isValid</B>(Object value) - { - if (value instanceof String) - return isValid((String)value); - return null; - } -} -</pre> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample2.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample2.html deleted file mode 100755 index 5b2d63fe4..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample2.html +++ /dev/null @@ -1,45 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Validator Sample Two</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Validator Sample Two</h1> -<p>This is an example of a validator written by extending an existing RSE-supplied validator, and -simply supplying unique messages. -<pre> - -package org.eclipse.rse.samples.ui.frameworks.dialogs; -import org.eclipse.rse.ui.validators.ValidatorIntegerRangeInput; -import org.eclipse.rse.samples.*; - -/** - * <I>An example of a customized validator, that prompts for a birth year.</I> - */ -public class <B>SampleBirthYearValidator</B> extends ValidatorIntegerRangeInput -{ - /** - * <I>Constructor. Specifies the valid range, and unique error messages.</I> - */ - public SampleBirthYearValidator() - { - super(1900, 2003); - super.setErrorMessages(SamplesPlugin.<A - href="../messages/uiMessageAPI.html#getPluginMessage">getPluginMessage</A>("<A - href="../messages/sampleMessageFile.html#SPPD1001">SPPD1001</A>"), // <I>empty</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1002">SPPD1002</A>"), // <I>non-numeric</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1003">SPPD1003</A>")); // <I>out of range</I> - } - -}</pre> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample3.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample3.html deleted file mode 100755 index 551b14350..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample3.html +++ /dev/null @@ -1,43 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Validator Sample Three</title></head> - -<body bgcolor="#ffffff"> -<h1>RSE Validator Sample Three</h1> -<p>This is an example of a validator written by extending an existing RSE-supplied validator, and -simply supplying unique messages. -<pre> -package org.eclipse.rse.samples.ui.frameworks.dialogs; -import org.eclipse.rse.ui.validators.ValidatorIntegerRangeInput; -import org.eclipse.rse.samples.*; - -/** - * <I>An example of a customized validator, that prompts for a birth month.</I> - */ -public class <B>SampleBirthMonthValidator</B> extends ValidatorIntegerRangeInput -{ - /** - * <I>Constructor. Specifies the valid range, and unique error messages.</I> - */ - public SampleBirthMonthValidator() - { - super(1, 12); - super.setErrorMessages(SamplesPlugin.<A - href="../messages/uiMessageAPI.html#getPluginMessage">getPluginMessage</A>("<A - href="../messages/sampleMessageFile.html#SPPD1004">SPPD1004</A>"), // <I>empty</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1005">SPPD1005</A>"), // <I>non-numeric</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1006">SPPD1006</A>")); // <I>out of range</I> - } - -}</pre> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample4.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample4.html deleted file mode 100755 index 23fdb97f2..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/validators/validatorSample4.html +++ /dev/null @@ -1,44 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Validator Sample Four</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Validator Sample Four</h1> -<p>This is an example of a validator written by extending an existing RSE-supplied validator, and -simply supplying unique messages. -<pre> -package org.eclipse.rse.samples.ui.frameworks.dialogs; -import org.eclipse.rse.core.ui.validators.ValidatorIntegerRangeInput; -import org.eclipse.rse.samples.*; - -/** - * <I>An example of a customized validator, that prompts for a birth day.</I> - */ -public class <B>SampleBirthDayValidator</B> extends ValidatorIntegerRangeInput -{ - /** - * <I>Constructor. Specifies the valid range, and unique error messages</I>. - */ - public SampleBirthDayValidator() - { - super(1, 31); - super.setErrorMessages(SamplesPlugin.<A - href="../messages/uiMessageAPI.html#getPluginMessage">getPluginMessage</A>("<A - href="../messages/sampleMessageFile.html#SPPD1007">SPPD1007</A>"), // <I>empty</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1008">SPPD1008</A>"), // <I>non-numeric</I> - SamplesPlugin.getPluginMessage("<A - href="../messages/sampleMessageFile.html#SPPD1009">SPPD1009</A>")); // <I>out of range</I> - } - -}</pre> - -<P><BR></P> -</body> -</html> diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/widgets/uiWidgetsAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/widgets/uiWidgetsAPI.html deleted file mode 100755 index 39f1366ed..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/widgets/uiWidgetsAPI.html +++ /dev/null @@ -1,73 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Widgets API</title> -</head> - -<body bgcolor="#ffffff"> - -<h1>RSE Widgets API</h1> -<p>Whether coding dialogs, property pages, preference pages or wizard pages we need to write the code to display -and process the widgets in the client area. The RSE offers some help in this area in two ways: -</p> -<ol> -<li>A <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemWidgetHelpers.html">SystemWidgetHelpers</A></samp> -class full of static methods to make it easier to create SWT widgets. -<li>A few re-usable widgets that extend SWT. -</ol> - -<h2>SystemWidgetHelpers Class</h2> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/SystemWidgetHelpers.html">SystemWidgetHelpers</A></samp> -class in <samp><A href="../../../reference/api/org/eclipse/rse/ui/package-summary.html">org.eclipse.rse.ui</A></samp> -is chock full of static methods to simplify the work in populating a GridLayout composite with widgets. The GridLayout composite is the most -flexible and useful of the layouts, yet the most work to code to. These methods will help with that. The methods include: -</p> -<ul> -<li>Methods for creating a GridLayout composite. You typically call this at the start of your code that populates the client area. -<li>Methods for creating all the common SWT controls, with the GridData values specified for you. -<li>Methods for creating readonly flavours of input controls, such as a Text field or Combo box. -<li>Methods for creating labeled entry fields that have a prompting label in front of an input widget. -<li>Methods for automatically assigning unique mnemonics to all input widgets on a given composite or page. -<li>Methods for setting composite, widget, action and menu item contextual help. -<li>Methods for creating RSE-supplied widgets. -<li>Methods for creating populated combo boxes for connections, remote folders, system types and host names. -</ul> - -<h2>RSE-Supplied Widgets</h2> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/widgets/package-summary.html">org.eclipse.rse.ui.widgets</A></samp> -package contains some specialized widgets you may find a use for: -</p> -<TABLE border="1"> - <TBODY> - <TR> - <TH>Widget Class</TH> - <TH>Description</TH> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/widgets/SystemHistoryCombo.html">SystemHistoryCombo</A></samp></TD> - <TD>A entry field that remembers its previous values and shows them in a dropdown so the user can easily re-select a previously typed value. The history is maintained for you, and is indexed by a key. This allows the combos to share history across numerous dialogs, property pages or wizard pages. The history can be bounded and pre-filled, and the user can clear the history at any time. This handy widget is used extensively within the RSE.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/widgets/InheritableEntryField.html">InheritableEntryField</A></samp></TD> - <TD>An entry field with an left-right arrow beside it. When toggled left, the entry field is not editable and displays a supplied value. When toggled right, the entry field is editable. Useful in cases where the user can choose between an inherited or default value, or enter their own value.</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/widgets/SystemPortPrompt.html">SystemPortPrompt</A></samp></TD> - <TD>Uses the InheritableEntryField to prompt for a TCP/IP port, where toggling to the left means port 0, or let the "first available port".</TD> - </TR> - <TR> - <TD><samp><A href="../../../reference/api/org/eclipse/rse/ui/widgets/SystemHostCombo.html">SystemHostCombo</A></samp></TD> - <TD>This is a combo box that displays the currently defined RSE system connections. The list can be subset by system type or types. Further, you can optionally display a New button beside the combo that allows the user to create a new connection.</TD> - </TR> - </TBODY> -</TABLE> -<p>There are also many useful widgets related to the selection of remote files or folders, in package -<samp><A href="../../../reference/api/org/eclipse/rse/files/ui/widgets/package-summary.html">org.eclipse.rse.files.ui.widgets</A></samp> - -<P><BR></P> -</body> -</html>
\ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/api/wizards/uiWizardsAPI.html b/rse/doc/org.eclipse.rse.doc.isv/guide/api/wizards/uiWizardsAPI.html deleted file mode 100755 index 89adf7765..000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/api/wizards/uiWizardsAPI.html +++ /dev/null @@ -1,74 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> - -<head> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> -<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > -<LINK REL="STYLESHEET" HREF="../../../book.css" TYPE="text/css"> -<title>RSE Wizards API</title> -</head> - -<body bgcolor="#ffffff"> -<h1>RSE Wizards API</h1> -<p>Typically in eclipse GUI design we use a wizard to create new things, and a dialog -to prompt for secondary information, or update existing things. The Remote System Explorer -can offer help in creating wizards, just as it does in creating dialogs. -</p> - -<h2>RSE-Supplied Base Classes for Wizards</h2> -<p>The RSE offers the following classes, in package -<samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/package-summary.html">org.eclipse.rse.ui.wizards</A></samp> to simplify the creation of wizards.</p> - -<h3>The <samp>AbstractSystemWizardPage</samp> class</h3> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html">AbstractSystemWizardPage</A></samp> abstract base class extends the -JFace <samp>WizardPage</samp> class to offer the following benefits to subclasses:</p> -<ol> - <li>Designed to work in conjunction with <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html">AbstractSystemWizard</A></samp>, - propogating settings from the wizard to the individual wizard pages. - <li>Supports using the overall wizard page title as set - by <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#setWizardPageTitle(java.lang.String)">setWizardPageTitle(String)</A></samp> - in <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html">AbstractSystemWizard</A></samp>, - if no title specified in the constructor. - <li>Supports a <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html#setHelp(java.lang.String)">setHelp(String)</A></samp> method to set the wizard page's overall contextual help - <li>Implements <samp><A - href="../messages/uiMessageAPI.html#ISystemMessageLine">ISystemMessageLine</A></samp> so supports setting error messages as - either strings or, preferably, <samp><A - href="../messages/uiMessageAPI.html#SystemMessage">SystemMessage</A></samp> objects. - <li>Supports automatic assignment of unique mnemonics for all input-capable controls on the page, to aid in accessibility. - <li>Supports setting a default-focus control, which gets initial focus when the page is shown. - <li>Supports helper methods to aid in population of the client area: - <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html#addSeparatorLine(org.eclipse.swt.widgets.Composite, int)">addSeparatorLine(Composite,int)</A></samp>, - <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html#addFillerLine(org.eclipse.swt.widgets.Composite, int)">addFillerLine(Composite,int)</A></samp> and - <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html#addGrowableFillerLine(org.eclipse.swt.widgets.Composite, int)">addGrowableFillerLine(Composite,int)</A></samp>. -</ol> - - -<h3><A name="AbstractSystemWizard"></A>The <samp>AbstractSystemWizard</samp> class</h3> -<p>The <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html">AbstractSystemWizard</A></samp> abstract base class extends the JFace <samp>Wizard</samp> -class to offer the following benefits to subclasses:</p> -<ol> - <li>Designed to work in conjunction with the <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseWizardAction.html">SystemBaseWizardAction</A></samp>, - and <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemWizardDialog.html">SystemWizardDialog</A></samp> classes, propogating settings - from these to the wizard, and further propogating those to the individual wizard pages. - <li>The overall wizard title and image can be set via the constructor or setter methods. - <li>Supports setting an input object, and getting an output object. This is exploited by the - <samp><A href="../../../reference/api/org/eclipse/rse/ui/actions/SystemBaseWizardAction.html">SystemBaseWizardAction</A></samp> class, when this wizard is launched from a subclass of that action class. - <li>Supports setting a wizard page title via <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#setWizardPageTitle(java.lang.String)">setWizardPageTitle(String)</A></samp>, that all - <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html">AbstractSystemWizardPage</A></samp> pages will use by default for - their title, if the non-title constructor is used for that page. - <li>If being hosted by a <samp><A href="../../../reference/api/org/eclipse/rse/ui/dialogs/SystemWizardDialog.html">SystemWizardDialog</A></samp>, supports dynamically - updating the wizard size via <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#updateSize()">updateSize()</A></samp>, - if dynamic content is added to a wizard page, causing the page to grow beyond its initial size. - <li>Supports a <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#setHelp(java.lang.String)">setHelp(String)</A></samp> method to set the overall wizard's contextual help. This is propogated to each - <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizardPage.html">AbstractSystemWizardPage</A></samp> as it is added. - <li>Supports setting the viewer that launched this wizard, as wizards often need to know this so they can update the UI upon Finish. - <li>Supports a <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#wasCancelled()">wasCancelled()</A></samp> method so callers can easily test if the wizard was cancelled by the user. - <li>Supports a <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#setMinimumPageSize(int, int)">setMinimumPageSize(int,int)</A></samp> method to set the minimum width and height of the wizard. - <li>Supports a <samp><A href="../../../reference/api/org/eclipse/rse/ui/wizards/AbstractSystemWizard.html#setPageError(org.eclipse.jface.wizard.IWizardPage)">setPageError(IWizardPage)</A></samp> method that can be called in performFinish when an error is detected on a - non-current page. This issues a message telling the user there is an error on another page. -</ol> - -<P><BR></P> -</body> -</html> |
