| author | wenzelm |
| Thu, 20 Aug 2015 19:15:17 +0200 | |
| changeset 60988 | 1d7a7e33fd67 |
| parent 60893 | 3c8b9b4b577c |
| child 61557 | f6387515f951 |
| permissions | -rw-r--r-- |
| 52445 | 1 |
/* Title: Tools/jEdit/src/documentation_dockable.scala |
2 |
Author: Makarius |
|
3 |
||
4 |
Dockable window for Isabelle documentation. |
|
5 |
*/ |
|
6 |
||
7 |
package isabelle.jedit |
|
8 |
||
9 |
||
10 |
import isabelle._ |
|
11 |
||
| 60847 | 12 |
import java.awt.Dimension |
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
13 |
import java.awt.event.{KeyEvent, KeyAdapter, MouseEvent, MouseAdapter}
|
| 60847 | 14 |
import javax.swing.{JTree, JScrollPane}
|
| 52445 | 15 |
import javax.swing.tree.{DefaultMutableTreeNode, TreeSelectionModel}
|
16 |
||
17 |
import org.gjt.sp.jedit.{View, OperatingSystem}
|
|
18 |
||
19 |
||
20 |
class Documentation_Dockable(view: View, position: String) extends Dockable(view, position) |
|
21 |
{
|
|
22 |
private val docs = Doc.contents() |
|
23 |
||
| 56422 | 24 |
private case class Documentation(name: String, title: String, path: Path) |
| 52445 | 25 |
{
|
| 57912 | 26 |
override def toString: String = |
| 52445 | 27 |
"<html><b>" + HTML.encode(name) + "</b>: " + HTML.encode(title) + "</html>" |
28 |
} |
|
29 |
||
|
52542
19d674acb764
more release notes according to availability in proper release vs. repository clone;
wenzelm
parents:
52541
diff
changeset
|
30 |
private case class Text_File(name: String, path: Path) |
|
52541
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
31 |
{
|
| 57912 | 32 |
override def toString: String = name |
|
52541
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
33 |
} |
|
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
34 |
|
| 52445 | 35 |
private val root = new DefaultMutableTreeNode |
36 |
docs foreach {
|
|
|
56423
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
37 |
case Doc.Section(text, _) => |
| 52445 | 38 |
root.add(new DefaultMutableTreeNode(text)) |
| 56422 | 39 |
case Doc.Doc(name, title, path) => |
| 52445 | 40 |
root.getLastChild.asInstanceOf[DefaultMutableTreeNode] |
| 56422 | 41 |
.add(new DefaultMutableTreeNode(Documentation(name, title, path))) |
|
52542
19d674acb764
more release notes according to availability in proper release vs. repository clone;
wenzelm
parents:
52541
diff
changeset
|
42 |
case Doc.Text_File(name: String, path: Path) => |
|
52541
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
43 |
root.getLastChild.asInstanceOf[DefaultMutableTreeNode] |
|
52542
19d674acb764
more release notes according to availability in proper release vs. repository clone;
wenzelm
parents:
52541
diff
changeset
|
44 |
.add(new DefaultMutableTreeNode(Text_File(name, path.expand))) |
|
52541
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
45 |
} |
|
97c950217d7f
quick access to release notes (imitating website/documentation.html);
wenzelm
parents:
52447
diff
changeset
|
46 |
|
| 52445 | 47 |
private val tree = new JTree(root) |
|
60292
ba3c716144dd
cell-specific row height based on its font, e.g. relevant for DPI scaling on Windows;
wenzelm
parents:
59390
diff
changeset
|
48 |
tree.setRowHeight(0) |
| 60847 | 49 |
tree.getSelectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION) |
|
54687
795f8d3e06c9
no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents:
54686
diff
changeset
|
50 |
|
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
51 |
override def focusOnDefaultComponent { tree.requestFocusInWindow }
|
|
54687
795f8d3e06c9
no keyboard control -- avoid confusion about meaning of selection;
wenzelm
parents:
54686
diff
changeset
|
52 |
|
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
53 |
private def action(node: DefaultMutableTreeNode) |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
54 |
{
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
55 |
node.getUserObject match {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
56 |
case Text_File(_, path) => |
| 60988 | 57 |
PIDE.editor.goto_file(true, view, File.platform_path(path)) |
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
58 |
case Documentation(_, _, path) => |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
59 |
if (path.is_file) |
| 60988 | 60 |
PIDE.editor.goto_file(true, view, File.platform_path(path)) |
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
61 |
else {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
62 |
Future.fork {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
63 |
try { Doc.view(path) }
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
64 |
catch {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
65 |
case exn: Throwable => |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
66 |
GUI.error_dialog(view, |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
67 |
"Documentation error", GUI.scrollable_text(Exn.message(exn))) |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
68 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
69 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
70 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
71 |
case _ => |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
72 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
73 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
74 |
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
75 |
tree.addKeyListener(new KeyAdapter {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
76 |
override def keyPressed(e: KeyEvent) |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
77 |
{
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
78 |
if (e.getKeyCode == KeyEvent.VK_ENTER) {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
79 |
e.consume |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
80 |
val path = tree.getSelectionPath |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
81 |
if (path != null) {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
82 |
path.getLastPathComponent match {
|
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
83 |
case node: DefaultMutableTreeNode => action(node) |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
84 |
case _ => |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
85 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
86 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
87 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
88 |
} |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
89 |
}) |
|
54686
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
90 |
tree.addMouseListener(new MouseAdapter {
|
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
91 |
override def mouseClicked(e: MouseEvent) |
|
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
92 |
{
|
|
54686
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
93 |
val click = tree.getPathForLocation(e.getX, e.getY) |
|
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
94 |
if (click != null && e.getClickCount == 1) {
|
|
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
95 |
(click.getLastPathComponent, tree.getLastSelectedPathComponent) match {
|
|
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
96 |
case (node: DefaultMutableTreeNode, node1: DefaultMutableTreeNode) if node == node1 => |
|
57920
c1953856cfca
clarified focus and key handling -- more like SideKick;
wenzelm
parents:
57912
diff
changeset
|
97 |
action(node) |
| 52445 | 98 |
case _ => |
99 |
} |
|
100 |
} |
|
|
54686
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
101 |
} |
|
070d5e856798
directly react on click, assuming that document view operation is mostly idempotent;
wenzelm
parents:
53177
diff
changeset
|
102 |
}) |
|
56423
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
103 |
|
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
104 |
{
|
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
105 |
var expand = true |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
106 |
var visible = 0 |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
107 |
def make_visible(row: Int) { visible += 1; tree.expandRow(row) }
|
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
108 |
for ((entry, row) <- docs.zipWithIndex) {
|
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
109 |
entry match {
|
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
110 |
case Doc.Section(_, important) => |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
111 |
expand = important |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
112 |
make_visible(row) |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
113 |
case _ => |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
114 |
if (expand) make_visible(row) |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
115 |
} |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
116 |
} |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
117 |
tree.setRootVisible(false) |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
118 |
tree.setVisibleRowCount(visible) |
|
c2f52824dbb2
explicit indication of important doc sections ("!"), which are expanded in the tree view;
wenzelm
parents:
56422
diff
changeset
|
119 |
} |
| 52445 | 120 |
|
121 |
private val tree_view = new JScrollPane(tree) |
|
| 60849 | 122 |
tree_view.setMinimumSize(new Dimension(200, 50)) |
| 52445 | 123 |
|
124 |
set_content(tree_view) |
|
125 |
} |