Class AcEdCommandLine

constructor

• new AcEdCommandLine(container?: HTMLElement): AcEdCommandLine

  Parameters

  • container: HTMLElement = document.body

  Returns AcEdCommandLine

autoCompleteIndex

bar

cliContainer

cmdPopup

container

downBtn

history

historyIndex

input

isCmdPopupOpen

isMsgPanelOpen

lastExecuted

leftGroup

minWidth

msgPanel

termGlyph

upBtn

widthRatio

wrapper

visible

• get visible(): boolean

  Visibility of the command line

  Returns boolean
• set visible(val: boolean): void

  Parameters

  • val: boolean

  Returns void

bindEvents

• bindEvents(): void

  Bind event listeners

  Returns void

createUI

• createUI(): void

  Create the command line UI elements

  Returns void

executeCommand

• executeCommand(cmdLine: string): void

  Execute a command line string. Returns a Promise that resolves when the command is completed.

  Parameters

  • cmdLine: string

    Command string

  Returns void

  Promise

getInputText

• getInputText(): string

  Get current input text

  Returns string

handleArrowKeys

• handleArrowKeys(e: KeyboardEvent): void

  Handle Up/Down keys for history or auto-complete

  Parameters

  • e: KeyboardEvent

  Returns void

handleInputChange

• handleInputChange(): void

  Handle input change to show auto-complete

  Returns void

handleKeyDown

• handleKeyDown(e: KeyboardEvent): void

  Handle Enter/Escape keys

  Parameters

  • e: KeyboardEvent

  Returns void

injectCSS

• injectCSS(): void

  Inject CSS styles

  Returns void

insertOption

• insertOption(opt: string): void

  Insert option into input

  Parameters

  • opt: string

  Returns void

navigateAutoComplete

• navigateAutoComplete(dir: number): void

  Navigate auto-complete list with arrow keys

  Parameters

  • dir: number

  Returns void

navigateHistory

• navigateHistory(dir: number): void

  Navigate command history

  Parameters

  • dir: number

  Returns void

positionCmdPopup

• positionCmdPopup(): void

  Position command history popup

  Returns void

positionMsgPanel

• positionMsgPanel(): void

  Position message panel

  Returns void

printError

• printError(msg: string, msgKey?: string): void

  Print error message with optional localization key

  Parameters

  • msg: string
  • OptionalmsgKey: string

  Returns void

printHistoryLine

• printHistoryLine(cmdLine: string): void

  Print executed command line to history

  Parameters

  • cmdLine: string

  Returns void

printMessage

• printMessage(msg: string, msgKey?: string): void

  Print message to message panel with optional localization key

  Parameters

  • msg: string
  • OptionalmsgKey: string

  Returns void

renderCommandLine

• renderCommandLine(cmd: string, options?: string[]): void

  Render command line with options

  Parameters

  • cmd: string
  • options: string[] = []

  Returns void

resizeHandler

• resizeHandler(): void

  Handle window resize

  Returns void

resolveCommand

• resolveCommand(cmdLine: string): undefined | AcEdCommand

  Resolve command name

  Parameters

  • cmdLine: string

  Returns undefined | AcEdCommand

setCursorToEnd

• setCursorToEnd(): void

  Move cursor to end of input

  Returns void

setInputText

• setInputText(text?: string): void

  Set input text

  Parameters

  • text: string = ''

  Returns void

showCommandHistoryPopup

• showCommandHistoryPopup(): void

  Show command history popup

  Returns void

showMessagePanel

• showMessagePanel(): void

  Show message panel

  Returns void

updatePopups

• updatePopups(__namedParameters?: { showCmd?: boolean; showMsg?: boolean }): void

  Show or hide popups

  Parameters

  • __namedParameters: { showCmd?: boolean; showMsg?: boolean } = {}

  Returns void