avail/avail.anvil/AvailEditor

AvailEditor

class AvailEditor(val workbench: AvailWorkbench, val moduleName: ModuleName, afterTextLoaded: (AvailEditor) -> Unit = {}) : WorkbenchFrame

An editor for an Avail source module. Currently supports:

Basic editing.
Basic undo/redo.
Template expansion, with prefix shortening and explicit single caret positioning.
Syntax highlighting.
Go to line/column.
Open structure view.

Author

Mark van Gulik

Todd L Smith

Parameters

workbench

The owning AvailWorkbench.

moduleName

The ModuleName of the module being opened in the editor.

afterTextLoaded

Action to perform after text has been loaded to sourcePane.

Constructors

AvailEditor

constructor(workbench: AvailWorkbench, moduleName: ModuleName, afterTextLoaded: (AvailEditor) -> Unit = {})

Construct an AvailEditor.

Types

Companion

object Companion

ManifestEntryInDocument

data class ManifestEntryInDocument(val entry: ModuleManifestEntry, val startInDocument: Position)

A class that maintains the position of a ModuleManifestEntry even as the underlying StyledDocument is edited.

Properties

alwaysOnTop

var alwaysOnTop: Boolean

autoRequestFocus

var autoRequestFocus: Boolean

background

var background: Color

bufferStrategy

val bufferStrategy: BufferStrategy

componentOrientation

var componentOrientation: ComponentOrientation

cursor

var cursor: Cursor

defaultCloseOperation

@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

dropTarget

var dropTarget: DropTarget

enabled

var enabled: Boolean

focusable

var focusable: Boolean

focusableWindowState

var focusableWindowState: Boolean

focusCycleRoot

var focusCycleRoot: Boolean

focusTraversalKeysEnabled

var focusTraversalKeysEnabled: Boolean

focusTraversalPolicy

var focusTraversalPolicy: FocusTraversalPolicy

focusTraversalPolicyProvider

var focusTraversalPolicyProvider: Boolean

font

var font: Font

foreground

var foreground: Color

height

val height: Int

ignoreRepaint

var ignoreRepaint: Boolean

inputContext

val inputContext: InputContext

locale

var locale: Locale

locationByPlatform

var locationByPlatform: Boolean

maximizedBounds

var maximizedBounds: Rectangle

menuBar

var menuBar: MenuBar

modalExclusionType

var modalExclusionType: Dialog.ModalExclusionType

moduleName

val moduleName: ModuleName

name

var name: String

opacity

var opacity: Float

parent

val parent: Container

resizable

var resizable: Boolean

shape

var shape: Shape

state

override var state: Int

title

var title: String

transferHandler

@set:BeanProperty(hidden = true, description = "Mechanism for transfer of data into the component")

var transferHandler: TransferHandler

type

var type: Window.Type

undecorated

var undecorated: Boolean

valid

val valid: Boolean

visible

var visible: Boolean

warningString

val warningString: String

width

val width: Int

workbench

open override val workbench: AvailWorkbench

val x: Int

val y: Int

Functions

action

open fun ~~action~~(p0: Event, p1: Any): Boolean

add

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)

addComponentListener

open fun addComponentListener(p0: ComponentListener)

addContainerListener

open fun addContainerListener(p0: ContainerListener)

addFocusListener

open fun addFocusListener(p0: FocusListener)

addHierarchyBoundsListener

open fun addHierarchyBoundsListener(p0: HierarchyBoundsListener)

addHierarchyListener

open fun addHierarchyListener(p0: HierarchyListener)

addInputMethodListener

open fun addInputMethodListener(p0: InputMethodListener)

addKeyListener

open fun addKeyListener(p0: KeyListener)

addMouseListener

open fun addMouseListener(p0: MouseListener)

addMouseMotionListener

open fun addMouseMotionListener(p0: MouseMotionListener)

addMouseWheelListener

open fun addMouseWheelListener(p0: MouseWheelListener)

addNotify

