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

ImageVisual

open class ImageVisual( image: BufferedImage, width: Int = -1, height: Int = -1, offsetX: Int = 0, offsetY: Int = 0, val path: String = "") : SingleLayerVisual

Visual showing an Image.

The image gets stretched to the size of the component that this visual is embedded in.

A sub-image can be loaded by passing offsetX/offsetY for the TOP_LEFT corner and width/height for the sub-image size. If width or height is passed as -1, the remaining image from offsetX/offsetY will be loaded.

Parameters

image

Image to show.

width

Width of sub-image. Pass -1 to use full width. Default: -1.

height

Height of sub-image. Pass -1 to use full height. Default: -1.

offsetX

Left bound of sub-image. Default: 0.

offsetY

Top bound of sub-image. Default: 0.

Constructors

fun ImageVisual( path: String, width: Int = -1, height: Int = -1, offsetX: Int = 0, offsetY: Int = 0)

Loads an ImageVisual from a path.

fun ImageVisual( file: File, width: Int = -1, height: Int = -1, offsetX: Int = 0, offsetY: Int = 0)

Loads an ImageVisual from a file.

fun ImageVisual( image: BufferedImage, width: Int = -1, height: Int = -1, offsetX: Int = 0, offsetY: Int = 0, path: String = "")

Loads an ImageVisual from a BufferedImage.

Types

object Companion

Functions

fun addListener(listener: Observer)

Adds a listener silently.

addListenerAndInvoke

fun addListenerAndInvoke(listener: Observer)

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

fun clearListeners()

Removes all listeners.

open override fun copy(): ImageVisual

Copies this ImageVisual to a new object.

fun notifyChange()

Notifies all listeners by calling Observer.update.

fun removeListener(listener: Observer): Boolean

Removes a listener.

Properties

backgroundRadius

open var backgroundRadius: BackgroundRadius?

Background radius.

backgroundRadiusProperty

var backgroundRadiusProperty: Property<BackgroundRadius?>

Property for backgroundRadius.

open var borderColor: BorderColor?

Border color.

borderColorProperty

var borderColorProperty: Property<BorderColor?>

Property for borderColor.

open var borderRadius: BorderRadius?

Border radius.

borderRadiusProperty

var borderRadiusProperty: Property<BorderRadius?>

Property for borderRadius.

open var borderStyle: BorderStyle?

Border style.

borderStyleProperty

var borderStyleProperty: Property<BorderStyle?>

Property for borderStyle.

open var borderWidth: BorderWidth?

Border width.

borderWidthProperty

var borderWidthProperty: Property<BorderWidth?>

Property for borderWidth.

open var cursor: Cursor?

Cursor.

var cursorProperty: Property<Cursor?>

Property for cursor.

var image: BufferedImage

The displayed image.

val imageProperty: Property<BufferedImage>

Property for the displayed image.

val path: String

var style: String

Css style that gets applied to this Visual.

val styleProperty: StringProperty

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

var transparency: Double

The transparency / alpha channel for this Visual.

transparencyProperty

val transparencyProperty: LimitedDoubleProperty

Property for the transparency / alpha channel for this Visual.