Narrator (Codion Framework API 0.18.57)

java.lang.Object

is.codion.plugin.swing.robot.Narrator

public final class Narrator extends Object

An automation narrator to use alongside Controller.

Field Summary

Fields

Modifier and Type

Field

Description

static final PropertyValue<Integer>

FRAME_WIDTH

Species the narrator frame width.
Method Summary

Modifier and Type

Method

Description

void

clear()

Clears both narration and keystrokes

void

clearKeyStrokes()

Clears the keystrokes table.

void

clearNarration()

Clears the narration text.

void

close()

Clears this narrator and closes its frame

void

narrate(String text)

static Narrator

narrator(Controller controller, Window window)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- FRAME_WIDTH
  
  public static final PropertyValue<Integer> FRAME_WIDTH
  Species the narrator frame width.
  
  Value type: Integer
  Default value: 400
Method Details
- narrate
  
  public void narrate(String text)
  
  Parameters:
  
  text - the narration text to display
- clearNarration
  
  public void clearNarration()
  
  Clears the narration text.
- clearKeyStrokes
  
  public void clearKeyStrokes()
  
  Clears the keystrokes table.
- clear
  
  public void clear()
  
  Clears both narration and keystrokes
- narrator
  
  public static Narrator narrator(Controller controller, Window window)
  
  Parameters:
  
  controller - the controller to narrate
  
  window - the window to attach to
  
  Returns:
  
  a new Narrator
- close
  
  public void close()
  
  Clears this narrator and closes its frame