Constructor Detail

• Component

  Component(Vec2 at, Vec2 size, Align alignment)

Method Detail

• getName

   String getName()

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

  val text = myLayout["Text@4cf777e8"] as Text

• setName

   Unit setName(String name)

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

  val text = myLayout["Text@4cf777e8"] as Text

• getPolyUI

   final PolyUI getPolyUI()

• getInitialized

   final Boolean getInitialized()

• getChildren

   final ArrayList<Component> getChildren()

• getParentOrNull

   final Component getParentOrNull()

• set_parent

   final Unit set_parent(@ApiStatus.Internal() Component _parent)

• getParent

   final Component getParent()

• setParent

   final Unit setParent(@SideEffects(values = {"_parent"}) Component parent)

• getX

   final Float getX()

• setX

   final Unit setX(@SideEffects(values = {"x", "_x", "atValid", "this.children::x"}, when = "value != x") Float x)

• getY

   final Float getY()

• setY

   final Unit setY(@SideEffects(values = {"y", "_y", "atValid", "this.children::y"}, when = "value != y") Float y)

• getAt

   final Vec2 getAt()

• setAt

   final Unit setAt(Vec2 at)

• getScreenAt

   Vec2 getScreenAt()

• getWidth

   Float getWidth()

• setWidth

   Unit setWidth(Float width)

• getHeight

   Float getHeight()

• setHeight

   Unit setHeight(Float height)

• getSize

   final Vec2 getSize()

• setSize

   final Unit setSize(Vec2 size)

• isSizeValid

   final Boolean isSizeValid()

• getVisibleSize

   Vec2 getVisibleSize()

• getPadding

   final Vec4 getPadding()

• setPadding

   final Unit setPadding(Vec4 padding)

• getLayoutFlags

   final Byte getLayoutFlags()

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

  • bit 0: rawResize

  • bit 1: createdWithSetSize

  • bit 2: createdWithSetPosition

  • bit 3: layoutIgnored

  this means there are still 4 bits that can be used for simple boolean-type properties. this is protected so you can use it yourself, but more bits may be used internally in the future. In order to maintain forward compatability, you should use the highest indexes for your flags.

  Since:

  1.4.4

• setLayoutFlags

   final Unit setLayoutFlags(@ApiStatus.Internal() Byte layoutFlags)

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

  • bit 0: rawResize

  • bit 1: createdWithSetSize

  • bit 2: createdWithSetPosition

  • bit 3: layoutIgnored

  this means there are still 4 bits that can be used for simple boolean-type properties. this is protected so you can use it yourself, but more bits may be used internally in the future. In order to maintain forward compatability, you should use the highest indexes for your flags.

  Since:

  1.4.4

• isRawResize

   final Boolean isRawResize()

• setRawResize

   final Unit setRawResize(Boolean rawResize)

• isLayoutIgnored

   final Boolean isLayoutIgnored()

• setLayoutIgnored

   final Unit setLayoutIgnored(Boolean layoutIgnored)

• createdWithSetPosition

   final Boolean createdWithSetPosition()

• createdWithSetSize

   final Boolean createdWithSetSize()

• isPositioned

   final Boolean isPositioned()

• getRenders

   Boolean getRenders()

  Whether this component should be rendered.

  This is controlled by clipChildren to save resources by not drawing components which cannot be seen.

  Since:

  0.21.4

• setRenders

   Unit setRenders(Boolean renders)

• isEnabled

   Boolean isEnabled()

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

  Since:

  0.21.4

• setEnabled

   Unit setEnabled(Boolean isEnabled)

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

  Since:

  0.21.4

• getOperations

   final ArrayList<ComponentOp> getOperations()

• isOperating

   final Boolean isOperating()

• getAlignment

   final Align getAlignment()

• at

   final Unit at(Integer index, Float value)

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

  Since:

  1.1.0

• calculateSize

   Vec2 calculateSize()

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

  This function is only called if no size is supplied to this component at initialization. A return value of null indicates this component is not able to infer its own size, as it is for example, a Block with no reference. A component such as Text on the other hand, is able to infer its own size.

  This function is only ever called if sizeValid is false.

• size

   final Unit size(Integer index, Float value)

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

  Since:

  1.5.0

• fixVisibleSize

   Unit fixVisibleSize()

• setup

  @MustBeInvokedByOverriders() Boolean setup(PolyUI polyUI)

  give this a PolyUI reference.

  You can also use this method to do some calculations (such as text widths) that are not dependent on other sizes, or operations that require access to PolyUI things, like PolyUI.settings or PolyUI.translator

  this method is called once, and only once.

• rescale

  @Locking() final Unit rescale(Float scaleX, Float scaleY)

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

• rescale0

  @ApiStatus.Internal()@Locking()@MustBeInvokedByOverriders()@Synchronized() Unit rescale0(Float scaleX, Float scaleY, Boolean withChildren)

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

  Parameters:

  withChildren - if true, this method will also rescale its children.

• clipChildren

   final Unit clipChildren()

• isInside

   final Boolean isInside(Float x, Float y)

  Returns:

  true if the given point is inside this component.

• contains

   final Boolean contains(Vec2 point)

• contains

   final Boolean contains(Vec4 box)

• intersects

   final Boolean intersects(Float x, Float y, Float width, Float height)

  Returns:

  true if the component has at least one point inside the given box (x, y, width, height).

  Since:

  0.21.4

• position

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

  Reposition all the children of this component.

  Note that in most circumstances, recalculate is the method that you actually want.

  Since:

  1.0.2

• recalculate

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

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

  Since:

  1.0.7

• get

   Component get(Integer index)

• get

   final Component get(String id)

• get

   final Component get(Float x, Float y)

• set

  @Locking() final Unit set(Integer old, Component new)

• set

  @Locking()@Synchronized() final Unit set(Component old, Component new)

  Replace a child of this component with another component.

  This will add a nice, smooth Fade animation to the transition.

  Since:

  1.0.1

• addChild

  @Locking()@Synchronized() final Unit addChild(Component child, Boolean recalculate)

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

• addChild

  @Locking(when = "children.size != 0") final Unit addChild(Component children)

• removeChild

  @Locking() final Unit removeChild(Component child, Boolean recalculate)

• removeChild

  @Locking()@Synchronized() final Unit removeChild(Integer index, Boolean recalculate)

• remove

   final Unit remove(Boolean recalculate)

  Remove this component from its parent.

  Since:

  1.6.1

• debugString

   String debugString()

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

  Since:

  1.1.1

• addOperation

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

  Add a ComponentOp to this component.

  Returns:

  true if the operation was added, false if it was replaced.

• addOperation

  @Locking() final Unit addOperation(ComponentOp operations)

• removeOperation

  @Locking(when = "operations != null")@Synchronized() final Unit removeOperation(ComponentOp componentOp)

  Remove an operation from this drawable.

• extraToString

   String extraToString()

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

  Since:

  1.7.1

• toString

   String toString()