open override fun addNotify()

addPropertyChangeListener

open override fun addPropertyChangeListener(p0: PropertyChangeListener)

open override fun addPropertyChangeListener(p0: String, p1: PropertyChangeListener)

addWindowFocusListener

open fun addWindowFocusListener(p0: WindowFocusListener)

addWindowListener

open fun addWindowListener(p0: WindowListener)

addWindowStateListener

open fun addWindowStateListener(p0: WindowStateListener)

applyComponentOrientation

open override fun applyComponentOrientation(p0: ComponentOrientation)

applyResourceBundle

open fun ~~applyResourceBundle~~(p0: ResourceBundle)

open fun ~~applyResourceBundle~~(p0: String)

areFocusTraversalKeysSet

open override fun areFocusTraversalKeysSet(p0: Int): Boolean

bounds

open fun ~~bounds~~(): Rectangle

checkImage

open fun checkImage(p0: Image, p1: ImageObserver): Int

open fun checkImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Int

contains

open operator fun contains(p0: Point): Boolean

open fun contains(p0: Int, p1: Int): Boolean

countComponents

open fun ~~countComponents~~(): Int

createBufferStrategy

open override fun createBufferStrategy(p0: Int)

open override fun createBufferStrategy(p0: Int, p1: BufferCapabilities)

createImage

open fun createImage(p0: ImageProducer): Image

open fun createImage(p0: Int, p1: Int): Image

createVolatileImage

open fun createVolatileImage(p0: Int, p1: Int): VolatileImage

open fun createVolatileImage(p0: Int, p1: Int, p2: ImageCapabilities): VolatileImage

deliverEvent

open override fun ~~deliverEvent~~(p0: Event)

disable

open fun ~~disable~~()

dispatchEvent

fun dispatchEvent(p0: AWTEvent)

dispose

open fun dispose()

doLayout

open override fun doLayout()

enable

open fun ~~enable~~()

open fun ~~enable~~(p0: Boolean)

enableInputMethods

open fun enableInputMethods(p0: Boolean)

findComponentAt

open fun findComponentAt(p0: Point): Component

open fun findComponentAt(p0: Int, p1: Int): Component

firePropertyChange

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)

getAccessibleContext

open override fun getAccessibleContext(): AccessibleContext

getAlignmentX

open override fun getAlignmentX(): Float

getAlignmentY

open override fun getAlignmentY(): Float

getBaseline

open fun getBaseline(p0: Int, p1: Int): Int

getBaselineResizeBehavior

open fun getBaselineResizeBehavior(): Component.BaselineResizeBehavior

getBounds

open fun getBounds(): Rectangle

open fun getBounds(p0: Rectangle): Rectangle

getColorModel

open fun getColorModel(): ColorModel

getComponent

open fun getComponent(p0: Int): Component

getComponentAt

open override fun getComponentAt(p0: Point): Component

open override fun getComponentAt(p0: Int, p1: Int): Component

getComponentCount

open fun getComponentCount(): Int

getComponentListeners

open fun getComponentListeners(): Array<ComponentListener>

getComponents

open fun getComponents(): Array<Component>

getComponentZOrder

open fun getComponentZOrder(p0: Component): Int

getContainerListeners

open fun getContainerListeners(): Array<ContainerListener>

getContentPane

open override fun getContentPane(): Container

getCursorType

open fun ~~getCursorType~~(): Int

getExtendedState

open fun getExtendedState(): Int

getFocusCycleRootAncestor

override fun getFocusCycleRootAncestor(): Container

getFocusListeners

open fun getFocusListeners(): Array<FocusListener>

getFocusOwner

open fun getFocusOwner(): Component

getFocusTraversalKeys

open override fun getFocusTraversalKeys(p0: Int): MutableSet<AWTKeyStroke>

getFontMetrics

open fun getFontMetrics(p0: Font): FontMetrics

getGlassPane

open override fun getGlassPane(): Component

getGraphics

@BeanProperty(bound = false)

