Package megamek.common.options

Interface IOptionInfo

All Known Subinterfaces:
IOption
All Known Implementing Classes:
Option
public interface IOptionInfo
Represents GUI data to allow the user to set the option

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Return verbose description of the option suitable for context help, tip etc.
    String
    getDisplayableName()
    Returns the user-friendly name suitable for displaying in the options editor dialogs etc.
    String
    getDisplayableNameWithValue()
    Returns the user-friendly name suitable for displaying in cases where not only the Name, but also it value is required (like edge).
    int
    getTextFieldLength()
    returns the length of the text field (how many characters).
    boolean
    isLabelBeforeTextField()
    returns on which side of the text field the label is.

  • Method Details

    • getDisplayableName

      String getDisplayableName()
      Returns the user-friendly name suitable for displaying in the options editor dialogs etc.
      Returns:
      displayable name

    • getDisplayableNameWithValue

      String getDisplayableNameWithValue()
      Returns the user-friendly name suitable for displaying in cases where not only the Name, but also it value is required (like edge).
      Returns:
      displayable name

    • getDescription

      String getDescription()
      Return verbose description of the option suitable for context help, tip etc.
      Returns:
      option description

    • getTextFieldLength

      int getTextFieldLength()
      returns the length of the text field (how many characters).

    • isLabelBeforeTextField

      boolean isLabelBeforeTextField()
      returns on which side of the text field the label is.