Module org.jline.prompt
Package org.jline.prompt

Interface PrompterConfig

All Known Implementing Classes:
DefaultPrompterConfig
public interface PrompterConfig
Configuration interface for customizing the visual appearance and behavior of prompts.

The configuration controls various visual elements used in the prompt display, including indicators, checkbox symbols, and interaction behavior. The API provides platform-specific defaults that work well on different operating systems.

Default Configurations:

  • Windows: ">", "( )", "(x)", "( )"
  • Unix/Linux/macOS: "?", "? ", "? ", "? "

Example Custom Configuration:


 Prompter.Config config = new DefaultPrompter.DefaultConfig(
     "?",     // indicator
     "? ",    // unchecked box
     "? ",    // checked box
     "? "     // unavailable item
 );

 Prompter prompter = PrompterFactory.create(terminal, config);
Since:
3.30.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AN
    Answer text style
    static final String
    BD
    Box disabled style
    static final String
    BE
    Box enabled style
    static final String
    CB
    Checkbox style
    static final String
    CURSOR
    Cursor/selection indicator style
    static final String
    ERROR
    Error message style
    static final String
    FO
    Footer/description text style (dimmed)
    static final String
    ME
    Message text style
    static final String
    PR
    Prompt text style
    static final String
    SE
    Selected item style

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cancellableFirstPrompt()
    Whether the first prompt can be cancelled.
    String
    checkedBox()
    Get the checked box character/string.
    static PrompterConfig
    custom(String indicator, String uncheckedBox, String checkedBox, String unavailable, org.jline.utils.StyleResolver styleResolver, boolean cancellableFirstPrompt)
    Create a custom configuration with style resolver support.
    static PrompterConfig
    defaults()
    Create a configuration with platform-specific defaults.
    default int
    footerMaxRows()
    Maximum height, in rows, of the dimmed footer pane shown below list and checkbox prompts.
    String
    indicator()
    Get the indicator character/string.
    default org.jline.utils.AttributedStyle
    style(String style)
     
    default org.jline.utils.StyleResolver
    styleResolver()
    Get the style resolver for this configuration.
    String
    unavailable()
    Get the unavailable item character/string.
    String
    uncheckedBox()
    Get the unchecked box character/string.
    static PrompterConfig
    unix()
    Create a configuration with Unix/Linux-specific defaults.
    static PrompterConfig
    windows()
    Create a configuration with Windows-specific defaults.
    default PrompterConfig
    withCancellableFirstPrompt(boolean cancellable)
     

  • Field Details

  • Method Details

    • indicator

      String indicator()
      Get the indicator character/string.
      Returns:
      the indicator

    • uncheckedBox

      String uncheckedBox()
      Get the unchecked box character/string.
      Returns:
      the unchecked box

    • checkedBox

      String checkedBox()
      Get the checked box character/string.
      Returns:
      the checked box

    • unavailable

      String unavailable()
      Get the unavailable item character/string.
      Returns:
      the unavailable item

    • styleResolver

      default org.jline.utils.StyleResolver styleResolver()
      Get the style resolver for this configuration.
      Returns:
      the style resolver, or null if not available

    • cancellableFirstPrompt

      boolean cancellableFirstPrompt()
      Whether the first prompt can be cancelled.
      Returns:
      true if the first prompt can be cancelled

    • withCancellableFirstPrompt

      default PrompterConfig withCancellableFirstPrompt(boolean cancellable)

    • defaults

      static PrompterConfig defaults()
      Create a configuration with platform-specific defaults.
      Returns:
      a configuration with platform defaults

    • windows

      static PrompterConfig windows()
      Create a configuration with Windows-specific defaults.
      Returns:
      a configuration with Windows defaults

    • unix

      static PrompterConfig unix()
      Create a configuration with Unix/Linux-specific defaults.
      Returns:
      a configuration with Unix defaults

    • custom

      static PrompterConfig custom(String indicator, String uncheckedBox, String checkedBox, String unavailable, org.jline.utils.StyleResolver styleResolver, boolean cancellableFirstPrompt)
      Create a custom configuration with style resolver support.
      Parameters:
      indicator - the indicator character/string
      uncheckedBox - the unchecked box character/string
      checkedBox - the checked box character/string
      unavailable - the unavailable item character/string
      styleResolver - the style resolver for applying styles
      Returns:
      a custom configuration with styling support

    • style

      default org.jline.utils.AttributedStyle style(String style)

    • footerMaxRows

      default int footerMaxRows()
      Maximum height, in rows, of the dimmed footer pane shown below list and checkbox prompts.
      Returns:
      the maximum footer pane height in rows