Package com.spinyowl.legui.component

Class TextArea

java.lang.Object
com.spinyowl.legui.component.Component
com.spinyowl.legui.component.TextArea
All Implemented Interfaces:
TextComponent, Viewport, Serializable
public class TextArea extends Component implements TextComponent, Viewport
Panel with scroll bars. Default container layout is null.
See Also:

  • Constructor Details

    • TextArea

      public TextArea()
      Default constructor. Used to create component instance without any parameters.

      Also if you want to make it easy to use with Json marshaller/unmarshaller component should contain empty constructor.

    • TextArea

      public TextArea(float x, float y, float width, float height)
      Constructor with position and size parameters.
      Parameters:
      x - x position position in parent component.
      y - y position position in parent component.
      width - width of component.
      height - height of component.

    • TextArea

      public TextArea(org.joml.Vector2f position, org.joml.Vector2f size)
      Constructor with position and size parameters.
      Parameters:
      position - position position in parent component.
      size - size of component.

  • Method Details

    • getAnimation

      public Animation getAnimation()
      Returns animation of scrollable panel.
      Returns:
      animation.

    • setAnimation

      public void setAnimation(Animation animation)
      Used to set scrollable panel animation. Automatically starts animation.
      Parameters:
      animation - scroll bar animation to set.

    • getVerticalScrollBar

      public ScrollBar getVerticalScrollBar()
      Returns vertical scrollbar.
      Returns:
      vertical scrollbar.

    • setVerticalScrollBar

      public void setVerticalScrollBar(ScrollBar verticalScrollBar)
      Used to set vertical scroll bar.
      Parameters:
      verticalScrollBar - vertical scroll bar to set.

    • getHorizontalScrollBar

      public ScrollBar getHorizontalScrollBar()
      Returns horizontal scrollbar.
      Returns:
      horizontal scrollbar.

    • setHorizontalScrollBar

      public void setHorizontalScrollBar(ScrollBar horizontalScrollBar)
      Used to set horizontal scroll bar.
      Parameters:
      horizontalScrollBar - horizontal scroll bar to set.

    • setHorizontalScrollBarVisible

      public void setHorizontalScrollBarVisible(boolean enabled)

    • setVerticalScrollBarVisible

      public void setVerticalScrollBarVisible(boolean enabled)

    • setHorizontalScrollBarHeight

      public void setHorizontalScrollBarHeight(float height)

    • setVerticalScrollBarWidth

      public void setVerticalScrollBarWidth(float width)

    • getTextAreaField

      public TextAreaField getTextAreaField()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Component

    • toString

      public String toString()
      Overrides:
      toString in class Component

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Component

    • getViewport

      public Component getViewport()

    • getViewportSize

      public org.joml.Vector2f getViewportSize()
      Specified by:
      getViewportSize in interface Viewport

    • getViewportViewSize

      public org.joml.Vector2f getViewportViewSize()
      Specified by:
      getViewportViewSize in interface Viewport

    • getTextState

      public TextState getTextState()
      Description copied from interface: TextComponent
      Returns current text state.
      Specified by:
      getTextState in interface TextComponent
      Returns:
      text state of component.

    • setTextState

      public void setTextState(TextState textState)
      Description copied from interface: TextComponent
      Used to set text state
      Specified by:
      setTextState in interface TextComponent
      Parameters:
      textState - new text state to set.

    • getCaretPosition

      public int getCaretPosition()
      Returns caret position.
      Returns:
      caret position.

    • setCaretPosition

      public void setCaretPosition(int caretPosition)
      Used to set caret position.
      Parameters:
      caretPosition - caret position to set.

    • isEditable

      public boolean isEditable()
      Returns true if text is editable.
      Returns:
      true if text is editable.

    • setEditable

      public void setEditable(boolean editable)
      Used to set editable text or not.
      Parameters:
      editable - editable text or not.

    • getMouseCaretPosition

      public int getMouseCaretPosition()
      Returns mouse caret position.
      Returns:
      mouse caret position.

    • setMouseCaretPosition

      public void setMouseCaretPosition(int mouseCaretPosition)
      Used to set mouse caret position.
      Parameters:
      mouseCaretPosition - mouse caret position to set.

    • getStartSelectionIndex

      public int getStartSelectionIndex()
      Returns start selection index.
      Returns:
      start selection index.

    • setStartSelectionIndex

      public void setStartSelectionIndex(int startSelectionIndex)
      Used to set start selection index.
      Parameters:
      startSelectionIndex - start selection index to set.

    • getEndSelectionIndex

      public int getEndSelectionIndex()
      Returns end selection index.
      Returns:
      end selection index.

    • setEndSelectionIndex

      public void setEndSelectionIndex(int endSelectionIndex)
      Used to set end selection index.
      Parameters:
      endSelectionIndex - end selection index to set.

    • getSelection

      public String getSelection()
      Returns selected text.
      Returns:
      selected text.

    • getTabSize

      public int getTabSize()
      Returns tab size in spaces.
      Returns:
      tab size in spaces.

    • setTabSize

      public void setTabSize(int tabSize)
      Used to set tab size in spaces.
      Parameters:
      tabSize - tab size in spaces.

    • resizeTextAreaField

      public void resizeTextAreaField()