polyui/org.polyfrost.polyui.component/Inputtable

Inputtable

abstract class Inputtable(at: Vec2, size: Vec2, alignment: Align, val focusable: Boolean) : Component

Extensions to Component which allow it to send and receive events.

Since

1.6.0

Inheritors

Constructors

Link copied to clipboard
constructor(at: Vec2, size: Vec2, alignment: Align, focusable: Boolean)

Properties

Link copied to clipboard
@ApiStatus.Internal
@get:JvmName(name = "getParentOrNull")
var _parent: Component?
Link copied to clipboard
@get:JvmName(name = "acceptsInput")
var acceptsInput: Boolean
Link copied to clipboard
var alignment: Align

The alignment properties of this component, which control global padding and how it positions it children.

Link copied to clipboard
@get:JvmName(name = "getAt")
@set:JvmName(name = "setAt")
var at: Vec2
Link copied to clipboard
var children: <Error class: unknown class><Component>?
Link copied to clipboard
@get:JvmName(name = "isClipped")
@set:ApiStatus.Internal
var clipped: Boolean

If true, this component will not be drawn as it is considered to be clipped outside of the screen, either by being outside its parent or the screen entirely. This is controlled by clipChildren.

Link copied to clipboard
@get:JvmName(name = "createdWithSetPosition")
val createdWithSetPosition: Boolean

Returns true if this component had a position specified at creation time.

Link copied to clipboard
@get:JvmName(name = "createdWithSetSize")
val createdWithSetSize: Boolean

