ysny.karibu-tools.karibu-tools-23.0.23.source-code.TabSheets.kt Maven / Gradle / Ivy

Go to download
package com.github.mvysny.kaributools.v23

import com.github.mvysny.kaributools.findAncestor
import com.github.mvysny.kaributools.findAncestorOrSelf
import com.vaadin.flow.component.Component
import com.vaadin.flow.component.tabs.Tab
import com.vaadin.flow.component.tabs.TabSheet
import com.vaadin.flow.component.tabs.Tabs
import com.vaadin.flow.dom.Element
import java.lang.reflect.Field

/**
 * Returns the current index of a tab within its [Tabs] or [TabSheet] container.
 */
public val Tab.index: Int
    get() = owner.indexOf(this)

/**
 * Returns the owner [Tabs] of this tab. Fails if the tab is not attached to any [Tabs] owner.
 *
 * Internally [TabSheet] also uses [Tabs] so this might work for [TabSheet] too, but
 * this may stop working if [TabSheet] internal implementation changes.
 */
public val Tab.owner: Tabs
    get() = checkNotNull((parent.orElse(null)) as Tabs?) { "tab $this is not attached to a parent" }

/**
 * Returns the owner [TabSheet] of this tab. Fails if the tab is not attached to any [Tabs] owner.
 */
public val Tab.ownerTabSheet: TabSheet
    get() = checkNotNull(findAncestor { it is TabSheet }) { "tab $this is not attached to a TabSheet" } as TabSheet

private val __TabSheet_tabToContent: Field by lazy(LazyThreadSafetyMode.PUBLICATION) {
    val f = TabSheet::class.java.getDeclaredField("tabToContent")
    f.isAccessible = true
    f
}
@Suppress("UNCHECKED_CAST")
private val TabSheet.tabToContent: Map
    get() = __TabSheet_tabToContent.get(this) as Map

private val __TabSheet_tabs: Field by lazy(LazyThreadSafetyMode.PUBLICATION) {
    val f = TabSheet::class.java.getDeclaredField("tabs")
    f.isAccessible = true
    f
}
@Suppress("UNCHECKED_CAST")
private val TabSheet.tabsComponent: Tabs
    get() = __TabSheet_tabs.get(this) as Tabs

/**
 * Returns or sets this tab contents in the [TabSheet]. Works only for tabs nested in a [TabSheet].
 */
public val Tab.contents: Component? get() = ownerTabSheet.getComponent(this)

/**
 * Returns the current number of tabs.
 */
public val TabSheet.tabCount: Int get() = tabsComponent.componentCount

/**
 * Removes all tabs.
 */
public fun TabSheet.removeAll() {
    tabs.toList().forEach { remove(it) }
}

/**
 * Returns a live list of all tabs. The list is read-only but live: it reflects changes when tabs are added or removed.
 */
public val TabSheet.tabs: List get() = object : AbstractList() {
    override val size: Int
        get() = tabCount

    override fun get(index: Int): Tab =
        getTabAt(index)
}

/**
 * Port of `TabSheet.getTab()` to Vaadin 23.
 */
public fun TabSheet.getTab(content: Component): Tab? =
    tabs.firstOrNull { it.contents == content }

/**
 * Port of `TabSheet.getComponent()` to Vaadin 23. Alias for [contents].
 */
public fun TabSheet.getComponent(tab: Tab): Component? = tabToContent[tab]?.component?.orElse(null)

/**
 * Finds a tab which transitively contains given [component].
 */
public fun TabSheet.findTabContaining(component: Component): Tab? {
    val contentComponents: Set = tabToContent.values.mapNotNull {it.component.orElse(null) }.toSet()
    val contents: Component = component.findAncestorOrSelf { contentComponents.contains(it) } ?: return null
    return getTab(contents)
}