Package com.spinyowl.legui.component

Class Frame

java.lang.Object
com.spinyowl.legui.component.Frame
public class Frame extends Object
Default structure which should be associated with OpenGL window. Contains two default layers:
  • Component layer - holds components and always on bottom of all layers.
  • Tooltip layer - holds tooltips and always on top of all layers.
NOTE: layers processed in reverse order - from top to bottom.

  • Constructor Details

    • Frame

      public Frame(float width, float height)
      Used to create frame and initialize layers with specified size.
      Parameters:
      width - width.
      height - height.

    • Frame

      public Frame()
      Default frame constructor.

    • Frame

      public Frame(org.joml.Vector2f size)
      Used to create frame and initialize layer containers with specified size.
      Parameters:
      size - size.

  • Method Details

    • setSize

      public void setSize(org.joml.Vector2f size)
      Used to set layer containers size. NOTE: All LayerContainers will be resized to specified size!
      Parameters:
      size - frame size.

    • setSize

      public void setSize(float width, float height)
      Used to set layer containers size. NOTE: All LayerContainers will be resized to specified size!
      Parameters:
      width - width.
      height - height.

    • addLayer

      public void addLayer(Layer layer)
      Used to add layer to frame. NOTE: layers processed in reverse order - from top to bottom.
      Parameters:
      layer - layer to add.

    • removeLayer

      public void removeLayer(Layer layer)
      Used to remove layer from frame.
      Parameters:
      layer - layer to remove.

    • containsLayer

      public boolean containsLayer(Layer layer)
      Used to check if layer list contains provided layer.
      Parameters:
      layer - layer to check.
      Returns:
      true if layer list contains provided layer.

    • getComponentLayer

      public Layer getComponentLayer()
      Used to retrieve default component layer. NOTE: layers processed in reverse order - from top to bottom.
      Returns:
      default component layer.

    • setComponentLayer

      public void setComponentLayer(Layer componentLayer)

    • getTooltipLayer

      public Layer getTooltipLayer()
      Used to retrieve default tooltip layer. NOTE: layers processed in reverse order - from top to bottom.
      Returns:
      default tooltip layer.

    • setTooltipLayer

      public void setTooltipLayer(Layer tooltipLayer)

    • getLayers

      public List<Layer> getLayers()
      Used to retrieve layers added by developer. NOTE: layers processed in reverse order - from top to bottom.
      Returns:
      layers added by developer.

    • getAllLayers

      public List<Layer> getAllLayers()
      Used to retrieve all layers where
      • List[0] - default component layer.
      • List[1]-List[length-2] - layers added by developer.
      • List[length-1] - default tooltip layer.

      NOTE: layers processed in reverse order - from top to bottom.

      Returns:
      all layers.

    • getContainer

      public Component getContainer()
      Used to retrieve container of default component layer.
      Returns:
      container of default component layer.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object