controls/io.nacular.doodle.controls.buttons/PushButton

PushButton

open class PushButton(text: String = "", icon: Icon<Button>? = null, model: ButtonModel = ButtonModelImpl(), role: ButtonRole) : Button(source)

Simple component that responds to the pointer and keyboard, allowing a user to "click".

Author

Nicholas Eddy

Inheritors

HyperLink

ToggleButton

Constructors

PushButton

constructor(text: String = "", icon: Icon<Button>? = null, model: ButtonModel = ButtonModelImpl())

Creates a button.

protected constructor(text: String = "", icon: Icon<Button>? = null, model: ButtonModel = ButtonModelImpl(), role: ButtonRole)

Inherited properties

acceptsThemes

var acceptsThemes: Boolean

accessibilityDescriptionProvider

var accessibilityDescriptionProvider: View?

accessibilityLabel

var accessibilityLabel: String?

accessibilityLabelProvider

var accessibilityLabelProvider: View?

accessibilityRole

var accessibilityRole: AccessibilityRole?

armedChanged

val armedChanged: PropertyObservers<Button, Boolean>

backgroundColor

var backgroundColor: Color?

behavior

var behavior: Behavior<Button>?

All rendering is delegated to the behavior

boundingBox

var boundingBox: Rectangle

bounds

override var bounds: Rectangle

boundsChanged

val boundsChanged: PropertyObservers<View, Rectangle>

camera

var camera: Camera

cameraChanged

val cameraChanged: PropertyObservers<View, Camera>

children

protected open val children: ObservableList<View>

childrenChanged

protected val childrenChanged: Pool<ChildObserver<View>>

childrenClipPath

protected var childrenClipPath: View.ClipPath?

clipCanvasToBounds

protected var clipCanvasToBounds: Boolean

contentDirection

val contentDirection: ContentDirection

contentDirectionChanged

val contentDirectionChanged: ChangeObservers<View>

cursor

var cursor: Cursor?

cursorChanged

val cursorChanged: PropertyObservers<View, Cursor?>

disabledIcon

var disabledIcon: Icon<Button>?

Icon when enabled == false

disabledSelectedIcon

var disabledSelectedIcon: Icon<Button>?

Icon when enabled == false and selected == true

displayChange

val displayChange: BooleanObservers

displayed

val displayed: Boolean

displayRect

val displayRect: Rectangle

displayRectHandlingChanged

val displayRectHandlingChanged: BooleanObservers

dragRecognizer

var dragRecognizer: DragRecognizer?

dropReceiver

var dropReceiver: DropReceiver?

enabled

var enabled: Boolean

enabledChanged

val enabledChanged: BooleanObservers

fired

val fired: ChangeObservers<Button>

Notifies whenever the button is clicked (pressed/released)

firstRender

val firstRender: ChangeObservers<View>

focusabilityChanged

val focusabilityChanged: BooleanObservers

focusable

open var focusable: Boolean

focusChanged

val focusChanged: BooleanObservers

focusCycleRoot

protected val focusCycleRoot: View?

focusTraversalPolicy

protected open var focusTraversalPolicy: FocusTraversalPolicy?

font

var font: Font?

foregroundColor

var foregroundColor: Color?

hasFocus

var hasFocus: Boolean

height

override var height: Double

horizontalAlignment

var horizontalAlignment: HorizontalAlignment

How icons and text are positioned horizontally in the button

icon

var icon: Icon<Button>?

Default icon shown if a state-specific one is not installed

iconAnchor

var iconAnchor: Anchor

How icons are positioned horizontally relative to text

iconTextSpacing

var iconTextSpacing: Double

Space between icons and text

idealSize

override var idealSize: Size?

insets

protected open var insets: Insets

isFocusCycleRoot

protected open var isFocusCycleRoot: Boolean

keyChanged

val keyChanged: Pool<KeyListener>

keyFilter

val keyFilter: Pool<KeyListener>

layout

protected open var layout: Layout?

localContentDirection

var localContentDirection: ContentDirection?

minimumSize

override var minimumSize: Size

mirrored

val mirrored: Boolean

mirrorWhenRightLeft

var mirrorWhenRightLeft: Boolean

model

open var model: ButtonModel

Stores the button's state and notifies listeners when it changes.

monitorsDisplayRect

var monitorsDisplayRect: Boolean

nextInAccessibleReadOrder

var nextInAccessibleReadOrder: View?

opacity

var opacity: Float

opacityChanged

val opacityChanged: PropertyObservers<View, Float>

parent

var parent: View?

parentChange

val parentChange: PropertyObservers<View, View?>

