EditorPrompt

All Superinterfaces:: Prompt

All Known Implementing Classes:: DefaultEditorPrompt

public interface EditorPrompt extends Prompt

Interface for editor prompts. An editor prompt opens an external editor for multi-line text input.

Method Summary

Modifier and Type

Method

Description

default boolean

enableWrapping()

Whether to enable text wrapping in the editor.

default String

getFileExtension()

Get the file extension to use for the temporary file.

default String

getInitialText()

Get the initial text to populate the editor with.

default String

getTitle()

Get the title to display in the editor.

default boolean

showLineNumbers()

Whether to show line numbers in the editor.

Methods inherited from interface org.jline.prompt.Prompt
getFilter, getMessage, getName, getTransformer

Method Details
- getInitialText
  
  default String getInitialText()
  
  Get the initial text to populate the editor with.
  
  Returns:
  
  the initial text, or null for empty
- getFileExtension
  
  default String getFileExtension()
  
  Get the file extension to use for the temporary file. This can affect syntax highlighting in the editor.
  
  Returns:
  
  the file extension (without dot), or null for .txt
- getTitle
  
  default String getTitle()
  
  Get the title to display in the editor.
  
  Returns:
  
  the editor title, or null for default
- showLineNumbers
  
  default boolean showLineNumbers()
  
  Whether to show line numbers in the editor.
  
  Returns:
  
  true to show line numbers, false to hide
- enableWrapping
  
  default boolean enableWrapping()
  
  Whether to enable text wrapping in the editor.
  
  Returns:
  
  true to enable wrapping, false to disable