/plugins/BufferList/tags/bufferlist_1_1/BufferList.html

# · HTML · 431 lines · 369 code · 62 blank · 0 comment · 0 complexity · 3c7bb45d52906d02a436eda47d2fa70e MD5 · raw file

  1. <HTML>
  2. <HEAD>
  3. <TITLE>BufferList plugin</TITLE>
  4. </HEAD>
  5. <BODY BGCOLOR="#FFFFFF">
  6. <TABLE BGCOLOR="#CCCCFF" BORDER="0" CELLSPACING="0" CELLPADDING="5"
  7. WIDTH="100%">
  8. <TR>
  9. <TD>
  10. <H1>BufferList Plugin</H1>
  11. </TD>
  12. <TD ALIGN="right">
  13. <SMALL>By Dirk M&ouml;bius<BR>
  14. <A HREF="mailto:dmoebius@gmx.net"><EM>dmoebius@gmx.net</EM></A>
  15. </SMALL>
  16. </TD>
  17. </TR>
  18. </TABLE>
  19. <P>
  20. Contributions by Slava Pestov, Stefan Radig, Lee Turner, Karsten Pilz, Daniel Wunsch.
  21. </P>
  22. <H2>Introduction</H2>
  23. <P>
  24. The BufferList Plugin shows the list of currently open files in a window, that
  25. may be docked permanently into jEdit's view. Some actions that operate on
  26. buffers, like open/save/reload, may be invoked by a popup that appears when
  27. right-clicking an entry.
  28. </P>
  29. <H2>Behaviour</H2>
  30. <H3>Mouse Actions</H3>
  31. <UL>
  32. <LI><B>single click</B> jumps to the selected buffer</LI>
  33. <LI><B>double click</B> closes the selected buffer (<I>this may be
  34. disabled in the options pane, see below</I>)</LI>
  35. <LI><B>shift click</B> selects multiple entries</LI>
  36. <LI><B>right click</B> opens a popup with some buffer related actions</LI>
  37. </UL>
  38. <H3>Menu Actions</H3>
  39. <P>
  40. The following menu actions are available in menu
  41. <B>Plugins&gt;Buffer&nbsp;List</B>:
  42. <P>
  43. <UL>
  44. <LI><B>Buffer List (Toggle)</B><BR>
  45. Show/Hide the Buffer List.</LI>
  46. <LI><B>Go to Buffer List</B><BR>
  47. Show the Buffer List and set the focus on the current buffer entry.</LI>
  48. <LI><B>Go to Next Buffer in Buffer List</B><BR>
  49. Go to the buffer below the current one in the Buffer List.
  50. This is different from <B>View&gt;Go to Next Buffer</B>,
  51. because the Buffer List might be sorted differently than jEdit's
  52. internal list.</LI>
  53. <LI><B>Go to Previous Buffer in Buffer List</B><BR>
  54. Go to the buffer above the current one in the Buffer List.</LI>
  55. <LI><B>Flat Tree</B><BR>
  56. Toggles the display of BufferList between a flat and hierarchical view.</LI>
  57. </UL>
  58. <H3>Key Actions</H3>
  59. <P>
  60. The Buffer List is fully keyboard navigable.
  61. </P>
  62. <P>
  63. A prerequisite is that you assigned a keyboard shortcut to the plugin action
  64. <B>Go to Buffer List</B>. You can assign keyboard shortcut to this action under
  65. <B>Utilities&gt;Global&nbsp;options&gt;Shortcuts</B>. I suggest that you use
  66. <B>"A+b"</B>.
  67. </P>
  68. <TABLE BORDER>
  69. <TR> <TD><B>Key Shortcut</B></TD> <TD><B>Action</B></TD> </TR>
  70. <TR> <TD>[Alt-b]</TD> <TD>Show Buffer List</TD> </TR>
  71. <TR> <TD>[Up] / [Down]</TD> <TD>Choose buffer</TD> </TR>
  72. <TR> <TD>[Right]</TD> <TD>Expand a directory entry</TD> </TR>
  73. <TR> <TD>[Left]</TD> <TD>Collapse a directory entry</TD> </TR>
  74. <TR> <TD>[Enter] / [Return]</TD> <TD>Jump to/Open selected buffer</TD> </TR>
  75. <TR> <TD>[Esc]</TD> <TD>Return to text area</TD> </TR>
  76. </TABLE>
  77. <BR>
  78. <A NAME="customization">
  79. </A><H2>Customization</H2>
  80. <H3>Appearance</H3>
  81. <P>
  82. You can customize the appearance of the Buffer List via
  83. <B>Plugins&gt;Plugin&nbsp;Options&gt;Buffer&nbsp;List</B>. The following options
  84. are available:
  85. </P>
  86. <UL>
  87. <LI><B>Font</B><BR>
  88. The base font of bufferlist entries.<BR>
  89. The current buffer will be shown <B>bold</B>.
  90. All entries will be shown with a color that matches one of the regular
  91. expressions in
  92. <B>Utilities&gt;Global&nbsp;options&gt;File&nbsp;System&nbsp;Browser&gt;Colors</B>.</LI>
  93. <LI><B>Auto-Show on buffer change</B><BR>
  94. If checked, the Buffer List is automatically shown, if the current buffer
  95. has been changed.</LI>
  96. <LI><B>Close files on double click</B><BR>
  97. If checked, a buffer that has been double clicked is closed. Otherwise it
  98. is opened.</LI>
  99. <LI><B>Fully expand directory tree by default</B><BR>
  100. If checked, the BufferList tree will be fully expanded when first loaded.</LI>
  101. <LI><B>Use flat tree by default</B><BR>
  102. New instances of the BufferList will be displayed in a flat view when checked
  103. or in a hierarchical view when not checked.</LI>
  104. <LI><B>Clip long paths with "..."</B><BR>
  105. Toggles display of long paths between text clipping at end, at start
  106. (default) and no clipping. If no clipping is selected, BufferList displays
  107. a horizontal scrollbar.</LI>
  108. </UL>
  109. <H3>Docking</H3>
  110. <P>
  111. Buffer List may be docked anywhere into the view.
  112. </P>
  113. <P>
  114. Open <b>Utilities&gt;Global&nbsp;options&gt;Docking</b> to define
  115. the position, where the Buffer List will be docked.
  116. </P>
  117. <A NAME="license"></A>
  118. <H2>License</H2>
  119. <P>
  120. The source code is distributed under the GPL. Please have a look at:
  121. <A HREF="http://www.fsf.org/copyleft/gpl.html">http://www.fsf.org/copyleft/gpl.html</A>
  122. </P>
  123. <A NAME="feedback"></A>
  124. <H2>Feedback</H2>
  125. <P>
  126. The preferred way to send bug reports is to use the
  127. <b><a href="http://sourceforge.net/tracker/?group_id=588&atid=565475&func=browse">Sourceforge
  128. Plugin Bug Tracker</a></b>.
  129. </P>
  130. <P>
  131. You can also write to:
  132. </P>
  133. <UL>
  134. <LI>Dirk M&ouml;bius <a href="mailto:dmoebius@gmx.net"><EM>&lt;dmoebius@gmx.net&gt;</EM></a>, or</LI>
  135. <LI>jEdit-users mailing-list <a href="mailto:jedit-users@lists.sourceforge.net"><EM>&lt;jedit-users@lists.sourceforge.net&gt;</EM></a>, or</LI>
  136. <LI>jEdit-devel mailing-list <a href="mailto:jedit-devel@lists.sourceforge.net"><EM>&lt;jedit-devel@lists.sourceforge.net&gt;</EM></a>.</LI>
  137. </UL>
  138. <P>
  139. <A NAME="changelog">
  140. <H2>Changelog</H2>
  141. <UL>
  142. <LI><B>VERSION 1.1 (2005/04/05)</B>
  143. <UL>
  144. <LI>New action "Flat tree" to switch between flat and hierarchical
  145. layout (Karsten Pilz)</LI>
  146. <LI>Ability to add custom entries to the context menu by third
  147. party plugins through jEdit's Services API (Gerard Smyth)</LI>
  148. </UL>
  149. </LI>
  150. <LI><B>VERSION 1.0.1 (2005/03/16)</B>
  151. <UL>
  152. <LI>Bugfix: StringIndexOutOfBoundsException if the first buffer in list had
  153. a path from an exotic VFS such as ArchiveVFS.</LI>
  154. </UL>
  155. </LI>
  156. <LI><B>VERSION 1.0 (2005/03/08)</B>
  157. <UL>
  158. <LI>New option to replace occurrences of the user's home directory with
  159. the char "~". Enabled by default. (Daniel Wunsch)</LI>
  160. <LI>New option to clip the text of long directory names with "..." at
  161. the start or at the end of the display, instead of showing a horizonal
  162. scrollbar. (Kudos to Marcelo Vanzin)</LI>
  163. <LI>Bugfix: setting an italic font for BufferList was ignored (Ronald Fischer)</LI>
  164. <LI>Updated docs.</LI>
  165. </UL>
  166. </LI>
  167. <LI><B>VERSION 0.11</B>
  168. <UL>
  169. <LI>Added new hierarchical layout (containing only as many intermediate
  170. levels as neccessary). Disabled by default, but can be enabled with
  171. the new option "Flat Tree". (Karsten Pilz)</LI>
  172. </UL>
  173. </LI>
  174. <LI><B>VERSION 0.10</B>
  175. <UL>
  176. <LI>Updated to jEdit 4.2 API (Lee Turner)</LI>
  177. <LI>Added open buffer and unsaved buffer counts (Lee Turner)</LI>
  178. <LI>Requires jEdit 4.2pre5 or higher</LI>
  179. </UL>
  180. </LI>
  181. <LI><B>VERSION 0.9</B>
  182. <UL>
  183. <LI>Added option to fully expand tree by default (Lee Turner)</LI>
  184. <LI>Added tooltips to the items in the tree (Lee Turner)</LI>
  185. </UL>
  186. </LI>
  187. <LI><B>VERSION 0.8</B>
  188. <UL>
  189. <LI>Tree display instead of table display; the files are grouped by directory.</LI>
  190. <LI>Removed list of recent files</LI>
  191. <LI>Entries are shown in the color specified by File System Browser colors.</LI>
  192. <LI>Allow multiple selections of open buffers: popup operations are: save, close
  193. and reload. This allows you to close, for example, all files of one directory
  194. at once.</LI>
  195. <LI>Bugfix: bufferlist showed up on buffer change even if "Auto-show on buffer
  196. change" was off</LI>
  197. <LI>Requires jEdit 4.0final or higher</LI>
  198. </UL>
  199. </LI>
  200. <LI><B>VERSION 0.7.1</B>
  201. <UL>
  202. <LI>New option to disable "Close files on double click" (Lee Turner)</LI>
  203. <LI>New option to hide recent files window permanently (Lee Turner)</LI>
  204. <LI>Updated to new jEdit 4.0 API</LI>
  205. <LI>Using HelpfulJTable from CommonControls plugin</LI>
  206. <LI>Removed action "Bring BufferList to front", because it is obsolete now with
  207. the new jEdit 4.0 docking API</LI>
  208. <LI>Requires jEdit 4.0pre1 or higher, CommonControls 0.2 or higher</LI>
  209. </UL>
  210. </LI>
  211. <LI><B>VERSION 0.7</B>
  212. <UL>
  213. <LI>Session management taken out into a new plugin: SessionsPlugin</LI>
  214. <LI>Bugfix: NullPointerException in HelpfulJTable, BufferList didn't start up</LI>
  215. <LI>Bugfix: table background color changed after properties changed</LI>
  216. <LI>Requires jEdit 3.2pre2 or higher</LI>
  217. </UL>
  218. </LI>
  219. <LI><B>VERSION 0.6.3</B>
  220. <UL>
  221. <LI>Bugfix: NullPointerException at initialization after clean install.</LI>
  222. <LI>Bugfix: "Save Session as" and "Manage Sessions" threw BeanShell errors.</LI>
  223. <LI>Bugfix: Default session never got autosaved after clean install.</LI>
  224. <LI>Bugfix: "Show vertical/horizonal lines" options had wrong default value
  225. in options pane.</LI>
  226. <LI>Bugfix: Sometimes a (harmless) NullPointerException was thrown when switching
  227. sessions using the combo box because of a race condition.</LI>
  228. <LI>Requires jEdit 3.2pre2 or higher</LI>
  229. </UL>
  230. </LI>
  231. <LI><B>VERSION 0.6.2</B>
  232. <UL>
  233. <LI>Now let's jEdit restore the last open session again, subject
  234. to jEdit's "Restore last open files on startup" option</LI>
  235. <LI>Bugfix: order of recent files was reversed as of jEdit 3.2pre2</LI>
  236. <LI>Bugfix: SessionSwitcher could be added to the view twice or more</LI>
  237. <LI>Moved code to packages "bufferlist" und "bufferlist.table"</LI>
  238. <LI>Requires jEdit 3.2pre2 or higher</LI>
  239. </UL>
  240. </LI>
  241. <LI><B>VERSION 0.6.1</B>
  242. <UL>
  243. <LI>SessionSwitcher can now be shown as View ToolBar.
  244. So now users can use the session management functions without showing
  245. the bufferlist at all!</LI>
  246. <LI>Bugfix: #418299 FileNotFoundException on jEdit clean install</LI>
  247. <LI>Bugfix: All recent files gone if BufferList installed for first time</LI>
  248. <LI>Bugfix: Last open buffer wasn't restored on restart</LI>
  249. <LI>Bugfix: Lists didn't scroll if selection was moved with cursor keys</LI>
  250. <LI>Requires jEdit 3.1final or higher</LI>
  251. </UL>
  252. </LI>
  253. <LI><B>VERSION 0.6</B>
  254. <UL>
  255. <LI>New option "Check status of recent files"</LI>
  256. <LI>New popup command to remove entries from the recent files list. Use this
  257. if there are non-existent entries in the list and you don't want BufferList
  258. to check these files any longer.</LI>
  259. <LI>Faster loading of last session on jEdit startup</LI>
  260. <LI>Bugfix: last session was not saved correctly (now uses the EditBus message
  261. EditorExitRequested new since jEdit 3.1pre4)</LI>
  262. <LI>Bugfix: split pane divider wasn't set correctly on IBM JDK 1.1.8</LI>
  263. <LI>Bugfix: pressing Enter without selection caused Exception (Stefan Radig)</LI>
  264. <LI>Bugfix: BufferList popped up even if "autoshow on buffer changed" was disabled</LI>
  265. <LI>Requires jEdit 3.1pre4 or higher</LI>
  266. </UL>
  267. </LI>
  268. <LI><B>VERSION 0.5.1</B>
  269. <UL>
  270. <LI>Bugfix: ESC sets focus back to editor if BufferList is docked and focussed</LI>
  271. <LI>Bugfix: Changing option "Show absolute path name in filename column" had no
  272. immediate effect.</LI>
  273. <LI>Bugfix: Name column rendered wrong on Windows L&amp;F</LI>
  274. <LI>Some minor optimizations (lesser redraws)</LI>
  275. <LI>Requires jEdit 3.0final or higher</LI>
  276. </UL>
  277. </LI>
  278. <LI><B>VERSION 0.5 (2001/03/24)</B>
  279. <UL>
  280. <LI>Sort a column by clicking on the table header (cycling through ascending,
  281. descending and jEdit's sort order).</LI>
  282. <LI>New actions "Go to Next Buffer in Buffer List" and "Go to Previous Buffer
  283. in Buffer List" to cycle through the buffers in the same order as displayed
  284. in Buffer List.</LI>
  285. <LI>New option "Auto-Show on buffer change" (default: off).</LI>
  286. <LI>Show the right status icon (read-only/not exist) in recent file list.</LI>
  287. <LI>Bugfix: if last entry in open files list was grey, all entries in recent
  288. files were grey, too.</LI>
  289. <LI>Bugfix: "Bring Buffer List to front" didn't work right if window was docked.</LI>
  290. <LI>Bugfix: lists no longer autoscrolls to the selected cell, was irritating.</LI>
  291. <LI>Bugfix: some redraw problems.</LI>
  292. <LI>Requires jEdit 3.0final or higher</LI>
  293. </UL>
  294. </LI>
  295. <LI><B>VERSION 0.4.1 (2001/03/16)</B>
  296. <UL>
  297. <LI>don't use class org.gjt.sp.jedit.Sessions any more, copied required methods
  298. into SessionManager class.</LI>
  299. <LI>bugfix: #407948 BufferList clears 'default.session' file on exit</LI>
  300. <LI>bugfix: same column shown twice after reordering or showing/hiding</LI>
  301. <LI>bugfix: buffer click doesn't work if mouse was moved during click</LI>
  302. <LI>requires jEdit 3.0final or higher</LI>
  303. </UL>
  304. </LI>
  305. <LI><B>VERSION 0.4 (2001/03/10)</B>
  306. <UL>
  307. <LI>session management:
  308. <UL>
  309. <LI>session switcher</LI>
  310. <LI>session manager dialog</LI>
  311. <LI>autosave sessions on switch</LI>
  312. <LI>close all files before switching to a new session</LI>
  313. </UL>
  314. </LI>
  315. <LI>new option: turn off auto-resize of columns</LI>
  316. <LI>new column in bufferlist showing mode</LI>
  317. <LI>remember size and order of columns</LI>
  318. <LI>requires jEdit 3.0final or higher</LI>
  319. </UL>
  320. </LI>
  321. <LI><B>VERSION 0.3.1 (20001/01/06)</B>
  322. <UL>
  323. <LI>bugfix: if a buffer is selected from the "Open Files" list,
  324. the focus is set to the buffer now.</LI>
  325. <LI>requires jEdit 2.7pre3 or higher</LI>
  326. </UL>
  327. </LI>
  328. <LI><B>VERSION 0.3 (2000/12/31)</B>
  329. <UL>
  330. <LI>added right click popup menus</LI>
  331. <LI>bugfix: BufferList didn't recognize filename changes on "Save As"</LI>
  332. <LI>bugfix: Sometimes column width too short on properties change</LI>
  333. <LI>requires jEdit 2.7pre3 or higher</LI>
  334. </UL>
  335. </LI>
  336. <LI><B>VERSION 0.2.1 (2000/12/2)</B>
  337. <UL>
  338. <LI>put together by Slava Pestov</LI>
  339. <LI>bugfix: BufferList threw exceptions with FTP buffers</LI>
  340. <LI>bugfix: BufferList didn't work with jEdit 2.7pre3</LI>
  341. <LI>updated for jEdit 2.7 action API</LI>
  342. <LI>requires jEdit 2.7pre3 or higher</LI>
  343. </UL>
  344. </LI>
  345. <LI><B>VERSION 0.2</B>
  346. <UL>
  347. <LI>directory now shown in a separate column</LI>
  348. <LI>keyboard navigation: [enter] to open file, [tab] to switch between the
  349. two lists, [esc] to close window (if docked)</LI>
  350. <LI>new option pane in the plugin options</LI>
  351. <LI>options to turn off second column and horizontal and vertical lines</LI>
  352. <LI>the two actions are now called "BufferList" (internal name: "bufferlist")
  353. and "Bring BufferList to front" (internal name: "bufferlist-to-front").
  354. You should assign a keyboard shortcut to "Bring BufferList to front".</LI>
  355. <LI>bugfix: handle split views correctly</LI>
  356. <LI>bugfix: divider position was not set properly on Swing versions &lt; Kestrel</LI>
  357. <LI>bugfix: NPE on "Create New View"</LI>
  358. <LI>requires jEdit 2.6pre7 or higher</LI>
  359. </UL>
  360. </LI>
  361. <LI><B>VERSION 0.1 (2000/10/23)</B>
  362. <UL>
  363. <LI>initial release</LI>
  364. <LI>requires jEdit 2.6pre7 or higher</LI>
  365. </UL>
  366. </LI>
  367. </UL>
  368. </BODY>
  369. </HTML>