open override fun getGraphics(): Graphics

getGraphicsConfiguration

open fun getGraphicsConfiguration(): GraphicsConfiguration

getHierarchyBoundsListeners

open fun getHierarchyBoundsListeners(): Array<HierarchyBoundsListener>

getHierarchyListeners

open fun getHierarchyListeners(): Array<HierarchyListener>

getIconImage

open fun getIconImage(): Image

getIconImages

open fun getIconImages(): MutableList<Image>

getInputMethodListeners

open fun getInputMethodListeners(): Array<InputMethodListener>

getInputMethodRequests

open fun getInputMethodRequests(): InputMethodRequests

getInsets

open fun getInsets(): Insets

getJMenuBar

open fun getJMenuBar(): JMenuBar

getKeyListeners

open fun getKeyListeners(): Array<KeyListener>

getLayeredPane

open override fun getLayeredPane(): JLayeredPane

getLayout

open fun getLayout(): LayoutManager

getListeners

open override fun <T : EventListener> getListeners(p0: Class<T>): Array<T>

getLocation

open fun getLocation(): Point

open fun getLocation(p0: Point): Point

getLocationOnScreen

open fun getLocationOnScreen(): Point

getMaximumSize

open override fun getMaximumSize(): Dimension

getMinimumSize

open override fun getMinimumSize(): Dimension

getMostRecentFocusOwner

open fun getMostRecentFocusOwner(): Component

getMouseListeners

open fun getMouseListeners(): Array<MouseListener>

getMouseMotionListeners

open fun getMouseMotionListeners(): Array<MouseMotionListener>

getMousePosition

open fun getMousePosition(): Point

open fun getMousePosition(p0: Boolean): Point

getMouseWheelListeners

open fun getMouseWheelListeners(): Array<MouseWheelListener>

getOwnedWindows

open fun getOwnedWindows(): Array<Window>

getOwner

open fun getOwner(): Window

getPreferredSize

open override fun getPreferredSize(): Dimension

getPropertyChangeListeners

open fun getPropertyChangeListeners(): Array<PropertyChangeListener>

open fun getPropertyChangeListeners(p0: String): Array<PropertyChangeListener>

getRootPane

@BeanProperty(bound = false, hidden = true, description = "the RootPane object for this frame.")

open override fun getRootPane(): JRootPane

getSize

open fun getSize(): Dimension

open fun getSize(p0: Dimension): Dimension

getToolkit

open override fun getToolkit(): Toolkit

getTreeLock

fun getTreeLock(): Any

getWindowFocusListeners

open fun getWindowFocusListeners(): Array<WindowFocusListener>

getWindowListeners

open fun getWindowListeners(): Array<WindowListener>

getWindowStateListeners

open fun getWindowStateListeners(): Array<WindowStateListener>

gotFocus

open fun ~~gotFocus~~(p0: Event, p1: Any): Boolean

handleEvent

open fun ~~handleEvent~~(p0: Event): Boolean

hasFocus

open fun hasFocus(): Boolean

hide

open override fun ~~hide~~()

imageUpdate

open override fun imageUpdate(p0: Image, p1: Int, p2: Int, p3: Int, p4: Int, p5: Int): Boolean

insets

open fun ~~insets~~(): Insets

inside

open fun ~~inside~~(p0: Int, p1: Int): Boolean

invalidate

open override fun invalidate()

isActive

open fun isActive(): Boolean

isAlwaysOnTopSupported

open fun isAlwaysOnTopSupported(): Boolean

isAncestorOf

open fun isAncestorOf(p0: Component): Boolean

isBackgroundSet

open fun isBackgroundSet(): Boolean

isCursorSet

open fun isCursorSet(): Boolean

isDisplayable

open fun isDisplayable(): Boolean

isDoubleBuffered

open fun isDoubleBuffered(): Boolean

isFocusableWindow

fun isFocusableWindow(): Boolean

isFocusCycleRoot

