tools.aqua.bgw.components.uicomponents.TextField.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bgw-core Show documentation

A framework for board game applications.

There is a newer version: 0.5

/*
 *    Copyright 2021 The BoardGameWork Authors
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    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.
 */

package tools.aqua.bgw.components.uicomponents

import tools.aqua.bgw.core.DEFAULT_TEXT_FIELD_HEIGHT
import tools.aqua.bgw.core.DEFAULT_TEXT_FIELD_WIDTH
import tools.aqua.bgw.util.Font

/**
 * A [TextField] is a single line input field.
 *
 * Whenever user input occurs the [text] field gets updated.
 *
 * @constructor Creates a [TextField].
 *
 * @param posX Horizontal coordinate for this [TextField]. Default: 0.
 * @param posY Vertical coordinate for this [TextField]. Default: 0.
 * @param width Width for this [TextField]. Default: [DEFAULT_TEXT_FIELD_WIDTH].
 * @param height Height for this [TextField]. Default: [DEFAULT_TEXT_FIELD_HEIGHT].
 * @param text Initial text for this [TextField]. Default: empty String.
 * @param prompt Prompt for this [TextField]. This gets displayed as a prompt to the user whenever the label is an
 * empty string. Default: empty string.
 *
 * @see TextArea
 */
open class TextField(
	posX: Number = 0,
	posY: Number = 0,
	width: Number = DEFAULT_TEXT_FIELD_WIDTH,
	height: Number = DEFAULT_TEXT_FIELD_HEIGHT,
	text: String = "",
	font: Font = Font(),
	val prompt: String = "",
) : TextInputUIComponent(
	posX = posX,
	posY = posY,
	width = width,
	height = height,
	text = text,
	font = font)