Constructor Detail

Method Detail

• prioritize

  @ApiStatus.Experimental() final static <S extends Component> S prioritize(S $self)

  Prioritize this component, meaning it will, in relation to its siblings:

  • be drawn last (so visually on top)

  • receive events first

  this method is experimental as it may interfere with statically-typed references to children.

  Since:

  1.0.0

• relegate

  @ApiStatus.Experimental() final static <S extends Component> S relegate(S $self)

  Relegate this component, meaning it will, in relation to its siblings:

  • be drawn first (so visually on the bottom)

  • receive events last

  this method is experimental as it may interfere with statically-typed references to children.

  Since:

  1.1.71

• locate

   final static <S extends Component> S locate(Component $self, String id)

  Locate a component by its name.

  This method is recursive, meaning it will search through all children of this component.

  Parameters:

  id - the name of the drawable to locate.

  Returns:

  the drawable with the given name, or null if it was not found.

  Since:

  1.1.72

• isChildOf

   final static Boolean isChildOf(Component $self, Component component)

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

  Since:

  1.4.2

• isRelatedTo

   final static Boolean isRelatedTo(Component $self, Component component)

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

  Since:

  1.4.2

• countChildren

   final static Integer countChildren(Component $self)

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

  Since:

  1.0.1

• hasChildIn

   final static Boolean hasChildIn(Component $self, Float x, Float y, Float width, Float height)

  Returns:

  true if this drawable has a child that intersects the provided rectangle.

  Since:

  1.0.4