Returns `true if this component had a size specified at creation time.

Link copied to clipboard
@get:JvmName(name = "isFocusable")
val focusable: Boolean
Link copied to clipboard
@get:JvmName(name = "isFocused")
var focused: Boolean

focused flag for this component. Only ever true if focusable is true.

Link copied to clipboard
open var height: Float
Link copied to clipboard
val initialized: <Error class: unknown class>
Link copied to clipboard
@Dispatches(event = "Mouse.Entered", when = "value > INPUT_NONE")
@Dispatches(event = "Mouse.Exited", when = "value == INPUT_NONE")
@set:ApiStatus.Internal
var inputState: Byte

The current input state of this component. Note that this value is not responsible for dispatching events such as Event.Mouse.Exited or Event.Mouse.Pressed. It is just here for tracking purposes and for your benefit.

Link copied to clipboard
open override var isEnabled: Boolean

Disabled flag for this component. Dispatches the Event.Lifetime.Disabled and Event.Lifetime.Enabled events.

Link copied to clipboard
val isOperating: <Error class: unknown class>

true if this drawable has any operations.

Link copied to clipboard
@ApiStatus.Internal
var layoutFlags: Byte

Flags that store various states of this component regarding the org.polyfrost.polyui.layout.LayoutController and resizing. Currently, the following is stored here:

Link copied to clipboard
@get:JvmName(name = "isLayoutIgnored")
var layoutIgnored: Boolean

If true, this component will be ignored during the org.polyfrost.polyui.layout.LayoutController's routine of placing components. Use this if you want to specify it manually based on something else, for example.

Link copied to clipboard
open var name: String

This is the name of this component, and you can use it to get components from a layout by ID, e.g:

Link copied to clipboard
var operations: <Error class: unknown class><ComponentOp>?
Link copied to clipboard
var padding: Vec4

Padding for this component. This is used by the positioner to ensure that there is adequate space around each object in the UI.

Link copied to clipboard
@SideEffects(values = ["_parent"])
var parent: Component
Link copied to clipboard
lateinit var polyUI: PolyUI
Link copied to clipboard
@get:JvmName(name = "isPositioned")
val positioned: Boolean

Returns true if this component has been initialized to the point where it has been positioned, e.g. Event.Lifetime.Init has been dispatched, and Event.Lifetime.PostInit is about to be.

Link copied to clipboard
@get:JvmName(name = "isRawResize")
var rawResize: Boolean

This property controls weather this component resizes "raw", meaning it will not respect the aspect ratio.

Link copied to clipboard
open var renders: Boolean

Whether this component should be rendered.

Link copied to clipboard
@get:JvmName(name = "getScreenAt")
open val screenAt: Vec2

Return the position of this component on the screen. This is used if scrolling or a similar mechanic means that its screen position is not the same as x and y.

Link copied to clipboard
@get:JvmName(name = "getSize")
@set:JvmName(name = "setSize")
var size: Vec2
Link copied to clipboard
@get:JvmName(name = "isSizeValid")
val sizeValid: Boolean

returns true if the size of this component is valid (not zero)

Link copied to clipboard
@get:JvmName(name = "getVisibleSize")
open val visibleSize: Vec2

The visible size of this component. This is used for clipping and scrolling.

Link copied to clipboard
open var width: Float
Link copied to clipboard
@SideEffects(values = ["x", "_x", "atValid", "this.children::x"], when = "value != x")
var x: Float
Link copied to clipboard
@SideEffects(values = ["y", "_y", "atValid", "this.children::y"], when = "value != y")
var y: Float

Functions

Link copied to clipboard
@MustBeInvokedByOverriders
open fun accept(event: Event): Boolean

called when this component receives an event.

Link copied to clipboard
@Locking(when = "children.size != 0")
fun addChild(vararg children: Component)

@Locking
@Synchronized
fun addChild(child: Component, index: Int = -1, recalculate: Boolean = true)

the runtime equivalent of adding children to this component during the constructor.

Link copied to clipboard
@Locking
fun addOperation(vararg operations: ComponentOp)

@Locking(when = "operation.verify() == true")
fun addOperation(operation: ComponentOp): Boolean

Add a ComponentOp to this component.

Link copied to clipboard
fun at(index: Int, value: Float)

Set the position of this component programmatically. use this if you don't want to hardcode x or y (for example in mirroring or flipping).

Link copied to clipboard
@JvmName(name = "calculateSize")
open fun calculateSize(): Vec2

Use this function to calculate the size of this component. DO NOT include children in this calculation!

Link copied to clipboard
@ApiStatus.Experimental
fun clearHandlers()

Clear all event handlers for this component.

Link copied to clipboard
fun clipChildren()
Link copied to clipboard
@JvmName(name = "contains")
operator fun contains(point: Vec2): Boolean
operator fun contains(box: Vec4): Boolean
Link copied to clipboard
fun Component.countChildren(): Int

Returns a count of this component's children, including children of children.

Link copied to clipboard
open fun debugString(): String?

Override this function to add things to the debug display of this component.

Link copied to clipboard
open fun draw()

This method is called every frame, and is used to update the component.

Link copied to clipboard
open fun extraToString(): String?

Supply extra information to the toString representation of this object. Keep it short.

Link copied to clipboard
open fun fixVisibleSize()
Link copied to clipboard
open operator fun get(index: Int): Nothing
operator fun get(id: String): Component
operator fun get(x: Float, y: Float): Nothing
Link copied to clipboard
fun Component.getMyIndex(): Int

Returns the index of this component in its parent's children list.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Component.hasChildIn(x: Float, y: Float, width: Float, height: Float): Boolean
Link copied to clipboard
fun hasListenersFor(event: Class<out Event>): Boolean

returns true if this component has any non-specific event handlers registered for it.

fun hasListenersFor(event: Event): Boolean

returns true if this component has any specific event handlers registered for it.

Link copied to clipboard
fun intersects(x: Float, y: Float, width: Float, height: Float): Boolean
Link copied to clipboard
fun Component.isChildOf(component: Component?): Boolean

Returns true if this component is a child of the specified component.

Link copied to clipboard
open fun isInside(x: Float, y: Float): Boolean
Link copied to clipboard
fun Component.isRelatedTo(component: Component?): Boolean

Returns true if this component is a child of the specified component, or if the component is a child of this.

Link copied to clipboard
fun <S : Component> Component.locate(id: String): S?

Locate a component by its name.

Link copied to clipboard
fun <E : Event, S : Inputtable> S.on(event: E, handler: S.(E) -> Boolean): S
@JvmName(name = "addEventhandler")
inline fun <E : Event, S : Inputtable> S.on(event: E, crossinline handler: S.(E) -> Unit): S
Link copied to clipboard
inline fun <T : Component> Component.onAll(noinline action: (T) -> Unit)

Perform a function on all matching components (itself and its children) of the given type.

fun <T : Component> Component.onAll(cls: Class<T>, action: (T) -> Unit)

Perform a function on all matching components (itself and its children) of the given class.

Link copied to clipboard
@Locking(when = "this.children != null")
@Synchronized
open fun position()

Reposition all the children of this component.

Link copied to clipboard
@Locking(when = "this.children != null")
@Synchronized
open fun recalculate()

Fully recalculate this component's size, and any of its children's positions.

Link copied to clipboard
fun Component.refont(old: FontFamily, new: FontFamily): Component

Perform a refont operation on this component, changing its font from the old FontFamily to the new FontFamily, and all its children.

Link copied to clipboard
fun remove(recalculate: Boolean = true)

Remove this component from its parent.

Link copied to clipboard
@Locking
@Synchronized
fun removeChild(index: Int, recalculate: Boolean = true)
@Locking
fun removeChild(child: Component, recalculate: Boolean = true)
Link copied to clipboard
@Locking(when = "operations != null")
@Synchronized
fun removeOperation(componentOp: ComponentOp)

Remove an operation from this drawable.

Link copied to clipboard
@Locking
fun rescale(scaleX: Float, scaleY: Float)

Method that is called when the physical size of the total window area changes.

Link copied to clipboard
@ApiStatus.Internal
@Locking
@MustBeInvokedByOverriders
@Synchronized
open fun rescale0(scaleX: Float, scaleY: Float, withChildren: Boolean)

raw rescale method that does not check rawResize and uses the given scale factors directly.

Link copied to clipboard
@ApiStatus.Internal
@Locking
fun rescaleToPolyUIInstance()

rescale this component to be up to and scaling that has happened to this PolyUI instance.

Link copied to clipboard
fun Component.retheme(old: Colors, new: Colors, animate: Boolean = false): Component

Perform a retheme operation on this component, changing its palette from the old Colors to the new Colors, and all its children.

Link copied to clipboard
@Locking
operator fun set(old: Int, new: Component): <Error class: unknown class>

@Locking
@Synchronized
operator fun set(old: Component, new: Component?)

Replace a child of this component with another component.

Link copied to clipboard
open override fun setup(polyUI: PolyUI): Boolean

give this a PolyUI reference.

Link copied to clipboard
fun size(index: Int, value: Float)

Set the size of this component programmatically. use this if you don't want to hardcode width or height (for example in mirroring or flipping).

Link copied to clipboard
open override fun toString(): String