polyui/org.polyfrost.polyui.component/Scrollable

Scrollable

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

Extensions to Component which allow it to listen to scroll events and scroll itself.

Since

1.6.0

Inheritors

Constructors

constructor(at: Vec2, size: Vec2, visibleSize: Vec2, alignment: Align, focusable: Boolean)

Properties

@ApiStatus.Internal

@get:JvmName(name = "getParentOrNull")

var _parent: Component?

@get:JvmName(name = "acceptsInput")

var acceptsInput: Boolean

var alignment: Align

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

@get:JvmName(name = "getAt")

@set:JvmName(name = "setAt")

var at: Vec2

var children: ArrayList<Component>?

createdWithSetPosition

@get:JvmName(name = "createdWithSetPosition")

val createdWithSetPosition: Boolean

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

createdWithSetSize

@get:JvmName(name = "createdWithSetSize")

val createdWithSetSize: Boolean

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

@get:JvmName(name = "isFocusable")

val focusable: Boolean

@get:JvmName(name = "isFocused")

var focused: Boolean

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

var hasVisibleSize: Boolean

open var height: Float

val initialized: Boolean

@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.

open override var isEnabled: Boolean

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

val isOperating: Boolean

true if this drawable has any operations.

@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:

@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.

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:

var operations: ArrayList<ComponentOp>?

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.

@SideEffects(values = ["_parent"])

var parent: Component

lateinit var polyUI: PolyUI

@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.

@get:JvmName(name = "isRawResize")

var rawResize: Boolean

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

open var renders: Boolean

Whether this component should be rendered.

@get:JvmName(name = "screenAt")

override var 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.

@get:JvmName(name = "isScrolling")

val scrolling: Boolean

@get:JvmName(name = "isScrollingX")

val scrollingX: Boolean

@get:JvmName(name = "isScrollingY")

val scrollingY: Boolean

open var shouldScroll: Boolean

@get:JvmName(name = "getSize")

@set:JvmName(name = "setSize")

@get:JvmName(name = "isSizeValid")

val sizeValid: Boolean

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

@get:JvmName(name = "getVisibleSize")

@set:JvmName(name = "setVisibleSize")

open override var visibleSize: Vec2

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

open var width: Float

@SideEffects(values = ["x", "_x", "atValid", "this.children::x"], when = "value != x")

var x: Float

@SideEffects(values = ["y", "_y", "atValid", "this.children::y"], when = "value != y")

var y: Float

Functions

open override fun accept(event: Event): Boolean

called when this component receives an event.

@Locking(when = "children.size != 0")

fun addChild(vararg children: Component)

fun addChild(child: Component, recalculate: Boolean = true)

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

fun addOperation(vararg operations: ComponentOp)

@Locking(when = "operation.verify() == true")

fun addOperation(operation: ComponentOp): Boolean

Add a ComponentOp to this component.

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).

@JvmName(name = "calculateSize")

open fun calculateSize(): Vec2

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

@ApiStatus.Experimental

fun clearHandlers()

Clear all event handlers for this component.

fun clipChildren()

@JvmName(name = "contains")

operator fun contains(point: Vec2): Boolean

operator fun contains(box: Vec4): Boolean

fun Component.countChildren(): Int

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

open fun debugString(): String?

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

open fun extraToString(): String?

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

open override fun fixVisibleSize()

open operator fun get(index: Int): Component

operator fun get(id: String): Component

operator fun get(x: Float, y: Float): Component

fun Component.hasChildIn(x: Float, y: Float, width: Float, height: Float): Boolean

hasListenersFor

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.

fun intersects(x: Float, y: Float, width: Float, height: Float): Boolean

fun Component.isChildOf(component: Component?): Boolean

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

fun isInside(x: Float, y: Float): Boolean

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.

fun <S : Component> Component.locate(id: String): S?

Locate a component by its name.

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

fun popScroll(renderer: Renderer)

@Locking(when = "this.children != null")

open fun position()

Reposition all the children of this component.

fun pushScroll(delta: Long, renderer: Renderer): Boolean

open override fun recalculate()

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

fun remove(recalculate: Boolean = true)

Remove this component from its parent.

fun removeChild(index: Int, recalculate: Boolean = true)

fun removeChild(child: Component, recalculate: Boolean = true)

removeOperation

@Locking(when = "operations != null")

fun removeOperation(componentOp: ComponentOp)

Remove an operation from this drawable.

fun rescale(scaleX: Float, scaleY: Float)

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

open override fun rescale0(scaleX: Float, scaleY: Float, withChildren: Boolean)

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

fun resetScroll()

reset the initial scroll position to the current position.

operator fun set(old: Int, new: Component)

operator fun set(old: Component, new: Component?)

Replace a child of this component with another component.

open override fun setup(polyUI: PolyUI): Boolean

give this a PolyUI reference.

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).

open override fun toString(): String

tryMakeScrolling

@Locking(when = "this.shouldScroll && this.hasVisibleSize && this.visibleSize > this.size")

fun tryMakeScrolling()