1 files changed, 40 insertions, 0 deletions
diff --git a/src/main/kotlin/pl/treksoft/kvision/panel/StackPanel.kt b/src/main/kotlin/pl/treksoft/kvision/panel/StackPanel.kt
index e69cc416..672c8690 100644
--- a/src/main/kotlin/pl/treksoft/kvision/panel/StackPanel.kt
+++ b/src/main/kotlin/pl/treksoft/kvision/panel/StackPanel.kt
@@ -1,13 +1,47 @@
+/*
+ * 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.panel
 
 import com.github.snabbdom.VNode
 import pl.treksoft.kvision.core.Component
 import pl.treksoft.kvision.routing.routing
 
+/**
+ * The container with only one active (visible) child at any moment.
+ *
+ * It supports activating children by a JavaScript route.
+ *
+ * @constructor
+ * @param activateLast determines if added component is automatically activated (default true)
+ * @param classes a set of CSS class names
+ */
 open class StackPanel(
     private val activateLast: Boolean = true,
     classes: Set<String> = setOf()
 ) : SimplePanel(classes) {
+
+    /**
+     * The index of active (visible) child.
+     */
     var activeIndex = -1
         set(value) {
             field = value
@@ -22,6 +56,12 @@ open class StackPanel(
         }
     }
 
+    /**
+     * Adds given component and bounds it's activation to a given route.
+     * @param panel child component
+     * @param route JavaScript route to activate given child
+     * @return current container
+     */
     open fun add(panel: Component, route: String): StackPanel {
         add(panel)
         val currentIndex = children.size - 1