ktfx-commons/ktfx.controls

Package-level declarations

Types

AnimationScope

interface AnimationScope

Node animations configurator interface for ParallelTransition and SequentialTransition.

BackgroundBuilder

class BackgroundBuilder

Background configurator class.

BorderBuilder

class BorderBuilder

Border configurator class.

ColumnConstraintsScope

interface ColumnConstraintsScope

ColumnConstraints configurator interface.

RowConstraintsScope

interface RowConstraintsScope

RowConstraints configurator interface.

ShapeAnimationScope

interface ShapeAnimationScope : AnimationScope

Shape animations configurator interface for ParallelTransition and SequentialTransition.

TableColumnDslMarker

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class TableColumnDslMarker

Delimits table column DSL configuration.

TableColumnScope

interface TableColumnScope<S>

TableColumn configurator interface.

TreeTableColumnScope

interface TreeTableColumnScope<S>

TreeTableColumn configurator interface.

Functions

affineTransformation

fun Node.affineTransformation(configuration: Affine.() -> Unit): Affine

Adds Affine transformation.

background

inline fun Region.background(noinline builderAction: BackgroundBuilder.() -> Unit): Background

Sets new background with multiple BackgroundFill and/or BackgroundImage.

backgroundFill

inline fun Region.backgroundFill(noinline builderAction: BackgroundBuilder.FillBuilder.() -> Unit): Background

Sets new background with single BackgroundFill.

backgroundImage

inline fun Region.backgroundImage(image: Image, noinline builderAction: BackgroundBuilder.ImageBuilder.() -> Unit): Background

Sets new background with single BackgroundImage.

blendEffect

fun Node.blendEffect(configuration: Blend.() -> Unit): Blend

Sets Blend effect.

bloomEffect

fun Node.bloomEffect(configuration: Bloom.() -> Unit): Bloom

Sets Bloom effect.

border

inline fun Region.border(noinline builderAction: BorderBuilder.() -> Unit): Border

Sets new border with multiple BorderStroke and/or BorderImage.

borderImage

inline fun Region.borderImage(image: Image, noinline builderAction: BorderBuilder.ImageBuilder.() -> Unit): Border

Sets new border with single BorderImage.

borderStroke

inline fun Region.borderStroke(noinline builderAction: BorderBuilder.StrokeBuilder.() -> Unit): Border

Sets new border with single BorderStroke.

boxBlurEffect

fun Node.boxBlurEffect(configuration: BoxBlur.() -> Unit): BoxBlur

Sets BoxBlur effect.

buildBackground

inline fun buildBackground(builderAction: BackgroundBuilder.() -> Unit): Background

Builds new background with multiple BackgroundFill and/or BackgroundImage.

buildBorder

inline fun buildBorder(builderAction: BorderBuilder.() -> Unit): Border

Builds new border with multiple BorderStroke and/or BorderImage.

capture

inline fun Scene.capture(): WritableImage

inline fun Node.capture(image: WritableImage? = null, configuration: SnapshotParameters.() -> Unit = { }): WritableImage

Take a snapshot of this Node returning image it wrote.

colorAdjustEffect

fun Node.colorAdjustEffect(configuration: ColorAdjust.() -> Unit): ColorAdjust

Sets ColorAdjust effect.

colorInputEffect

fun Node.colorInputEffect(configuration: ColorInput.() -> Unit): ColorInput

Sets ColorInput effect.

columnConstraints

fun GridPane.columnConstraints(configuration: ColumnConstraintsScope.() -> Unit)

Configure GridPane column constraints.

columns

fun <S> TableColumn<S, *>.columns(configuration: TableColumnScope<S>.() -> Unit)

Configure TableColumn columns, essentially enabling multi-line column.

fun <S> TableView<S>.columns(configuration: TableColumnScope<S>.() -> Unit)

Configure TableView columns.

fun <S> TreeTableColumn<S, *>.columns(configuration: TreeTableColumnScope<S>.() -> Unit)

Configure TreeTableColumn columns, essentially enabling multi-line column.

fun <S> TreeTableView<S>.columns(configuration: TreeTableColumnScope<S>.() -> Unit)

Configure TreeTableView columns.

constrained

inline fun TableView<*>.constrained()

Apply TableView.CONSTRAINED_RESIZE_POLICY to this TableView.

inline fun TreeTableView<*>.constrained()

Apply TreeTableView.CONSTRAINED_RESIZE_POLICY to this TreeTableView.

displacementMapEffect

fun Node.displacementMapEffect(configuration: DisplacementMap.() -> Unit): DisplacementMap

Sets DisplacementMap effect.

dropShadowEffect

fun Node.dropShadowEffect(configuration: DropShadow.() -> Unit): DropShadow

Sets DropShadow effect.

fadeTransition

fun Node.fadeTransition(duration: Duration = 400.0.milliseconds, configuration: FadeTransition.() -> Unit): FadeTransition

Plays a FadeTransition.

fillTransition

