Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

class libtmux-java latest

PaneState

A pane as one capture saw it.

Source and package
Qualified name
io.github.libtmux.snapshot.PaneState
Package
io.github.libtmux.snapshot
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/snapshot/PaneState.java
Parameters
  • context (WindowContext) # – the winlink the pane was reached through

  • id (PaneId) # – the pane's stable id

  • index (int) # – the pane's position, which shifts as neighbours come and go

  • active (boolean) # – whether it was the active pane of its window

  • currentCommand (String) # – the command tmux reported running in it

  • size (Dimensions) # – how large the pane was, in terminal cells

  • position (PanePosition) # – where the pane's top-left corner sat in its window, in terminal cells

  • title (String) # – the pane title, which a program inside it can change

  • currentPath (String) # – the working directory tmux reported for it, as text. Not a java.nio.file.Path: a directory name is bytes to tmux, and converting one this JVM's encoding cannot represent throws — which, in a capture, would lose every other pane over one pane's directory. Pane.currentPath() converts on request instead

  • pid (OptionalLong) # – the process id of the program running in it, or empty when tmux reports no process at all — never a literal zero, so a caller cannot mistake the sentinel for a real pid

  • edges (PaneEdges) # – which sides of its window the pane touches

  • floating (Optional<Boolean>) # – whether the pane floats, or empty when the running tmux cannot say. Before 3.7 the format expands to nothing at all, and reporting that as false would be indistinguishable from a tmux that looked and found the pane was not floating.

Members12#

  • active method whether it was the active pane of its window
  • context method the winlink the pane was reached through
  • currentCommand method the command tmux reported running in it
  • currentPath method the working directory tmux reported for it, as text. Not a java.nio.file.Path: a directory name is bytes to tmux, and converting one this JVM's encoding cannot represent throws — which, in a capture, would lose every other pane over one pane's directory. Pane.currentPath() converts on request instead
  • edges method which sides of its window the pane touches
  • floating method whether the pane floats, or empty when the running tmux cannot say. Before 3.7 the format expands to nothing at all, and reporting that as false would be indistinguishable from a tmux that looked and found the pane was not floating.
  • id method the pane's stable id
  • index method the pane's position, which shifts as neighbours come and go
  • pid method the process id of the program running in it, or empty when tmux reports no process at all — never a literal zero, so a caller cannot mistake the sentinel for a real pid
  • position method where the pane's top-left corner sat in its window, in terminal cells
  • size method how large the pane was, in terminal cells
  • title method the pane title, which a program inside it can change

Guides#

Pages that discuss PaneState.

Esc

Type to search.

Reference previewOpen reference