mordant/com.github.ajalt.mordant.animation.progress

Package-level declarations

Types

BaseBlockingAnimator

class BaseBlockingAnimator(terminal: Terminal, animation: RefreshableAnimation) : BlockingAnimator

BlockingAnimator

interface BlockingAnimator : RefreshableAnimation

BlockingProgressBarAnimation

class BlockingProgressBarAnimation : ProgressBarAnimation, BlockingAnimator

MultiProgressBarAnimation

class MultiProgressBarAnimation(val terminal: Terminal, clearWhenFinished: Boolean = false, speedEstimateDuration: Duration = 30.seconds, maker: ProgressBarWidgetMaker = MultiProgressBarWidgetMaker, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic) : RefreshableAnimation, ProgressBarAnimation

ProgressBarAnimation

interface ProgressBarAnimation : Refreshable

An animation that can draw one or more progress tasks to the screen.

interface ProgressTask<T>

ProgressTaskUpdateScope

interface ProgressTaskUpdateScope<T>

ThreadProgressAnimator

interface ThreadProgressAnimator : BlockingAnimator, ProgressBarAnimation

A BlockingAnimator for a ProgressBarAnimation.

ThreadProgressTaskAnimator

interface ThreadProgressTaskAnimator<T> : BlockingAnimator, ProgressTask<T>

A BlockingAnimator for a single task.

Functions

fun ProgressBarAnimation.addTask(definition: ProgressBarDefinition<Unit>, total: Long? = null, completed: Long = 0, start: Boolean = true, visible: Boolean = true): ProgressTask<Unit>

Add a new task to the progress bar with the given definition.

fun ProgressTask<*>.advance(amount: Long = 1)

fun ProgressTask<*>.advance(amount: Number)

Advance the completed progress of this task by amount.

animateOnThread

fun MultiProgressBarAnimation.animateOnThread(): ThreadProgressAnimator

fun RefreshableAnimation.animateOnThread(terminal: Terminal): BlockingAnimator

inline fun Animation<Unit>.animateOnThread(fps: Int = 30, crossinline finished: () -> Boolean = { false }): BlockingAnimator

Create an animator that runs this animation synchronously.

fun ProgressBarDefinition<Unit>.animateOnThread(terminal: Terminal, total: Long? = null, completed: Long = 0, start: Boolean = true, visible: Boolean = true, clearWhenFinished: Boolean = false, speedEstimateDuration: Duration = 30.seconds, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic, maker: ProgressBarWidgetMaker = MultiProgressBarWidgetMaker): ThreadProgressTaskAnimator<Unit>

Create a progress bar animation for a single task that runs synchronously.

fun <T> ProgressBarDefinition<T>.animateOnThread(terminal: Terminal, context: T, total: Long? = null, completed: Long = 0, start: Boolean = true, visible: Boolean = true, clearWhenFinished: Boolean = false, speedEstimateDuration: Duration = 30.seconds, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic, maker: ProgressBarWidgetMaker = MultiProgressBarWidgetMaker): ThreadProgressTaskAnimator<T>

Create a progress bar animation with a single task that runs synchronously.

fun BlockingAnimator.execute(executor: ExecutorService = Executors.newSingleThreadExecutor(DaemonThreadFactory())): Future<*>

Run the animation in a background thread on an executor.

fun ProgressBarAnimation.removeTask(task: ProgressTask<*>): Boolean

Remove a task from the progress bar.

fun ProgressTask<*>.update(completed: Long)

fun ProgressTask<*>.update(completed: Number)

Set the completed progress of this task to completed.