PageRenderTime 26ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/42docs/users-guide/launcher-interface.html

#
HTML | 66 lines | 66 code | 0 blank | 0 comment | 0 complexity | 0b5bf6696c94c8b3095849d75135dadf MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The jEditLauncher Interface</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="jEdit 4.2 User's Guide"><link rel="up" href="launcher-guide.html" title="Appendix G. jEditLauncher for Windows"><link rel="previous" href="launcher-uninstall.html" title="Uninstalling jEdit and jEditLauncher"><link rel="next" href="launcher-examples.html" title="Scripting Examples"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The jEditLauncher Interface</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="launcher-uninstall.html">Prev</a> </td><th width="60%" align="center">Appendix G. jEditLauncher for Windows</th><td width="20%" align="right"> <a accesskey="n" href="launcher-examples.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="launcher-interface"></a>The jEditLauncher Interface</h2></div></div><div></div></div><p>
    2. 

  2.     The core of the jEditLauncher package is a COM component that can
    3. 

  3.     communicate with the EditServer, or open jEdit if it is not running or
    4. 

  4.     is otherwise refusing a connection. The component supports both Windows
    5. 

  5.     and UNC file specifications, including wild cards. It will resolve
    6. 

  6.     shortcut links to identify and transmit the name of the underlying file.
    7. 

  7.   </p><p>
    8. 

  8.     Because it is implemented with a &#8220;<span class="quote">dual interface</span>&#8221;, the
    9. 

  9.     functions of jEditLauncher are available to scripting languages in the
    10. 

  10.     Windows environment such as VBScript, JScript, Perl (using the
    11. 

  11.     Win32::OLE package) and Python (using the win32com.client package).
    12. 

  12.   </p><p>
    13. 

  13.     The scriptable interface consists of two read-only properties and
    14. 

  14.     six functions:
    15. 

  15.   </p><p>
    16. 

  16.     <span class="emphasis"><em>Properties</em></span>
    17. 

  17.   </p><div class="itemizedlist"><ul type="disc"><li><p>
    18. 

  18.         <tt class="varname">ServerPort</tt> - a read-only property that returns the
    19. 

  19.         port number found in jEdit's server file; the value is not tested for
    20. 

  20.         authenticity. It returns zero if the server information file cannot
    21. 

  21.         be located.
    22. 

  22.       </p></li><li><p>
    23. 

  23.         <tt class="varname">ServerKey</tt> - a read-only property that returns the numeric
    24. 

  24.         authorization key found in jEdit's server file; the value is not tested
    25. 

  25.         for authenticity. It returns zero if the server information file cannot
    26. 

  26.         be located.
    27. 

  27.         </p></li></ul></div><p>
    28. 

  28.       <span class="emphasis"><em>Functions</em></span>
    29. 

  29.     </p><div class="itemizedlist"><ul type="disc"><li><p>
    30. 

  30.         <tt class="function">OpenFile</tt> - a method that takes a single file name
    31. 

  31.         (with or without wild card characters) as a parameter.
    32. 

  32.       </p></li><li><p>
    33. 

  33.         <tt class="function">OpenFiles</tt> - this method takes an array of file names
    34. 

  34.         (with or without wild card characters) as a parameter. The form of the
    35. 

  35.         array is that which is used for arrays in the scripting environment. In
    36. 

  36.         JScript, for example the data type of the <tt class="classname">VARIANT</tt> holding
    37. 

  37.         the array is <tt class="classname">VT_DISPATCH</tt>; in VBScript, it is <tt class="classname">VT_ARRAY
    38. 

  38.         | VT_VARIANT</tt>, with array members having data type
    39. 

  39.         <tt class="classname">VT_BSTR</tt>.
    40. 

  40.       </p></li><li><p>
    41. 

  41.         <tt class="function">Launch</tt> - this method with no parameters attempts to
    42. 

  42.         open jEdit without loading additional files.
    43. 

  43.       </p></li><li><p>
    44. 

  44.       <tt class="function">RunScript</tt> - this method takes a file name or full file
    45. 

  45.       path as a parameter and runs the referenced file as a BeanShell script in jEdit.
    46. 

  46.       The predefined variables <tt class="varname">view</tt>, <tt class="varname">editPane</tt>,
    47. 

  47.       <tt class="varname">textArea</tt> and <tt class="varname">buffer</tt> are available to the
    48. 

  48.       script. If more than one view is open, the variable are
    49. 

  49.       initialized with reference to the earliest opened view. If no path is
    50. 

  50.       given for the file it will use the working directory of the calling process.
    51. 

  51.     </p></li><li><p>
    52. 

  52.       <tt class="function">EvalScript</tt> - this method takes a string as a
    53. 

  53.       parameter containing one or more BeanShell statements and runs the script
    54. 

  54.       in jEdit's BeanShell interpreter.  The
    55. 

  55.       predefined variables are available on the same basis as in
    56. 

  56.       <tt class="function">RunScript</tt>.
    57. 

  57.     </p></li><li><p>
    58. 

  58.       <tt class="function">RunDiff</tt> - this method takes two strings
    59. 

  59.       representing file names as parameters.  If the
    60. 

  60.       <span class="application">JDiff</span> plugin is installed, this method
    61. 

  61.       will activate the JDiff plugin and display the two files in the
    62. 

  62.       plugin's graphical &#8220;<span class="quote">dual diff</span>&#8221; format.  The first
    63. 

  63.       parameter is treated as the base for display purposes.  If the
    64. 

  64.       <span class="application">JDiff</span> plugin is not installed, a
    65. 

  65.       error message box will be displayed in jEdit.
    66. 

  66.     </p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="launcher-uninstall.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="launcher-guide.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="launcher-examples.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Uninstalling jEdit and jEditLauncher </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Scripting Examples</td></tr></table></div></body></html>
    67. 

  67.