Package org.refcodes.mixin

Interface BoxGrid<T>

  • Type Parameters:
    T - The type of the grid elements for drawing a box grid, may be a char or a sprite or a byte array.
    All Known Subinterfaces:
    BoxGrid.BoxGridProperty<T>
    All Known Implementing Classes:
    BoxGridImpl

    public interface BoxGrid<T>
    The BoxGrid interface defines all elements required to draw boxes into a grid. For example the grid might be a text mode screen and the elements might be the according characters. Taking the example of the text mode screen and the character elements, them elements might be as follows: ┌──┬──┐ ╔══╦══╗ ╒══╤══╕ ╓──╥──╖ │ │ │ ║ ║ ║ │ │ │ ║ ║ ║ ├──┼──┤ ╠══╬══╣ ╞══╪══╡ ╟──╫──╢ │ │ │ ║ ║ ║ │ │ │ ║ ║ ║ └──┴──┘ ╚══╩══╝ ╘══╧══╛ ╙──╨──╜

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  BoxGrid.BoxGridBuilder<T,B>
      Provides a builder for a box grid property returning the builder for applying multiple build operations.
      static interface  BoxGrid.BoxGridMutator<T>
      Provides a mutator for a box grid property.
      static interface  BoxGrid.BoxGridProperty<T>
      Provides a channel property.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      T getBottomDividerEdge​()
      Returns the box's bottom divider edge character, for example "┴".
      T getBottomLeftEdge​()
      Returns the box's bottom left edge character, for example "└".
      T getBottomLine​()
      Returns the box's bottom line character, for example "─".
      T getBottomRightEdge​()
      Returns the box's bottom right edge character, for example "┘".
      T getDividerEdge​()
      Returns the box's divider edge character, for example "┼".
      T getDividerLine​()
      Returns the box's divider line character, for example "│".
      T getInnerLine​()
      Returns the box's inner line character, for example "─".
      T getLeftEdge​()
      Returns the box's left edge character, for example "├".
      T getLeftLine​()
      Returns the box's left line character, for example "│".
      T getRightEdge​()
      Returns the box's right edge character, for example "┤".
      T getRightLine​()
      Returns the box row's right line character, for example "│".
      T getTopDividerEdge​()
      Returns the box's top divider edge character, for example "┬".
      T getTopLeftEdge​()
      Returns the box's top left edge character, for example "┌".
      T getTopLine​()
      Returns the box's top line character, for example "─" .
      T getTopRightEdge​()
      Returns the box's top right edge character, for example "┐".

    • Method Detail

      • getLeftEdge

        T getLeftEdge​()
        Returns the box's left edge character, for example "├".
        Returns:
        The left edge character.

      • getTopLeftEdge

        T getTopLeftEdge​()
        Returns the box's top left edge character, for example "┌".
        Returns:
        The top left edge character.

      • getDividerEdge

        T getDividerEdge​()
        Returns the box's divider edge character, for example "┼".
        Returns:
        The divider edge character.

      • getTopDividerEdge

        T getTopDividerEdge​()
        Returns the box's top divider edge character, for example "┬".
        Returns:
        The top divider edge character.

      • getTopRightEdge

        T getTopRightEdge​()
        Returns the box's top right edge character, for example "┐".
        Returns:
        The top right edge character.

      • getRightEdge

        T getRightEdge​()
        Returns the box's right edge character, for example "┤".
        Returns:
        The top left edge character.

      • getLeftLine

        T getLeftLine​()
        Returns the box's left line character, for example "│".
        Returns:
        The left line character.

      • getDividerLine

        T getDividerLine​()
        Returns the box's divider line character, for example "│".
        Returns:
        The divider line character.

      • getRightLine

        T getRightLine​()
        Returns the box row's right line character, for example "│".
        Returns:
        The right line character.

      • getTopLine

        T getTopLine​()
        Returns the box's top line character, for example "─" .
        Returns:
        The top line character.

      • getBottomRightEdge

        T getBottomRightEdge​()
        Returns the box's bottom right edge character, for example "┘".
        Returns:
        The bottom left edge character.

      • getBottomDividerEdge

        T getBottomDividerEdge​()
        Returns the box's bottom divider edge character, for example "┴".
        Returns:
        The bottom divider edge character.

      • getBottomLeftEdge

        T getBottomLeftEdge​()
        Returns the box's bottom left edge character, for example "└".
        Returns:
        The bottom left edge character.

      • getBottomLine

        T getBottomLine​()
        Returns the box's bottom line character, for example "─".
        Returns:
        The bottom line character.

      • getInnerLine

        T getInnerLine​()
        Returns the box's inner line character, for example "─".
        Returns:
        The inner line character.