com.github.mvysny.karibudsl.v8.SpecialContainer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of karibu-dsl-v8 Show documentation

Karibu-DSL, Kotlin extensions/DSL for Vaadin

The newest version!

package com.github.mvysny.karibudsl.v8

import com.vaadin.ui.Component
import com.vaadin.ui.ComponentContainer
import com.vaadin.ui.HasComponents

/**
 * A specialized version of [ComponentContainer], for certain special containers. The DSL's
 * [init] method will invoke [addComponent] method with the components being registered.
 *
 * For example, there may be a special container (say, a ticker) which does not attach the components as its Vaadin
 * children immediately - rather it only remembers the components added via [addComponent] in a special list and
 * Vaadin-attaches them once every 10 seconds, one at a time. This way, you can use the DSL to define all children (or
 * pages) of this special component, without having them attached immediately as Vaadin children.
 */
public interface SpecialContainer : HasComponents {
    /**
     * Adds the component into this container. Called by [init] when DSL-adding children to this container.
     * @param component the component to be added.
     */
    public fun addComponent(component: Component)

    public fun removeComponent(component: Component)

    public fun removeAllComponents() {
        toList().forEach { removeComponent(it) }
    }
}