AvailWorkbench

AvailWorkbench is a simple user interface for the Avail builder.

Author

Mark van Gulik

Todd L Smith

Richard Arriaga

Parameters

fileManager

The FileManager used to manage Avail files.

globalSettings

The GlobalEnvironmentSettings for the environment this AvailWorkbench is being launched in.

availProject

The actively running AvailProject.

windowTitle

The AvailWorkbench's frame's title.

projectManager

The AvailProjectManager that launched this workbench or null if not launched from an AvailProjectManager.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The AvailBuilder used by this user interface.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The progress bar that displays the overall build progress.

Link copied to clipboard

Keep track of recent commands in a history buffer. Each submitted command is added to the end of the list. Cursor-up retrieves the most recent selected line, and subsequent cursors-up retrieve previous lines, back to the first entry, then an empty command line, then the last entry again and so on. An initial cursor-down selects the first entry and goes from there.

Link copied to clipboard

Which command was most recently retrieved by a cursor key since the last command was submitted. -1 indicates no command has been retrieved by a cursor key, or that the entire list has been cycled an integral number of times (and the command line was blanked upon reaching -1).

Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(preferred = true, enumerationValues = ["WindowConstants.DO_NOTHING_ON_CLOSE", "WindowConstants.HIDE_ON_CLOSE", "WindowConstants.DISPOSE_ON_CLOSE", "WindowConstants.EXIT_ON_CLOSE"], description = "The frame's default close operation.")
var defaultCloseOperation: Int
Link copied to clipboard

The documentation path for the Stacks generator.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var font: Font
Link copied to clipboard
Link copied to clipboard

The GlobalEnvironmentSettings for the environment this AvailWorkbench is being launched in.

Link copied to clipboard
val height: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The text field that accepts standard input.

Link copied to clipboard

Whether an entry point invocation (command line) is executing.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The path to the project configuration directory.

Link copied to clipboard
val projectFileFromDisk: AvailProject

Read the AvailProject from disk.

Link copied to clipboard

The directory which is the root of the project.

Link copied to clipboard

The name of the open project.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The AvailRuntime for this workbench to use.

Link copied to clipboard
Link copied to clipboard

When false, roots marked as invisible are not shown. When true, they are shown with an indication that they have been marked invisible.

Link copied to clipboard
override var state: Int
Link copied to clipboard

The stylesheet for rendition of all styled source reachable from this workbench.

Link copied to clipboard

The recognized textual templates available for interactive transformation, as a PrefixTree from template texts to expansion texts.

Link copied to clipboard
Link copied to clipboard

The text area that displays the build transcript.

Link copied to clipboard
@set:BeanProperty(hidden = true, description = "Mechanism for transfer of data into the component")
var transferHandler: TransferHandler
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val width: Int
Link copied to clipboard
open override val workbench: AvailWorkbench

The associated workbench.

Link copied to clipboard

Determine whether the AvailWorkbench or any of its satellite windows are currently focused.

Link copied to clipboard
val x: Int
Link copied to clipboard
val y: Int

Functions

Link copied to clipboard
open fun action(p0: Event, p1: Any): Boolean
Link copied to clipboard
open fun add(p0: PopupMenu)
open fun add(p0: Component): Component
open fun add(p0: Component, p1: Any)
open fun add(p0: Component, p1: Int): Component
open fun add(p0: String, p1: Component): Component
open fun add(p0: Component, p1: Any, p2: Int)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun addNotify()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun areFocusTraversalKeysSet(p0: Int): Boolean
Link copied to clipboard

Backup the availProject file to "availProjectFilePath.backup".

Link copied to clipboard
open fun bounds(): Rectangle
Link copied to clipboard

Execute the provided AbstractBuildTask.

Link copied to clipboard

Re-parse the package structure from scratch. Invoke the provided closure with the module tree and entry points tree, but don't install them. This can safely be run outside the UI thread.