fun Shape.fillTransition(duration: Duration = 400.0.milliseconds, fromValue: Color? = null, toValue: Color? = null, configuration: FillTransition.() -> Unit): FillTransition

Plays a FillTransition.

find

inline fun <T : Node> Node.find(selector: String): T

Alias of Node.lookup with non-null return and specified type.

inline fun <T : Node> Scene.find(selector: String): T

Alias of Scene.lookup with non-null return and specified type.

gaussianBlurEffect

fun Node.gaussianBlurEffect(configuration: GaussianBlur.() -> Unit): GaussianBlur

Sets GaussianBlur effect.

glowEffect

fun Node.glowEffect(configuration: Glow.() -> Unit): Glow

Sets Glow effect.

imageInputEffect

fun Node.imageInputEffect(configuration: ImageInput.() -> Unit): ImageInput

Sets ImageInput effect.

innerShadowEffect

fun Node.innerShadowEffect(configuration: InnerShadow.() -> Unit): InnerShadow

Sets InnerShadow effect.

insetsOf

inline fun insetsOf(): Insets

Empty insets. An Insets instance with all offsets equal to zero.

inline fun insetsOf(all: Double): Insets

Create an inset where Double number will be applied to all side.

fun insetsOf(all: Int): Insets

Create an inset where Int number will be applied to all side.

fun insetsOf(all: Long): Insets

Create an inset where Long number will be applied to all side.

inline fun insetsOf(vertical: Double = 0.0, horizontal: Double = 0.0): Insets

Create an inset where Double number will be applied to both side.

fun insetsOf(vertical: Int = 0, horizontal: Int = 0): Insets

Create an inset where Int number will be applied to both side.

fun insetsOf(vertical: Long = 0, horizontal: Long = 0): Insets

Create an inset where Long number will be applied to both side.

inline fun insetsOf(top: Double = 0.0, right: Double = 0.0, bottom: Double = 0.0, left: Double = 0.0): Insets

Create an inset where Double number will be applied to each side.

fun insetsOf(top: Int = 0, right: Int = 0, bottom: Int = 0, left: Int = 0): Insets

Create an inset where Int number will be applied to each side.

fun insetsOf(top: Long = 0, right: Long = 0, bottom: Long = 0, left: Long = 0): Insets

Create an inset where Long number will be applied to each side.

isNotSelected

inline fun MultipleSelectionModel<*>.isNotSelected(): Boolean

inline fun SelectionModel<*>.isNotSelected(): Boolean

Returns true if the model is not selected.

inline fun ToggleGroup.isNotSelected(): Boolean

Returns true if toggle button is not selected in this group.

isSelected

inline fun MultipleSelectionModel<*>.isSelected(): Boolean

inline fun SelectionModel<*>.isSelected(): Boolean

Returns true if the model is selected.

inline fun ToggleGroup.isSelected(): Boolean

Returns true if toggle button is selected in this group.

lightingEffect

fun Node.lightingEffect(configuration: Lighting.() -> Unit): Lighting

Sets Lighting effect.

motionBlurEffect

fun Node.motionBlurEffect(configuration: MotionBlur.() -> Unit): MotionBlur

Sets MotionBlur effect.

parallelTransition

fun Node.parallelTransition(configuration: AnimationScope.() -> Unit): ParallelTransition

Creates a ParallelTransition for this node.

pathTransition

fun Node.pathTransition(duration: Duration = 400.0.milliseconds, path: Shape? = null, configuration: PathTransition.() -> Unit): PathTransition

Plays a PathTransition.

perspectiveTransformEffect

fun Node.perspectiveTransformEffect(configuration: PerspectiveTransform.() -> Unit): PerspectiveTransform

Sets PerspectiveTransform effect.

reflectionEffect

fun Node.reflectionEffect(configuration: Reflection.() -> Unit): Reflection

Sets Reflection effect.

rotateTransformation

fun Node.rotateTransformation(configuration: Rotate.() -> Unit): Rotate

Adds Rotate transformation.

rotateTransition

fun Node.rotateTransition(duration: Duration = 400.0.milliseconds, configuration: RotateTransition.() -> Unit): RotateTransition

Plays a RotateTransition.

rowConstraints

fun GridPane.rowConstraints(configuration: RowConstraintsScope.() -> Unit)

Configure GridPane row constraints.

scaleTransformation

fun Node.scaleTransformation(configuration: Scale.() -> Unit): Scale

Adds Scale transformation.

scaleTransition

fun Node.scaleTransition(duration: Duration = 400.0.milliseconds, configuration: ScaleTransition.() -> Unit): ScaleTransition

Plays a ScaleTransition.

selectIndex

inline fun ToggleGroup.selectIndex(index: Int)

Select toggle by index.

sepiaToneEffect

fun Node.sepiaToneEffect(configuration: SepiaTone.() -> Unit): SepiaTone

Sets SepiaTone effect.

sequentialTransition

fun Node.sequentialTransition(configuration: AnimationScope.() -> Unit): SequentialTransition

