src/Pure/GUI/tree_view.scala
author wenzelm
Wed, 12 Mar 2025 11:39:00 +0100
changeset 82265 4b875a4c83b0
parent 82142 508a673c87ac
child 82554 fa069e15c8da
permissions -rw-r--r--
update for release;
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,
82142
508a673c87ac removed unused imports;
wenzelm
parents: 81497
diff changeset
    11
  TreeSelectionModel, 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
81497
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    28
  class Cell_Renderer extends DefaultTreeCellRenderer {
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    29
    def setup(value: AnyRef): Unit = setIcon(null)
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    30
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    31
    override def getTreeCellRendererComponent(
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    32
      tree: JTree,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    33
      value: AnyRef,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    34
      selected: Boolean,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    35
      expanded: Boolean,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    36
      leaf: Boolean,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    37
      row: Int,
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    38
      hasFocus: Boolean
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    39
    ): java.awt.Component = {
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    40
      super.getTreeCellRendererComponent(tree, value, selected, expanded, leaf, row, hasFocus)
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    41
      setup(value)
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    42
      this
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    43
    }
81496
76f360c63dfe clarified default: avoid copies;
wenzelm
parents: 81495
diff changeset
    44
  }
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    45
}
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    46
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    47
class Tree_View(
81329
1775fdc7274e clarified signature;
wenzelm
parents: 81326
diff changeset
    48
  val root: Tree_View.Node = Tree_View.Node(),
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    49
  single_selection_mode: Boolean = false
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    50
) extends JTree(root) {
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    51
  def get_selection[A](which: PartialFunction[AnyRef, A]): Option[A] =
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    52
    getLastSelectedPathComponent match {
81380
83012fe97282 revert 1206400b9b48: proper Node.unapply for Node.apply(null);
wenzelm
parents: 81377
diff changeset
    53
      case Tree_View.Node(obj) if obj != null && which.isDefinedAt(obj) => Some(which(obj))
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    54
      case _ => None
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    55
    }
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    56
81483
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    57
  def init_model(body: => Unit): Unit = {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    58
    clearSelection()
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    59
    root.removeAllChildren()
81483
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    60
    body
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    61
    expandRow(0)
7d4df25af572 clarified Tree_View.init_model: more uniform;
wenzelm
parents: 81380
diff changeset
    62
    reload_model()
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    63
  }
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    64
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    65
  def reload_model(): Unit =
81326
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    66
    getModel match {
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    67
      case model: DefaultTreeModel => model.reload(root)
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    68
      case _ =>
403203217493 more robust;
wenzelm
parents: 81325
diff changeset
    69
    }
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    70
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    71
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    72
  /* init */
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    73
81497
da807cf1e461 clarified signature and object initialization;
wenzelm
parents: 81496
diff changeset
    74
  setCellRenderer(new Tree_View.Cell_Renderer)
81494
b30dc7db521f support for modified tree cell renderer;
wenzelm
parents: 81483
diff changeset
    75
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    76
  setRowHeight(0)
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    77
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    78
  if (single_selection_mode) {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    79
    getSelectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION)
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    80
  }
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    81
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    82
  // follow jEdit
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    83
  if (!GUI.is_macos_laf) {
81325
458e9e3b356e clarified signature;
wenzelm
parents: 81323
diff changeset
    84
    putClientProperty("JTree.lineStyle", "Angled")
81323
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    85
  }
33fbf90fbc1d clarified signature: more explicit types;
wenzelm
parents:
diff changeset
    86
}