bgw-gui/tools.aqua.bgw.visual/TextVisual

TextVisual

open class TextVisual(    text: String,     font: Font = Font(),     alignment: Alignment = Alignment.CENTER,     offsetX: Number = 0,     offsetY: Number = 0) : SingleLayerVisual
Content copied to clipboard

A visual displaying text.

Parameters

text

Text to display.

font

Font to be used for the text. Default: default Font constructor.

alignment

Alignment for the text. Default: Alignment.CENTER.

offsetX

The horizontal offset of the text from its anchorpoint. Default: 0.

offsetY

The vertical offset of the text from its anchorpoint. Default: 0.

Constructors

Link copied to clipboard
fun TextVisual(    text: String,     font: Font = Font(),     alignment: Alignment = Alignment.CENTER,     offsetX: Number = 0,     offsetY: Number = 0)
Content copied to clipboard

Creates a TextVisual with given text.

Functions

Link copied to clipboard
fun addListener(listener: Observer)
Content copied to clipboard

Adds a listener silently.

Link copied to clipboard
fun addListenerAndInvoke(listener: Observer)
Content copied to clipboard

Adds a listener and calls Observer.update on this new listener.

Link copied to clipboard
fun clearListeners()
Content copied to clipboard

Removes all listeners.

Link copied to clipboard
open override fun copy(): TextVisual
Content copied to clipboard

Copies this TextVisual to a new object.

Link copied to clipboard
fun notifyChange()
Content copied to clipboard

Notifies all listeners by calling Observer.update.

Link copied to clipboard
fun removeListener(listener: Observer): Boolean
Content copied to clipboard

Removes a listener.

Properties

Link copied to clipboard
var alignment: Alignment
Content copied to clipboard

The text.

Link copied to clipboard
val alignmentProperty: Property<Alignment>
Content copied to clipboard

Property for the text.

Link copied to clipboard
open var backgroundRadius: BackgroundRadius?
Content copied to clipboard

Background radius.

Link copied to clipboard
var backgroundRadiusProperty: Property<BackgroundRadius?>
Content copied to clipboard

Property for backgroundRadius.

Link copied to clipboard
open var borderColor: BorderColor?
Content copied to clipboard

Border color.

Link copied to clipboard
var borderColorProperty: Property<BorderColor?>
Content copied to clipboard

Property for borderColor.

Link copied to clipboard
open var borderRadius: BorderRadius?
Content copied to clipboard

Border radius.

Link copied to clipboard
var borderRadiusProperty: Property<BorderRadius?>
Content copied to clipboard

Property for borderRadius.

Link copied to clipboard
open var borderStyle: BorderStyle?
Content copied to clipboard

Border style.

Link copied to clipboard
var borderStyleProperty: Property<BorderStyle?>
Content copied to clipboard

Property for borderStyle.

Link copied to clipboard
open var borderWidth: BorderWidth?
Content copied to clipboard

Border width.

Link copied to clipboard
var borderWidthProperty: Property<BorderWidth?>
Content copied to clipboard

Property for borderWidth.

Link copied to clipboard
open var cursor: Cursor?
Content copied to clipboard

Cursor.

Link copied to clipboard
var cursorProperty: Property<Cursor?>
Content copied to clipboard

Property for cursor.

Link copied to clipboard
var font: Font
Content copied to clipboard

The displayed text.

Link copied to clipboard
val fontProperty: Property<Font>
Content copied to clipboard

Property for the displayed text.

Link copied to clipboard
var offsetX: Double
Content copied to clipboard

The x-axis text offset.

Link copied to clipboard
val offsetXProperty: DoubleProperty
Content copied to clipboard

Property for the x-axis text offset.

Link copied to clipboard
var offsetY: Double
Content copied to clipboard

The y-axis text offset.

Link copied to clipboard
val offsetYProperty: DoubleProperty
Content copied to clipboard

Property for the y-axis text offset.

Link copied to clipboard
var style: String
Content copied to clipboard

Css style that gets applied to this Visual.

Link copied to clipboard
val styleProperty: StringProperty
Content copied to clipboard

Property for the css style that gets applied to this Visual.

Link copied to clipboard
var text: String
Content copied to clipboard

The displayed text.

Link copied to clipboard
val textProperty: StringProperty
Content copied to clipboard

Property for the displayed text.

Link copied to clipboard
var transparency: Double
Content copied to clipboard

The transparency / alpha channel for this Visual.

Link copied to clipboard
val transparencyProperty: LimitedDoubleProperty
Content copied to clipboard

Property for the transparency / alpha channel for this Visual.