
public class TextVisual
extends SingleLayerVisual

A visual displaying text.

Field Summary

Fields
Modifier and Type	Field	Description
`private final StringProperty`	`textProperty`
`private String`	`text`
`private final Property<Font>`	`fontProperty`
`private Font`	`font`
`private final Property<Alignment>`	`alignmentProperty`
`private Alignment`	`alignment`
`private final DoubleProperty`	`offsetXProperty`
`private Double`	`offsetX`
`private final DoubleProperty`	`offsetYProperty`
`private Double`	`offsetY`
`private final LimitedDoubleProperty`	`transparencyProperty`
`private Double`	`transparency`

Constructor Summary

Constructors
Constructor	Description
`TextVisual(String text, Font font, Alignment alignment, Number offsetX, Number offsetY)`	Creates a TextVisual with given text.

Method Summary

Modifier and Type	Method	Description
`final StringProperty`	`getTextProperty()`	Property for the displayed text.
`final String`	`getText()`
`final Unit`	`setText(String text)`
`final Property<Font>`	`getFontProperty()`	Property for the displayed text.
`final Font`	`getFont()`
`final Unit`	`setFont(Font font)`
`final Property<Alignment>`	`getAlignmentProperty()`	Property for the text.
`final Alignment`	`getAlignment()`
`final Unit`	`setAlignment(Alignment alignment)`
`final DoubleProperty`	`getOffsetXProperty()`	Property for the x-axis text offset.
`final Double`	`getOffsetX()`
`final Unit`	`setOffsetX(Double offsetX)`
`final DoubleProperty`	`getOffsetYProperty()`	Property for the y-axis text offset.
`final Double`	`getOffsetY()`
`final Unit`	`setOffsetY(Double offsetY)`
`final LimitedDoubleProperty`	`getTransparencyProperty()`	Property for the transparency / alpha channel for this Visual.
`final Double`	`getTransparency()`
`final Unit`	`setTransparency(Double transparency)`
`TextVisual`	`copy()`	Copies this TextVisual to a new object.

Methods inherited from class tools.aqua.bgw.visual.Visual
addListener, addListenerAndInvoke, clearListeners, notifyChange, removeListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextVisual
```
TextVisual(String text, Font font, Alignment alignment, Number offsetX, Number offsetY)
```
    Creates a TextVisual with given text.
    
    Parameters:
    
    text - Text to display.
    
    font - Font to be used for the text.
    
    alignment - Alignment for the text.
    
    offsetX - The horizontal offset of the text from its anchorpoint.
    
    offsetY - The vertical offset of the text from its anchorpoint.
- Method Detail
  - getTextProperty
```
 final StringProperty getTextProperty()
```
    Property for the displayed text.
  - getText
```
 final String getText()
```
  - setText
```
 final Unit setText(String text)
```
  - getFontProperty
```
 final Property<Font> getFontProperty()
```
    Property for the displayed text.
  - getFont
```
 final Font getFont()
```
  - setFont
```
 final Unit setFont(Font font)
```
  - getAlignmentProperty
```
 final Property<Alignment> getAlignmentProperty()
```
    Property for the text.
  - getAlignment
```
 final Alignment getAlignment()
```
  - setAlignment
```
 final Unit setAlignment(Alignment alignment)
```
  - getOffsetXProperty
```
 final DoubleProperty getOffsetXProperty()
```
    Property for the x-axis text offset.
  - getOffsetX
```
 final Double getOffsetX()
```
  - setOffsetX
```
 final Unit setOffsetX(Double offsetX)
```
  - getOffsetYProperty
```
 final DoubleProperty getOffsetYProperty()
```
    Property for the y-axis text offset.
  - getOffsetY
```
 final Double getOffsetY()
```
  - setOffsetY
```
 final Unit setOffsetY(Double offsetY)
```
  - getTransparencyProperty
```
 final LimitedDoubleProperty getTransparencyProperty()
```
    Property for the transparency / alpha channel for this Visual.
    Must be set between 0 (full transparent) and 1 (non-transparent / solid). Default: 1.
  - getTransparency
```
 final Double getTransparency()
```
  - setTransparency
```
 final Unit setTransparency(Double transparency)
```
  - copy
```
 TextVisual copy()
```
    Copies this TextVisual to a new object.

Class TextVisual

Field Summary

Constructor Summary

Method Summary

Methods inherited from class tools.aqua.bgw.visual.Visual

Methods inherited from class java.lang.Object

Constructor Detail

TextVisual

Method Detail

getTextProperty

getText

setText

getFontProperty

getFont

setFont

getAlignmentProperty

getAlignment

setAlignment

getOffsetXProperty

getOffsetX

setOffsetX

getOffsetYProperty

getOffsetY

setOffsetY

getTransparencyProperty

getTransparency

setTransparency

copy