tri.util.ui.NavigableWorkspaceView.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of promptfx Show documentation
LLM demo application.
The newest version!
/*-
 * #%L
 * tri.promptfx:promptfx
 * %%
 * Copyright (C) 2023 - 2025 Johns Hopkins University Applied Physics Laboratory
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package tri.util.ui

import tornadofx.*
import tri.util.ANSI_RESET
import tri.util.ANSI_YELLOW
import tri.util.info
import java.util.*

/** A view that can be added to a workspace. */
interface NavigableWorkspaceView {

    val category: String
    val name: String
    val affordances: WorkspaceViewAffordance
//    val description: String
//    val icon: String

    /** Add the view to the workspace. */
    fun dock(workspace: Workspace)

    companion object {
        val viewPlugins: List by lazy {
            ServiceLoader.load(NavigableWorkspaceView::class.java).toList().also {
                info("Loading views...")
                it.groupBy { it.category }.toSortedMap().forEach { (category, views) ->
                    info("  - $category: $ANSI_YELLOW${views.joinToString { it.name }}$ANSI_RESET")
                }
            }
        }
    }
}

/** Information about type of affordances for the view's primary logic. */
data class WorkspaceViewAffordance(
    /** Accepts an input document collection. */
    var acceptsCollection: Boolean = false,
    /** Accepts an input string. */
    var acceptsInput: Boolean = false,
    /** Produces an output string. */
    var producesOutput: Boolean = false
) {
    companion object {
        val NONE = WorkspaceViewAffordance()
        val INPUT_ONLY = WorkspaceViewAffordance(acceptsInput = true)
        val COLLECTION_ONLY = WorkspaceViewAffordance(acceptsCollection = true)
        val INPUT_AND_COLLECTION = WorkspaceViewAffordance(acceptsInput = true, acceptsCollection = true)
    }
}