Link copied to clipboard
open fun checkImage(p0: Image, p1: ImageObserver): Int
open fun checkImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Int
Link copied to clipboard

Clear the transcript.

Link copied to clipboard

Close the provided debugger.

Link copied to clipboard

Close the provided editor.

Link copied to clipboard
open operator fun contains(p0: Point): Boolean
open fun contains(p0: Int, p1: Int): Boolean
Link copied to clipboard
open fun countComponents(): Int
Link copied to clipboard
open override fun createBufferStrategy(p0: Int)
open override fun createBufferStrategy(p0: Int, p1: BufferCapabilities)
Link copied to clipboard
open fun createImage(p0: Int, p1: Int): Image
Link copied to clipboard
Link copied to clipboard
open override fun deliverEvent(p0: Event)
Link copied to clipboard
open fun disable()
Link copied to clipboard
Link copied to clipboard
open fun dispose()
Link copied to clipboard
open override fun doLayout()
Link copied to clipboard
open fun enable()
open fun enable(p0: Boolean)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun eventuallyUpdateBuildProgress(position: Long, globalCodeSize: Long)

Ensure the new build position information will eventually be presented to the display.

Link copied to clipboard
fun eventuallyUpdatePerModuleProgress(moduleName: ModuleName, moduleSize: Long, position: Long, line: Int, phrase: () -> A_Phrase?)

Progress has been made at loading a module. Ensure this is presented to the user in the near future.

Link copied to clipboard
open fun findComponentAt(p0: Int, p1: Int): Component
Link copied to clipboard
open fun firePropertyChange(p0: String, p1: Byte, p2: Byte)
open fun firePropertyChange(p0: String, p1: Char, p2: Char)
open fun firePropertyChange(p0: String, p1: Double, p2: Double)
open fun firePropertyChange(p0: String, p1: Float, p2: Float)
open fun firePropertyChange(p0: String, p1: Long, p2: Long)
open fun firePropertyChange(p0: String, p1: Short, p2: Short)
Link copied to clipboard
Link copied to clipboard
open override fun getAlignmentX(): Float
Link copied to clipboard
open override fun getAlignmentY(): Float
Link copied to clipboard
open fun getBaseline(p0: Int, p1: Int): Int
Link copied to clipboard
open fun getBounds(): Rectangle
Link copied to clipboard
Link copied to clipboard
open fun getComponent(p0: Int): Component
Link copied to clipboard
open override fun getComponentAt(p0: Point): Component
open override fun getComponentAt(p0: Int, p1: Int): Component
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun getContentPane(): Container
Link copied to clipboard
open fun getCursorType(): Int
Link copied to clipboard
open fun getExtendedState(): Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun getGlassPane(): Component
Link copied to clipboard
@BeanProperty(bound = false)
open override fun getGraphics(): Graphics
Link copied to clipboard
Link copied to clipboard
open fun getIconImage(): Image
Link copied to clipboard
Link copied to clipboard
open fun getInsets(): Insets
Link copied to clipboard
open fun getJMenuBar(): JMenuBar
Link copied to clipboard
Link copied to clipboard
open override fun getLayeredPane(): JLayeredPane
Link copied to clipboard
Link copied to clipboard
open override fun <T : EventListener> getListeners(p0: Class<T>): Array<T>
Link copied to clipboard
open fun getLocation(): Point
open fun getLocation(p0: Point): Point
Link copied to clipboard
Link copied to clipboard
open override fun getMaximumSize(): Dimension
Link copied to clipboard
open override fun getMinimumSize(): Dimension
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getOwner(): Window
Link copied to clipboard
open override fun getPreferredSize(): Dimension
Link copied to clipboard
fun getProjectRoot(targetRootName: String): AvailProjectRoot?

Answer the AvailProjectRoot for the given AvailProjectRoot.name.

