Refactoring. API documentation.

1 files changed, 46 insertions, 1 deletions

diff --git a/src/main/kotlin/pl/treksoft/kvision/panel/TabPanel.kt b/src/main/kotlin/pl/treksoft/kvision/panel/TabPanel.kt
index 411c4a57..9072d261 100644
--- a/src/main/kotlin/pl/treksoft/kvision/panel/TabPanel.kt
+++ b/src/main/kotlin/pl/treksoft/kvision/panel/TabPanel.kt
@@ -1,3 +1,24 @@
+/*
+ * 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 pl.treksoft.kvision.core.Component
@@ -7,7 +28,19 @@ import pl.treksoft.kvision.html.TAG
 import pl.treksoft.kvision.html.Tag
 import pl.treksoft.kvision.routing.routing
 
-open class TabPanel : SimplePanel(setOf()) {
+/**
+ * The container rendering it's children as tabs.
+ *
+ * It supports activating children by a JavaScript route.
+ *
+ * @constructor
+ * @param classes a set of CSS class names
+ */
+open class TabPanel(classes: Set<String> = setOf()) : SimplePanel(classes) {
+
+    /**
+     * The index of active (visible) tab.
+     */
     var activeIndex
         get() = content.activeIndex
         set(value) {
@@ -30,6 +63,15 @@ open class TabPanel : SimplePanel(setOf()) {
         this.addInternal(content)
     }
 
+    /**
+     * Adds new tab and optionally bounds it's activation to a given route.
+     * @param title title of the tab
+     * @param panel child component
+     * @param icon icon of the tab
+     * @param image image of the tab
+     * @param route JavaScript route to activate given child
+     * @return current container
+     */
     open fun addTab(
         title: String, panel: Component, icon: String? = null,
         image: ResString? = null, route: String? = null
@@ -59,6 +101,9 @@ open class TabPanel : SimplePanel(setOf()) {
         return this
     }
 
+    /**
+     * Removes tab at given index.
+     */
     open fun removeTab(index: Int): TabPanel {
         nav.remove(nav.children[index])
         content.remove(content.children[index])