open override fun isFocusCycleRoot(p0: Container): Boolean

isFocused

open fun isFocused(): Boolean

isFocusOwner

open fun isFocusOwner(): Boolean

isFocusTraversable

open fun ~~isFocusTraversable~~(): Boolean

isFocusTraversalPolicySet

open fun isFocusTraversalPolicySet(): Boolean

isFontSet

open fun isFontSet(): Boolean

isForegroundSet

open fun isForegroundSet(): Boolean

isLightweight

open fun isLightweight(): Boolean

isMaximumSizeSet

open fun isMaximumSizeSet(): Boolean

isMinimumSizeSet

open fun isMinimumSizeSet(): Boolean

isOpaque

open override fun isOpaque(): Boolean

isPreferredSizeSet

open fun isPreferredSizeSet(): Boolean

isShowing

open override fun isShowing(): Boolean

isValidateRoot

open override fun isValidateRoot(): Boolean

keyDown

open fun ~~keyDown~~(p0: Event, p1: Int): Boolean

keyUp

open fun ~~keyUp~~(p0: Event, p1: Int): Boolean

layout

open override fun ~~layout~~()

list

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)

locate

open override fun ~~locate~~(p0: Int, p1: Int): Component

location

open fun ~~location~~(): Point

lostFocus

open fun ~~lostFocus~~(p0: Event, p1: Any): Boolean

minimumSize

open override fun ~~minimumSize~~(): Dimension

mouseDown

open fun ~~mouseDown~~(p0: Event, p1: Int, p2: Int): Boolean

mouseDrag

open fun ~~mouseDrag~~(p0: Event, p1: Int, p2: Int): Boolean

mouseEnter

open fun ~~mouseEnter~~(p0: Event, p1: Int, p2: Int): Boolean

mouseExit

open fun ~~mouseExit~~(p0: Event, p1: Int, p2: Int): Boolean

mouseMove

open fun ~~mouseMove~~(p0: Event, p1: Int, p2: Int): Boolean

mouseUp

open fun ~~mouseUp~~(p0: Event, p1: Int, p2: Int): Boolean

move

open fun ~~move~~(p0: Int, p1: Int)

nextFocus

open fun ~~nextFocus~~()

openPhraseView

fun openPhraseView()

Open the PhraseView associated with this AvailEditor, if it's not already visible.

openStructureView

fun openStructureView(giveEditorFocus: Boolean = true)

Open the StructureView associated with this AvailEditor.

pack

open fun pack()

paint

open override fun paint(p0: Graphics)

paintAll

open fun paintAll(p0: Graphics)

paintComponents

open fun paintComponents(p0: Graphics)

postEvent

open override fun ~~postEvent~~(p0: Event): Boolean

preferredSize

open override fun ~~preferredSize~~(): Dimension

prepareImage

open fun prepareImage(p0: Image, p1: ImageObserver): Boolean

open fun prepareImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Boolean

open override fun print(p0: Graphics)

printAll

open fun printAll(p0: Graphics)

printComponents

open fun printComponents(p0: Graphics)

refreshShortcuts

fun refreshShortcuts()

Refresh the KeyboardShortcuts for this AvailEditor.

remove

open fun remove(p0: Int)

open override fun remove(p0: MenuComponent)

open override fun remove(p0: Component)

removeAll

open fun removeAll()

removeComponentListener

open fun removeComponentListener(p0: ComponentListener)

removeContainerListener

open fun removeContainerListener(p0: ContainerListener)

removeFocusListener

open fun removeFocusListener(p0: FocusListener)

removeHierarchyBoundsListener

open fun removeHierarchyBoundsListener(p0: HierarchyBoundsListener)

removeHierarchyListener

open fun removeHierarchyListener(p0: HierarchyListener)

removeInputMethodListener

open fun removeInputMethodListener(p0: InputMethodListener)

removeKeyListener

open fun removeKeyListener(p0: KeyListener)

removeMouseListener

open fun removeMouseListener(p0: MouseListener)