Link copied to clipboard
@BeanProperty(bound = false, hidden = true, description = "the RootPane object for this frame.")
open override fun getRootPane(): JRootPane
Link copied to clipboard
open fun getSize(): Dimension
open fun getSize(p0: Dimension): Dimension
Link copied to clipboard
open override fun getToolkit(): Toolkit
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun gotFocus(p0: Event, p1: Any): Boolean
Link copied to clipboard
open fun handleEvent(p0: Event): Boolean
Link copied to clipboard
open fun hasFocus(): Boolean
Link copied to clipboard
open override fun hide()
Link copied to clipboard
open override fun imageUpdate(p0: Image, p1: Int, p2: Int, p3: Int, p4: Int, p5: Int): Boolean
Link copied to clipboard
Link copied to clipboard
open fun insets(): Insets
Link copied to clipboard
open fun inside(p0: Int, p1: Int): Boolean
Link copied to clipboard
open override fun invalidate()
Link copied to clipboard
open fun isActive(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun isCursorSet(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun isFocusCycleRoot(p0: Container): Boolean
Link copied to clipboard
open fun isFocused(): Boolean
Link copied to clipboard
open fun isFocusOwner(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun isFontSet(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun isOpaque(): Boolean
Link copied to clipboard
Link copied to clipboard
open override fun isShowing(): Boolean
Link copied to clipboard
open override fun isValidateRoot(): Boolean
Link copied to clipboard
open fun keyDown(p0: Event, p1: Int): Boolean
Link copied to clipboard
open fun keyUp(p0: Event, p1: Int): Boolean
Link copied to clipboard
open override fun layout()
Link copied to clipboard
open fun list()
open fun list(p0: PrintStream)
open fun list(p0: PrintWriter)
open override fun list(p0: PrintStream, p1: Int)
open override fun list(p0: PrintWriter, p1: Int)
Link copied to clipboard
open override fun locate(p0: Int, p1: Int): Component
Link copied to clipboard
open fun location(): Point
Link copied to clipboard
open fun lostFocus(p0: Event, p1: Any): Boolean
Link copied to clipboard
open override fun minimumSize(): Dimension
Link copied to clipboard
open fun mouseDown(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun mouseDrag(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun mouseEnter(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun mouseExit(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun mouseMove(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun mouseUp(p0: Event, p1: Int, p2: Int): Boolean
Link copied to clipboard
open fun move(p0: Int, p1: Int)
Link copied to clipboard
fun navigateToDefinitionsOfName(nameInModule: NameInModule, tokenIndexInName: Int, mouseEvent: MouseEvent)

The user has clicked on a token in the source in such a way that they are requesting navigation related to the method name containing that token. Begin an asynchronous action to locate all definitions of the name in all visible modules that have been compiled since their last change.

Link copied to clipboard
fun navigateToSendersOfName(nameInModule: NameInModule, tokenIndexInName: Int, mouseEvent: MouseEvent)

The user has clicked on a token in the source in such a way that they are requesting navigation to places that send that method. Begin an asynchronous action to locate all usages of the name in all visible modules that have been compiled since their last change.

Link copied to clipboard
open fun nextFocus()
Link copied to clipboard
Link copied to clipboard
open fun pack()
Link copied to clipboard
open override fun paint(p0: Graphics)
Link copied to clipboard
open fun paintAll(p0: Graphics)
Link copied to clipboard
Link copied to clipboard
open override fun postEvent(p0: Event): Boolean
Link copied to clipboard
open override fun preferredSize(): Dimension
Link copied to clipboard
open fun prepareImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Boolean
Link copied to clipboard
open override fun print(p0: Graphics)
Link copied to clipboard
open fun printAll(p0: Graphics)
Link copied to clipboard
Link copied to clipboard
fun refresh()

Refresh the tree of modules and tree of entry points. Use the existing tree structure, and just force it to update the presentation of each node.

Link copied to clipboard

Re-populate the visible tree structures based on the provided tree of modules and tree of entry points. Attempt to preserve selection and expansion information.

Link copied to clipboard
open fun remove(p0: Int)
open override fun remove(p0: MenuComponent)
open override fun remove(p0: Component)
Link copied to clipboard
open fun removeAll()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun removeNotify()
Link copied to clipboard
Link copied to clipboard
open fun repaint()
open fun repaint(p0: Long)
open fun repaint(p0: Int, p1: Int, p2: Int, p3: Int)
open override fun repaint(p0: Long, p1: Int, p2: Int, p3: Int, p4: Int)
Link copied to clipboard
Link copied to clipboard
open override fun reshape(p0: Int, p1: Int, p2: Int, p3: Int)
Link copied to clipboard
open fun resize(p0: Dimension)
open fun resize(p0: Int, p1: Int)
Link copied to clipboard
open fun revalidate()
Link copied to clipboard

Save the availProject to disk in availProjectFilePath.

Link copied to clipboard

Either places the given component inside a JScrollPane or answers the JScrollPane that it's already inside.

Link copied to clipboard

Answer the currently selected entry point, or null if none.

Link copied to clipboard

Answer the resolved name of the module selected in the entryPointsTree, or the module defining the entry point that's selected, or null if none.

Link copied to clipboard

Answer the name of the currently selected module.

Link copied to clipboard
fun selectedModuleLocalSettings(): LocalSettings?

Answer the LocalSettings for the ModuleRoot of the currently selected module.

Link copied to clipboard

Answer the qualified name of the currently selected module.

Link copied to clipboard

Answer the ModuleRoot that is currently selected, otherwise null.

Link copied to clipboard
open override fun setBounds(p0: Rectangle)
open override fun setBounds(p0: Int, p1: Int, p2: Int, p3: Int)
Link copied to clipboard
open fun setComponentZOrder(p0: Component, p1: Int)
Link copied to clipboard
@BeanProperty(bound = false, hidden = true, description = "The client area of the frame where child components are normally inserted.")
open override fun setContentPane(p0: Container)
Link copied to clipboard
open fun setCursor(p0: Int)
Link copied to clipboard

Enable or disable controls and menu items based on the current state.

Link copied to clipboard
open fun setExtendedState(p0: Int)
Link copied to clipboard
open override fun setFocusTraversalKeys(p0: Int, p1: MutableSet<out AWTKeyStroke>)
Link copied to clipboard
@BeanProperty(bound = false, hidden = true, description = "A transparent pane used for menu rendering.")
open override fun setGlassPane(p0: Component)
Link copied to clipboard
open override fun setIconImage(p0: Image)
Link copied to clipboard
open fun setIconImages(p0: MutableList<out Image>)
Link copied to clipboard
@BeanProperty(bound = false, hidden = true, description = "The menubar for accessing pulldown menus from this frame.")
open fun setJMenuBar(p0: JMenuBar)
Link copied to clipboard
@BeanProperty(bound = false, hidden = true, description = "The pane that holds the various frame layers.")
open override fun setLayeredPane(p0: JLayeredPane)
Link copied to clipboard
open override fun setLayout(p0: LayoutManager)
Link copied to clipboard
open override fun setLocation(p0: Point)
open override fun setLocation(p0: Int, p1: Int)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun setMinimumSize(p0: Dimension)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun setSize(p0: Dimension)
open override fun setSize(p0: Int, p1: Int)
Link copied to clipboard
open fun show(p0: Boolean)
open override fun show()
Link copied to clipboard
open fun size(): Dimension
Link copied to clipboard
open fun toBack()
Link copied to clipboard
open fun toFront()
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun transferFocus()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun update(p0: Graphics)
Link copied to clipboard
open override fun validate()
Link copied to clipboard
fun writeText(text: String, streamStyle: StreamStyle)

Write text to the transcript with the given StreamStyle.