ProgressBarBuilder

class ProgressBarBuilder(range: Int, numberOfSteps: Int, displayPercentValueOfProgress: Boolean) : BaseComponentBuilder<ProgressBar, ProgressBarBuilder>

Builder for the progress bar. By default, it creates a progress bar with a maxValue of 100 and 10 steps.

Constructors

ProgressBarBuilder
Link copied to clipboard
common
fun ProgressBarBuilder(range: Int = 100, numberOfSteps: Int = 10, displayPercentValueOfProgress: Boolean = false)

Types

Companion
Link copied to clipboard
common
object Companion

Functions

build
Link copied to clipboard
common
open override fun build(): ProgressBar
Builds an object of type T.
createCopy
Link copied to clipboard
common
open override fun createCopy(): ProgressBarBuilder
Creates a deep copy of this object.
equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
toString
Link copied to clipboard
common
open fun toString(): String
withAlignment
Link copied to clipboard
common
open override fun withAlignment(alignmentStrategy: AlignmentStrategy): ProgressBarBuilder
Sets the AlignmentStrategy to use for the Component.
withAlignmentAround
Link copied to clipboard
common
open fun withAlignmentAround(component: Component, alignment: ComponentAlignment): ProgressBarBuilder
Aligns the resulting Component around the component using the given alignment.
withAlignmentWithin
Link copied to clipboard
common
open fun withAlignmentWithin(container: Container, alignment: ComponentAlignment): ProgressBarBuilder
Aligns the resulting Component within the container using the given alignment.
open fun withAlignmentWithin(tileGrid: TileGrid, alignment: ComponentAlignment): ProgressBarBuilder
Aligns the resulting Component within the tileGrid using the given alignment.
withColorTheme
Link copied to clipboard
common
open override fun withColorTheme(colorTheme: ColorTheme): ProgressBarBuilder
Sets the ColorTheme to use for the Component.
withComponentRenderer
Link copied to clipboard
common
open override fun withComponentRenderer(componentRenderer: ComponentRenderer<ProgressBar>): ProgressBarBuilder
Sets the ComponentRenderer for the resulting Component.
withComponentStyleSet
Link copied to clipboard
common
open override fun withComponentStyleSet(componentStyleSet: ComponentStyleSet): ProgressBarBuilder
Sets the ComponentStyleSet the Component will use.
withDecorations
Link copied to clipboard
common
open override fun withDecorations(vararg renderers: ComponentDecorationRenderer): ProgressBarBuilder
Sets the ComponentDecorationRenderers for the resulting Component.
withDisplayPercentValueOfProgress
Link copied to clipboard
common
fun withDisplayPercentValueOfProgress(displayPercentValueOfProgress: Boolean): ProgressBarBuilder
withNumberOfSteps
Link copied to clipboard
common
fun withNumberOfSteps(steps: Int): ProgressBarBuilder
withPosition
Link copied to clipboard
common
open fun withPosition(position: Position): ProgressBarBuilder
Aligns the resulting Component positionally, relative to its parent.
open fun withPosition(x: Int, y: Int): ProgressBarBuilder
Aligns the resulting Component positionally, relative to its parent.
withRange
Link copied to clipboard
common
fun withRange(range: Int): ProgressBarBuilder
withRendererFunction
Link copied to clipboard
common
open override fun withRendererFunction(fn: (TileGraphics, ComponentRenderContext<ProgressBar>) -> Unit): ProgressBarBuilder
Creates a ComponentRenderer for the resulting Component using the given component renderer fn.
withSize
Link copied to clipboard
common
open override fun withSize(size: Size): ProgressBarBuilder
Sets the Size of the resulting Component.
open fun withSize(width: Int, height: Int): ProgressBarBuilder
Sets the Size of the resulting Component.
withTileset
Link copied to clipboard
common
open override fun withTileset(tileset: TilesetResource): ProgressBarBuilder
Sets the Tileset to use for the Component.
withUpdateOnAttach
Link copied to clipboard
common
open override fun withUpdateOnAttach(updateOnAttach: Boolean): ProgressBarBuilder
Sets if the Component should be updated when it is attached to a parent or not.

Properties

colorTheme
Link copied to clipboard
common
val colorTheme: ColorTheme?
componentRenderer
Link copied to clipboard
common
val componentRenderer: ComponentRenderer<out ProgressBar>
componentStyleSet
Link copied to clipboard
common
val componentStyleSet: ComponentStyleSet
decorationRenderers
Link copied to clipboard
common
val decorationRenderers: List<ComponentDecorationRenderer>
position
Link copied to clipboard
common
val position: Position
size
Link copied to clipboard
common
val size: Size
tileset
Link copied to clipboard
common
val tileset: TilesetResource
title
Link copied to clipboard
common
val title: String
updateOnAttach
Link copied to clipboard
common
val updateOnAttach: Boolean

Sources

(source)
Link copied to clipboard