Creates a SequentialTransition for this node.

shadowEffect

fun Node.shadowEffect(configuration: Shadow.() -> Unit): Shadow

Sets Shadow effect.

shapeParallelTransition

fun Shape.shapeParallelTransition(configuration: ShapeAnimationScope.() -> Unit): ParallelTransition

Creates a ParallelTransition for this shape.

shapeSequentialTransition

fun Shape.shapeSequentialTransition(configuration: ShapeAnimationScope.() -> Unit): SequentialTransition

Creates a SequentialTransition for this shape.

shearTransformation

fun Node.shearTransformation(configuration: Shear.() -> Unit): Shear

Adds Shear transformation.

strokeTransition

fun Shape.strokeTransition(duration: Duration = 400.0.milliseconds, fromValue: Color? = null, toValue: Color? = null, configuration: StrokeTransition.() -> Unit): StrokeTransition

Plays a StrokeTransition.

toFxImage

inline fun BufferedImage.toFxImage(wimg: WritableImage? = null): WritableImage

Snapshots the specified BufferedImage and stores a copy of its pixels into a JavaFX Image object, creating a new object if needed.

toSwingImage

inline fun Image.toSwingImage(bimg: BufferedImage? = null): BufferedImage

Snapshots the specified JavaFX Image object and stores a copy of its pixels into a BufferedImage object, creating a new object if needed.

translateTransformation

fun Node.translateTransformation(configuration: Translate.() -> Unit): Translate

Adds Translate transformation.

translateTransition

fun Node.translateTransition(duration: Duration = 400.0.milliseconds, configuration: TranslateTransition.() -> Unit): TranslateTransition

Plays a TranslateTransition.

unconstrained

inline fun TableView<*>.unconstrained()

Apply TableView.UNCONSTRAINED_RESIZE_POLICY to this TableView.

inline fun TreeTableView<*>.unconstrained()

Apply TreeTableView.UNCONSTRAINED_RESIZE_POLICY to this TreeTableView.

Properties

BASELINE

val BASELINE: Pos

Represents positioning on the baseline vertically and on the center horizontally.

BASELINE_LEFT

val BASELINE_LEFT: Pos

Represents positioning on the baseline vertically and on the left horizontally.

BASELINE_RIGHT

val BASELINE_RIGHT: Pos

Represents positioning on the baseline vertically and on the right horizontally.

BOTTOM

val BOTTOM: Pos

Represents positioning on the bottom vertically and on the center horizontally.

BOTTOM_LEFT

val BOTTOM_LEFT: Pos

Represents positioning on the bottom vertically and on the left horizontally.

BOTTOM_RIGHT

val BOTTOM_RIGHT: Pos

Represents positioning on the bottom vertically and on the right horizontally.

CENTER

val CENTER: Pos

Represents positioning on the center both vertically and horizontally.

H_CENTER

val H_CENTER: HPos

Indicates centered horizontal position.

H_LEFT

val H_LEFT: HPos

Indicates left horizontal position.

H_RIGHT

val H_RIGHT: HPos

Indicates right horizontal position.

HORIZONTAL

val HORIZONTAL: Orientation

The horizontal (right <-> left) orientation.

LEFT

val LEFT: Pos

Represents positioning on the center vertically and on the left horizontally.

notSelectedBinding

val SelectionModel<*>.notSelectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is not selected.

val MultipleSelectionModel<*>.notSelectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is not selected.

val ToggleGroup.notSelectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is not selected.

RIGHT

val RIGHT: Pos

Represents positioning on the center vertically and on the right horizontally.

selectedBinding

val SelectionModel<*>.selectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is selected.

val MultipleSelectionModel<*>.selectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is selected.

val ToggleGroup.selectedBinding: BooleanBinding

Returns a boolean binding that holds true when item is selected.

selectedIndex

val ToggleGroup.selectedIndex: Int

Get selected toggle index.

SIDE_BOTTOM

val SIDE_BOTTOM: Side

Represents bottom side of a rectangle.

SIDE_LEFT

val SIDE_LEFT: Side

Represents left side of a rectangle.

SIDE_RIGHT

val SIDE_RIGHT: Side

Represents right side of a rectangle.

SIDE_TOP

val SIDE_TOP: Side

Represents top side of a rectangle.

TOP

val TOP: Pos

Represents positioning on the top vertically and on the center horizontally.

TOP_LEFT

val TOP_LEFT: Pos

Represents positioning on the top vertically and on the left horizontally.

TOP_RIGHT

val TOP_RIGHT: Pos

Represents positioning on the top vertically and on the right horizontally.

V_BASELINE

val V_BASELINE: VPos

Indicates baseline vertical position.

V_BOTTOM

val V_BOTTOM: VPos

Indicates bottom vertical position.

V_CENTER

val V_CENTER: VPos

Indicates centered vertical position.

V_TOP

val V_TOP: VPos

Indicates top vertical position.

VERTICAL

val VERTICAL: Orientation

The vertical (top <-> bottom) orientation.