aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin/pl/treksoft/kvision/progress/ProgressIndicator.kt
blob: 256d15d74b3bbb9eba11ec8100da5b9776089420 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
 * Copyright (c) 2017-present Robert Jaros
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package pl.treksoft.kvision.progress

import pl.treksoft.kvision.core.StringBoolPair
import pl.treksoft.kvision.core.StringPair
import pl.treksoft.kvision.html.Align
import pl.treksoft.kvision.html.Div
import pl.treksoft.kvision.utils.perc

/**
 * Progress bar styles.
 */
enum class ProgressBarStyle(internal val className: String) {
    SUCCESS("progress-bar-success"),
    INFO("progress-bar-info"),
    WARNING("progress-bar-warning"),
    DANGER("progress-bar-danger")
}

internal const val DEFAULT_MIN = 0
internal const val DEFAULT_MAX = 100


/**
 * The Bootstrap progress bar indicator.
 *
 * @constructor
 * @param progress the current progress
 * @param min the minimal progress
 * @param max the maximal progress
 * @param style the style of the progress bar indicator
 * @param striped determines if the progress bar indicator is striped
 * @param animated determines if the progress bar indicator is animated
 * @param content element text
 * @param rich determines if [content] can contain HTML code
 * @param align content align
 * @param classes a set of CSS class names
 */
internal class ProgressIndicator(
    progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null,
    striped: Boolean = false, animated: Boolean = false,
    content: String? = null, rich: Boolean = false, align: Align? = null,
    classes: Set<String> = setOf()
) :
    Div(content, rich, align, classes) {

    /**
     * The current progress.
     */
    var progress by refreshOnUpdate(progress) { refreshWidth() }
    /**
     * The minimal progress.
     */
    var min by refreshOnUpdate(min) { refreshWidth() }
    /**
     * The maximal progress.
     */
    var max by refreshOnUpdate(max) { refreshWidth() }
    /**
     * The style of the progress indicator.
     */
    var style by refreshOnUpdate(style)
    /**
     * Determines if the progress indicator is striped.
     */
    var striped by refreshOnUpdate(striped)
    /**
     * Determines if the progress indicator is animated.
     */
    var animated by refreshOnUpdate(animated)

    init {
        role = "progressbar"
        refreshWidth()
    }

    private fun refreshWidth() {
        val value = (if (max - min > 0) (progress - min) * DEFAULT_MAX.toFloat() / (max - min) else 0f).toInt()
        val percent = if (value < 0) 0 else if (value > DEFAULT_MAX) DEFAULT_MAX else value
        width = percent.perc
    }

    override fun getSnClass(): List<StringBoolPair> {
        val cl = super.getSnClass().toMutableList()
        cl.add("progress-bar" to true)
        style?.let {
            cl.add(it.className to true)
        }
        if (striped || animated) {
            cl.add("progress-bar-striped" to true)
        }
        if (animated) {
            cl.add("active" to true)
        }
        return cl
    }

    override fun getSnAttrs(): List<StringPair> {
        val sn = super.getSnAttrs().toMutableList()
        sn.add("aria-valuenow" to "$progress")
        sn.add("aria-valuemin" to "$min")
        sn.add("aria-valuemax" to "$max")
        return sn
    }
}