bgw-gui/tools.aqua.bgw.components.uicomponents/PasswordField

PasswordField

open class PasswordField(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TEXT_FIELD_WIDTH,     height: Number = DEFAULT_TEXT_FIELD_HEIGHT,     text: String = "",     prompt: String = "",     font: Font = Font(),     visual: Visual = ColorVisual(Color(240, 240, 240))) : TextInputUIComponent
Content copied to clipboard

A PasswordField is a single line input field that shows stars instead of typed text.

Whenever user input occurs the text field gets updated.

See also

Parameters

posX

Horizontal coordinate for this PasswordField. Default: 0.

posY

Vertical coordinate for this PasswordField. Default: 0.

width

Width for this PasswordField. Default: DEFAULT_TEXT_FIELD_WIDTH.

height

Height for this PasswordField. Default: DEFAULT_TEXT_FIELD_HEIGHT.

text

Initial text for this PasswordField. Default: empty String.

prompt

Prompt for this PasswordField. This gets displayed as a prompt to the user whenever the label is an empty string. Default: empty string.

font

Font to be used to display text.

visual

Visual to be used as a background. Defaults to a Light-gray ColorVisual.

Constructors

Link copied to clipboard
fun PasswordField(    posX: Number = 0,     posY: Number = 0,     width: Number = DEFAULT_TEXT_FIELD_WIDTH,     height: Number = DEFAULT_TEXT_FIELD_HEIGHT,     text: String = "",     prompt: String = "",     font: Font = Font(),     visual: Visual = ColorVisual(Color(240, 240, 240)))
Content copied to clipboard

Creates a PasswordField.

Functions

Link copied to clipboard
fun offset(offsetX: Number, offsetY: Number)
Content copied to clipboard

Adds an offset to this ComponentView's Position.

Link copied to clipboard
fun removeFromParent(): ComponentView
Content copied to clipboard

Removes this component from its parent.

Link copied to clipboard
fun reposition(posX: Number, posY: Number)
Content copied to clipboard

Repositions this ComponentView to the specified coordinates.

Link copied to clipboard
fun resize(width: Number, height: Number)
Content copied to clipboard

Resizes this ComponentView to the specified width and height.

Link copied to clipboard
fun rotate(degrees: Number)
Content copied to clipboard

Rotates this ComponentView by the given number of degrees.

Link copied to clipboard
fun scale(scalar: Number)
Content copied to clipboard

Scales this ComponentView by the given scalar.

Link copied to clipboard
fun scaleX(scalar: Number)
Content copied to clipboard

Scales this ComponentView's width by the given scalar.

Link copied to clipboard
fun scaleY(scalar: Number)
Content copied to clipboard

Scales this ComponentView's height by the given scalar.

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

Puts the ComponentView to the back inside its parent and Changes its zIndex accordingly.

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

Puts the ComponentView to the front inside its parent and Changes its zIndex accordingly.

Properties

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

The actual height for this ComponentView considering scale.

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

Horizontal position of this ComponentView considering scale.

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

Vertical position of this ComponentView considering scale.

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

The actual width for this ComponentView considering scale.

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

Css style that gets applied to this UIComponent's background.

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

Property for the css style that gets applied to this UIComponent's background.

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

Css style that gets applied to this UIComponent.

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

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

Link copied to clipboard
var dropAcceptor: (DragEvent) -> Boolean?
Content copied to clipboard

Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.

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

Font of this UIComponent. Usage depends on subclass.

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

Property for the Font of this UIComponent. Usage depends on subclass.

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

The height for this ComponentView.

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

Property for the height of this ComponentView.

Link copied to clipboard
var isDisabled: Boolean
Content copied to clipboard

Controls if user input events cause input functions of this ComponentView to get invoked.

Link copied to clipboard
val isDisabledProperty: BooleanProperty
Content copied to clipboard

Property that controls if user input events cause input functions of this ComponentView to get invoked.

Link copied to clipboard
var isFocusable: Boolean
Content copied to clipboard

Controls whether this ComponentView is focusable or not.

Link copied to clipboard
val isFocusableProperty: BooleanProperty
Content copied to clipboard

Property that controls whether this ComponentView is focusable or not.

