Interface ComponentPath

All Known Implementing Classes:
ComponentPath.Leaf, ComponentPath.Path
public interface ComponentPath
Represents a path of components in a user interface hierarchy.

It provides methods to create and manipulate component paths.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    ComponentPath.Leaf
    The Leaf class represents a leaf component path in the hierarchy.
    static final record 
    ComponentPath.Path
    The Path class represents a non-leaf component path in the hierarchy.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyFocus(boolean focused)
    Applies focus to or removes focus from the component associated with this component path.
    GuiEventListener
    component()
     
    static ComponentPath
    leaf(GuiEventListener component)
    Creates a leaf component path with the specified GuiEventListener component.
    static @Nullable ComponentPath
    path(ContainerEventHandler container, @Nullable ComponentPath childPath)
    Creates a component path with the specified ContainerEventHandler component and an optional child path.
    static ComponentPath
    path(GuiEventListener target, ContainerEventHandler... containerPath)
    Creates a new ComponentPath leaf node with the specified GuiEventListener component and an array of ContainerEventHandler ancestors.

  • Method Details

    • leaf

      static ComponentPath leaf(GuiEventListener component)
      Creates a leaf component path with the specified GuiEventListener component.

      Parameters:
      component - the component associated with the leaf path
      Returns:
      a new leaf component path.

    • path

      static @Nullable ComponentPath path(ContainerEventHandler container, @Nullable ComponentPath childPath)
      Creates a component path with the specified ContainerEventHandler component and an optional child path.

      Parameters:
      container - the component associated with the path
      childPath - the child path associated with the component
      Returns:
      a new component path, or null if the child path is null

    • path

      static ComponentPath path(GuiEventListener target, ContainerEventHandler... containerPath)
      Creates a new ComponentPath leaf node with the specified GuiEventListener component and an array of ContainerEventHandler ancestors.

      Parameters:
      target - the new 'Leaf' component associated with the path
      containerPath - the array of ancestor components associated with the path, ordered in reverse ascending order towards root.
      Returns:
      a new component path

    • component

      GuiEventListener component()

    • applyFocus

      void applyFocus(boolean focused)
      Applies focus to or removes focus from the component associated with this component path.
      Parameters:
      focused - true to apply focus, false to remove focus.