Edit Local File

Function:

The tool "Edit Local File" is a component of the Edit action. It is used to open any file in the corresponding editor. The prerequisite for this is that the source to be edited is in the local workspace in the Eclipse project.

In an action, the AWM tool "Locate Persistent File" must precede the tool "Edit Local File" if the local file has been created with the AWM "Create Persistent File" tool.

The tool "Edit Local File" can also be used on temporary local files. For example, in this context it is intended for Remote Edit scenarios in which the Save and Close actions are used.

Tool Attribute:

Attribute	Type	Description
Editor ID [O]	String	Specifies the identifier of the Eclipse editor that should be used to open the file. This attribute is optional and does not have a value by default.

If no editor identifier is specified, the standard Eclipse rules apply to open the file. This means that the editor used to open the file depends on the file suffix or the editor which was used last to open this file.

At run time the user can customize the default editor associated to a file suffix in the Eclipse preferences ( Window > Preferences > General > Editors > File Associations ). This means that at run time you could decide which editor is to be used, if the editor identifier is not specified.

If you want to make sure that a specific editor is used for all users, you should specify the editor identifier in the AWM model. To find the editor identifier, open the editor and press Alt+Shift+F1 in the editor pane. A dialog box opens and displays the editor identifier among other information.

Example:

Press Alt+Shift+F1 in the Micro Focus COBOL editor to see that its editor identifier is com.microfocus.eclipse.editor.cobol.CobolEditor.

Parameters:

Parameter Name	I/O	Type	Description
Workspace File [M]	I	File	The associated file descriptor's type must be `Workspace File`. In editing scenarios where the file is located on a remote system, this file descriptor typically corresponds to the output parameter of the AWM tool LocatePersistent File or Create Temporary File.