Link copied to clipboard
var isVisible: Boolean
Content copied to clipboard

Visibility of this ComponentView.

Link copied to clipboard
val isVisibleProperty: BooleanProperty
Content copied to clipboard

Property for the visibility of this ComponentView.

Link copied to clipboard
var layoutBounds: CoordinatePlain
Content copied to clipboard

Returns a CoordinatePlain containing the component's corner Coordinates and its layout bounds.

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

Name field only for debugging purposes. Has no effect on rendering.

Link copied to clipboard
var onDragDropped: (DragEvent) -> Unit?
Content copied to clipboard

Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns true for the given DragEvent.

Link copied to clipboard
var onDragGestureEntered: (DragEvent) -> Unit?
Content copied to clipboard

Gets invoked with a DragEvent whenever the mouse enters this ComponentView while performing a drag gesture.

Link copied to clipboard
var onDragGestureExited: (DragEvent) -> Unit?
Content copied to clipboard

Gets invoked with a DragEvent whenever the mouse leaves this ComponentView while performing a drag gesture.

Link copied to clipboard
var onKeyPressed: (KeyEvent) -> Unit?
Content copied to clipboard

Gets invoked with a KeyEvent whenever a key is pressed while this ComponentView has focus.

Link copied to clipboard
var onKeyReleased: (KeyEvent) -> Unit?
Content copied to clipboard

Gets invoked with a KeyEvent whenever a key is released while this ComponentView has focus.

Link copied to clipboard
var onKeyTyped: (KeyEvent) -> Unit?
Content copied to clipboard

Gets invoked with a KeyEvent whenever a Character is typed while this ComponentView has focus. Gets invoked after onKeyPressed.

Link copied to clipboard
var onMouseClicked: (MouseEvent) -> Unit?
Content copied to clipboard

Gets invoked with a MouseEvent whenever the mouse is clicked inside this ComponentView. Gets invoked after onMousePressed and onMouseReleased.

Link copied to clipboard
var onMouseEntered: (MouseEvent) -> Unit?
Content copied to clipboard

Gets invoked with a MouseEvent whenever the mouse enters this ComponentView.

Link copied to clipboard
var onMouseExited: (MouseEvent) -> Unit?
Content copied to clipboard

Gets invoked with a MouseEvent whenever the mouse leaves this ComponentView.

Link copied to clipboard
var onMousePressed: (MouseEvent) -> Unit?
Content copied to clipboard

Gets invoked with a MouseEvent whenever the mouse is pressed inside this ComponentView.

Link copied to clipboard
var onMouseReleased: (MouseEvent) -> Unit?
Content copied to clipboard

Gets invoked with a MouseEvent whenever the mouse is released inside this ComponentView.

Link copied to clipboard
var onScroll: (ScrollEvent) -> Unit?
Content copied to clipboard

Gets invoked with a ScrollEvent whenever the mouse wheel is turned while the mouse is inside this ComponentView.

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

Opacity of this ComponentView.

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

Property for the opacity of this ComponentView.

Link copied to clipboard
var parent: ComponentView?
Content copied to clipboard

The parent of this ComponentView.

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

Horizontal position of this ComponentView.

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

Property for the horizontal position of this ComponentView.

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

Vertical position of this ComponentView.

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

Property for the vertical position of this ComponentView.

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

Prompt of this TextInputUIComponent.

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

Property for the prompt of this TextInputUIComponent.

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

Rotation of this ComponentView in degrees.

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

Property for the rotation of this ComponentView in degrees.

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

Scale of this ComponentView.

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

Horizontal scale of this ComponentView.

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

Property for the horizontal scale of this ComponentView.

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

Vertical scale of this ComponentView.

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

Property for the vertical scale of this ComponentView.

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

Text of this TextInputUIComponent.

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

Property for the text of this TextInputUIComponent.

Link copied to clipboard
open var visual: Visual
Content copied to clipboard

Current Visual.

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

The width for this ComponentView.

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

Property for the width of this ComponentView.

Link copied to clipboard
var zIndex: Int
Content copied to clipboard

for the order of ComponentView inside of parent.#

Link copied to clipboard
val zIndexProperty: IntegerProperty
Content copied to clipboard

Property for the order of ComponentView inside of parent.#