Package com.marcpg.libpg.formular.question

Class TextQuestion

java.lang.Object
com.marcpg.libpg.formular.question.Question
com.marcpg.libpg.formular.question.TextQuestion
public class TextQuestion extends Question
A question with text, that supports any characters between ASCII 32 (' ') and 126 ('~').
Note that most features will require you to manually implement the JNA dependency (>5.14.0)!
Since:
0.0.8
See Also:

  • Constructor Details

    • TextQuestion

      public TextQuestion(@Pattern("[a-z0-9_-]+") String id, String title, String description, int characterLimit)
      Creates a new text question with a specific character limit.
      Parameters:
      id - The question's unique identifier.
      title - The question's title.
      description - The question's description.
      characterLimit - How long the text can be.

    • TextQuestion

      public TextQuestion(@Pattern("[a-z0-9_-]+") String id, String title, String description)
      Creates a new text question with the default character limit of 128.
      Parameters:
      id - The question's unique identifier.
      title - The question's title.
      description - The question's description.

  • Method Details

    • resetState

      public void resetState()
      Description copied from class: Question
      Resets the state of this question to be as if it was just created. Won't reset the question's settings, but only the already chosen and rendered things.
      Specified by:
      resetState in class Question

    • getCharacterLimit

      public int getCharacterLimit()
      Gets the text question's character limit, which is 128 by default.
      Returns:
      The character limit.

    • setInput

      public void setInput(CharSequence input)
      Sets the input, if the question isn't already submitted.
      Parameters:
      input - The input.

    • submit

      public void submit(CharSequence input)
      Submits the question with a specific input.
      Parameters:
      input - The input to be submitted.

    • submit

      public void submit()
      Description copied from class: Question
      Submits the question with the current choice and locks in a final answer.
      Specified by:
      submit in class Question

    • getInput

      public String getInput()
      Description copied from class: Question
      Gets the current or preferably final input of the question.
      Specified by:
      getInput in class Question
      Returns:
      The current or preferably final input of this question.

    • toResult

      public FormularResult.Result toResult()
      Description copied from class: Question
      Converts this question to a Result, that can be used in a FormularResult.
      Specified by:
      toResult in class Question
      Returns:
      The converted result.

    • cliRender

      public void cliRender()
      Renders the current question to System.out. Will only work for CLIFormulars.
      If the character limit is set to 128, it will ask this: Enter Text (0/128):
      Specified by:
      cliRender in class Question