Screen
A Screen is an in-memory representation of a TileGrid which can be displayed using an actual TileGrid. Careful! Only one Screen can be display
ed at a given time. If Screen.display is called on a non-active Screen it will become active and the previous one will be deactivated.
Use Screens to have multiple views for your app, which can be displayed one at a time.
Screens also implement the ComponentContainer interface which means that if you want to use Components you'll have to use Screens.
Types
Functions
addComponent
Link copied to clipboard
addComponents
Link copied to clipboard
open fun addComponents(vararg components: Builder<Component>): List<AttachedComponent>
Content copied to clipboard
open fun addComponents(vararg components: Component): List<AttachedComponent>
Content copied to clipboard
addFragment
Link copied to clipboard
addFragments
Link copied to clipboard
open fun addFragments(vararg fragments: Fragment): List<AttachedComponent>
Content copied to clipboard
addLayer
Link copied to clipboard
applyStyle
Link copied to clipboard
dock
Link copied to clipboard
draw
Link copied to clipboard
Same as draw with 3 parameters, with the difference that size will be used for
drawArea
, and Position.zero as drawPosition
abstract fun draw(tileComposite: TileComposite, drawPosition: Position, drawArea: Size)
Content copied to clipboard
fill
Link copied to clipboard
getLayerAt
Link copied to clipboard
getTileAtOrNull
Link copied to clipboard
handleKeyboardEvents
Link copied to clipboard
abstract fun handleKeyboardEvents(eventType: KeyboardEventType, handler: (event: KeyboardEvent, phase: UIEventPhase) -> UIEventResponse): Subscription
Content copied to clipboard
handleMouseEvents
Link copied to clipboard
abstract fun handleMouseEvents(eventType: MouseEventType, handler: (event: MouseEvent, phase: UIEventPhase) -> UIEventResponse): Subscription
Content copied to clipboard
insertLayerAt
Link copied to clipboard
moveCursorBackward
Link copied to clipboard
abstract fun moveCursorBackward()
Content copied to clipboard
Moves the cursor one Position to the left.
moveCursorForward
Link copied to clipboard
abstract fun moveCursorForward()
Content copied to clipboard
Moves the cursor one Position to the right.
onShutdown
Link copied to clipboard
openModal
Link copied to clipboard
processKeyboardEvents
Link copied to clipboard
abstract fun processKeyboardEvents(eventType: KeyboardEventType, handler: (event: KeyboardEvent, phase: UIEventPhase) -> Unit): Subscription
Content copied to clipboard
processMouseEvents
Link copied to clipboard
abstract fun processMouseEvents(eventType: MouseEventType, handler: (event: MouseEvent, phase: UIEventPhase) -> Unit): Subscription
Content copied to clipboard
setLayerAt
Link copied to clipboard
Properties
closedValue
Link copied to clipboard
cursorPosition
Link copied to clipboard
heightInPixels
Link copied to clipboard
isCursorAtTheEndOfTheLine
Link copied to clipboard
isCursorAtTheFirstRow
Link copied to clipboard
isCursorAtTheLastRow
Link copied to clipboard
isCursorAtTheStartOfTheLine
Link copied to clipboard
isCursorVisible
Link copied to clipboard
theme
Link copied to clipboard
themeProperty
Link copied to clipboard
tileset
Link copied to clipboard
tilesetProperty
Link copied to clipboard
widthInPixels
Link copied to clipboard
Inheritors
InternalScreen
Link copied to clipboard
Sources
(source)
Link copied to clipboard