removeMouseMotionListener

open fun removeMouseMotionListener(p0: MouseMotionListener)

removeMouseWheelListener

open fun removeMouseWheelListener(p0: MouseWheelListener)

removeNotify

open override fun removeNotify()

removePropertyChangeListener

open fun removePropertyChangeListener(p0: PropertyChangeListener)

open fun removePropertyChangeListener(p0: String, p1: PropertyChangeListener)

removeWindowFocusListener

open fun removeWindowFocusListener(p0: WindowFocusListener)

removeWindowListener

open fun removeWindowListener(p0: WindowListener)

removeWindowStateListener

open fun removeWindowStateListener(p0: WindowStateListener)

repaint

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)

requestFocus

open fun requestFocus()

open fun requestFocus(p0: FocusEvent.Cause)

requestFocusInWindow

open fun requestFocusInWindow(): Boolean

open fun requestFocusInWindow(p0: FocusEvent.Cause): Boolean

reshape

open override fun ~~reshape~~(p0: Int, p1: Int, p2: Int, p3: Int)

resize

open fun ~~resize~~(p0: Dimension)

open fun ~~resize~~(p0: Int, p1: Int)

revalidate

open fun revalidate()

scroll

fun Component.scroll(): JScrollPane

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

setBounds

open override fun setBounds(p0: Rectangle)

open override fun setBounds(p0: Int, p1: Int, p2: Int, p3: Int)

setComponentZOrder

open fun setComponentZOrder(p0: Component, p1: Int)

setContentPane

@BeanProperty(bound = false, hidden = true, description = "The client area of the frame where child components are normally inserted.")

open override fun setContentPane(p0: Container)

setCursor

open fun ~~setCursor~~(p0: Int)

setExtendedState

open fun setExtendedState(p0: Int)

setFocusTraversalKeys

open override fun setFocusTraversalKeys(p0: Int, p1: MutableSet<out AWTKeyStroke>)

setGlassPane

@BeanProperty(bound = false, hidden = true, description = "A transparent pane used for menu rendering.")

open override fun setGlassPane(p0: Component)

setIconImage

open override fun setIconImage(p0: Image)

setIconImages

open fun setIconImages(p0: MutableList<out Image>)

setJMenuBar

@BeanProperty(bound = false, hidden = true, description = "The menubar for accessing pulldown menus from this frame.")

open fun setJMenuBar(p0: JMenuBar)

setLayeredPane

@BeanProperty(bound = false, hidden = true, description = "The pane that holds the various frame layers.")

open override fun setLayeredPane(p0: JLayeredPane)

setLayout

open override fun setLayout(p0: LayoutManager)

setLocation

open override fun setLocation(p0: Point)

open override fun setLocation(p0: Int, p1: Int)

setLocationRelativeTo

open fun setLocationRelativeTo(p0: Component)

setMaximumSize

open fun setMaximumSize(p0: Dimension)

setMinimumSize

open override fun setMinimumSize(p0: Dimension)

setMixingCutoutShape

open fun setMixingCutoutShape(p0: Shape)

setPreferredSize

open fun setPreferredSize(p0: Dimension)

setSize

open override fun setSize(p0: Dimension)

open override fun setSize(p0: Int, p1: Int)

show

open fun ~~show~~(p0: Boolean)

open override fun ~~show~~()

size

open fun ~~size~~(): Dimension

toBack

open fun toBack()

toFront

open fun toFront()

toString

open override fun toString(): String

transferFocus

open fun transferFocus()

transferFocusBackward

open fun transferFocusBackward()

transferFocusDownCycle

open fun transferFocusDownCycle()

transferFocusUpCycle

open fun transferFocusUpCycle()

update

open override fun update(p0: Graphics)

updatePhraseStructure

fun updatePhraseStructure()

Compute the sequence of nested send phrases that describe how the selected token ended up being embedded in the final parse structure. Update the AvailWorkbench.phraseView to show this information.

validate

open override fun validate()