pointerChanged

val pointerChanged: Pool<PointerListener>

pointerFilter

val pointerFilter: Pool<PointerListener>

pointerMotionChanged

val pointerMotionChanged: Pool<PointerMotionListener>

pointerMotionFilter

val pointerMotionFilter: Pool<PointerMotionListener>

pointerMotionPassedThrough

val pointerMotionPassedThrough: Pool<PointerMotionListener>

pointerOverChanged

val pointerOverChanged: PropertyObservers<Button, Boolean>

pointerOverIcon

var pointerOverIcon: Icon<Button>?

Icon when a Pointer is over the button

pointerOverSelectedIcon

var pointerOverSelectedIcon: Icon<Button>?

Icon when a Pointer is over the button and selected == true

pointerPassedThrough

val pointerPassedThrough: Pool<PointerListener>

position

override var position: Point

pressedChanged

val pressedChanged: PropertyObservers<Button, Boolean>

pressedIcon

var pressedIcon: Icon<Button>?

Icon when button pressed

rendered

var rendered: Boolean

selected

var selected: Boolean

true if the button is in the "on" state.

selectedIcon

var selectedIcon: Icon<Button>?

Icon when selected == true

size

override var size: Size

sizePreferencesChanged

val sizePreferencesChanged: PropertyObservers<View, View.SizePreferences>

styleChanged

val styleChanged: ChangeObservers<View>

text

var text: String

Text displayed on the button

textChanged

val textChanged: PropertyObservers<Button, String>

Notifies when the button's text is modified

toolTipText

var toolTipText: String

transform

open var transform: AffineTransform

transformChanged

val transformChanged: PropertyObservers<View, AffineTransform>

verticalAlignment

var verticalAlignment: VerticalAlignment

How icons and text are positioned vertically in the button

visibilityChanged

val visibilityChanged: BooleanObservers

visible

override var visible: Boolean

width

override var width: Double

override var x: Double

override var y: Double

zOrder

var zOrder: Int

Functions

click

open override fun click()

Causes the button to "press/release". This triggers the model to notify listeners of ButtonModel.fired.

Inherited functions

addedToDisplay

protected open fun addedToDisplay()

ancestorOf

protected open infix fun ancestorOf(view: View): Boolean

child

protected open fun child(at: Point): View?

contains

open operator override fun contains(point: Point): Boolean

protected operator fun contains(child: View): Boolean

contentDirectionChanged

protected fun contentDirectionChanged()

cursorChanged

protected fun cursorChanged(old: Cursor?, new: Cursor?)

doLayout

protected open fun doLayout()

enabledChanged

protected fun enabledChanged(old: Boolean, new: Boolean, filter: (View) -> Boolean)

filterKeyEvent

protected open fun filterKeyEvent(event: KeyEvent)

filterPointerEvent

protected open fun filterPointerEvent(event: PointerEvent)

filterPointerMotionEvent

protected open fun filterPointerMotionEvent(event: PointerEvent)

fromAbsolute

fun fromAbsolute(point: Point): Point

get

operator fun get(traversalType: FocusTraversalPolicy.TraversalType): Set<KeyState>?

handleDisplayRectEvent

protected open fun handleDisplayRectEvent(old: Rectangle, new: Rectangle)

handleKeyEvent

protected open fun handleKeyEvent(event: KeyEvent)

handlePointerEvent

protected open fun handlePointerEvent(event: PointerEvent)

handlePointerMotionEvent

protected open fun handlePointerMotionEvent(event: PointerEvent)

intersects

open infix fun intersects(point: Point): Boolean

relayout

protected open fun relayout()

removedFromDisplay

protected open fun removedFromDisplay()

render

open override fun render(canvas: Canvas)

rerender

fun rerender()

rerenderNow

fun rerenderNow()

revalidate

protected fun revalidate()

set

operator fun set(traversalType: FocusTraversalPolicy.TraversalType, keyStates: Set<KeyState>?)

shouldHandlePointerEvent

protected open fun shouldHandlePointerEvent(event: PointerEvent): Boolean

shouldHandlePointerMotionEvent

protected open fun shouldHandlePointerMotionEvent(event: PointerEvent): Boolean

shouldYieldFocus

open fun shouldYieldFocus(): Boolean

styleChanged

protected fun styleChanged(filter: (View) -> Boolean)

toAbsolute

fun toAbsolute(point: Point): Point

toLocal

fun toLocal(point: Point, from: View?): Point

toolTipText

open fun toolTipText(for: PointerEvent): String

toParent

fun toParent(point: Point): Point