src/Pure/GUI/tree_view.scala
author wenzelm
Tue, 19 Nov 2024 22:55:09 +0100
changeset 81496 76f360c63dfe
parent 81495 57dc2c8ba7c6
child 81497 da807cf1e461
permissions -rw-r--r--
clarified default: avoid copies;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/GUI/tree_view.scala
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     3
81330
2239495a64f6 tuned comments;
wenzelm
parents: 81329
diff changeset
     4
Tree view with sensible defaults.
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     5
*/
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     6
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     7
package isabelle
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     8
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
     9
import javax.swing.JTree
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    10
import javax.swing.tree.{MutableTreeNode, DefaultMutableTreeNode, DefaultTreeModel,
81494
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    11
  TreeSelectionModel, TreeCellRenderer, DefaultTreeCellRenderer}
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    12
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    13
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    14
object Tree_View {
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    15
  type Node = DefaultMutableTreeNode
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    16
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    17
  object Node {
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    18
    def apply(obj: AnyRef = null): Node =
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    19
      if (obj == null) new DefaultMutableTreeNode else new DefaultMutableTreeNode(obj)
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    20
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    21
    def unapply(tree_node: MutableTreeNode): Option[AnyRef] =
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    22
      tree_node match {
81380
83012fe97282 revert 1206400b9b48: proper Node.unapply for Node.apply(null);
wenzelm
parents: 81377
diff changeset
    23
        case node: Node => Some(node.getUserObject)
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    24
        case _ => None
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    25
      }
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    26
  }
81496
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    27
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    28
  def render_tree_cell(renderer: DefaultTreeCellRenderer): Unit = {
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    29
    renderer.setIcon(null)
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    30
  }
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    31
}
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    32
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    33
class Tree_View(
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    34
  val root: Tree_View.Node = Tree_View.Node(),
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    35
  single_selection_mode: Boolean = false
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    36
) extends JTree(root) {
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    37
  def get_selection[A](which: PartialFunction[AnyRef, A]): Option[A] =
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    38
    getLastSelectedPathComponent match {
81380
83012fe97282 revert 1206400b9b48: proper Node.unapply for Node.apply(null);
wenzelm
parents: 81377
diff changeset
    39
      case Tree_View.Node(obj) if obj != null && which.isDefinedAt(obj) => Some(which(obj))
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    40
      case _ => None
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    41
    }
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    42
81483
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    43
  def init_model(body: => Unit): Unit = {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    44
    clearSelection()
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    45
    root.removeAllChildren()
81483
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    46
    body
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    47
    expandRow(0)
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    48
    reload_model()
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    49
  }
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    50
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    51
  def reload_model(): Unit =
81326
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    52
    getModel match {
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    53
      case model: DefaultTreeModel => model.reload(root)
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    54
      case _ =>
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    55
    }
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    56
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    57
81494
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    58
  /* cell renderer */
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    59
81496
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    60
  def render_tree_cell(renderer: DefaultTreeCellRenderer): Unit =
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    61
    Tree_View.render_tree_cell(renderer)
81494
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    62
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    63
  private val tree_cell_renderer: TreeCellRenderer = new DefaultTreeCellRenderer {
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    64
    override def getTreeCellRendererComponent(
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    65
      tree: JTree,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    66
      value: AnyRef,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    67
      selected: Boolean,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    68
      expanded: Boolean,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    69
      leaf: Boolean,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    70
      row: Int,
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    71
      hasFocus: Boolean
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    72
    ): java.awt.Component = {
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    73
      super.getTreeCellRendererComponent(tree, value, selected, expanded, leaf, row, hasFocus)
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    74
      render_tree_cell(this)
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    75
      this
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    76
    }
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    77
  }
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    78
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    79
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    80
  /* init */
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    81
81494
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    82
  setCellRenderer(tree_cell_renderer)
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    83
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    84
  setRowHeight(0)
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    85
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    86
  if (single_selection_mode) {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    87
    getSelectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION)
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    88
  }
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    89
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    90
  // follow jEdit
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    91
  if (!GUI.is_macos_laf) {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    92
    putClientProperty("JTree.lineStyle", "Angled")
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    93
  }
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    94
}