Package overit.geocall.basic.ui.control

Class InputOption.MatchingOption

java.lang.Object
overit.geocall.basic.ui.control.InputOption.MatchingOption
All Implemented Interfaces:
Serializable
Enclosing class:
InputOption
public class InputOption.MatchingOption extends Object implements Serializable
Object that represents the option that match with the searched value; it is composed by a label, a title and a boolean that defines if the value is visible or not (it is not active). It can contain a foreign key field value, used by the InputLookup
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    MatchingOption(String label, String title, String fkvalue, boolean visible)
    Creates a new MatchinOption instance

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFKValue()
    Returns the string that defines the value of the field used as foreign key (for the InputLookup and only with the multi lookup mechanism)
    String
    getLabel()
    Returns the label of the MatchingOption object
    String
    getTitle(boolean onlyExplicit)
    Returns the title of the MatchingOption object, ie the tooltip that will appear when the user stay with the cursor on the element
    boolean
    isVisible()
    Returns the visibility state of the MatchingOption object

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MatchingOption

      public MatchingOption(String label, String title, String fkvalue, boolean visible)
      Creates a new MatchinOption instance
      Parameters:
      label - The label that will be displayed
      title - The title, ie the tooltip that will appear when the user stay with the cursor on the element
      fkvalue - The foreign key field value, used in the InputLookup object (only with the multi lookup mechanism)
      visible - defines if the value is visible (true) or not (false)

  • Method Details

    • getLabel

      public String getLabel()
      Returns the label of the MatchingOption object
      Returns:
      The string that represents the label, correctly padded the reach the minimum length or the maximum length

    • getTitle

      public String getTitle(boolean onlyExplicit)
      Returns the title of the MatchingOption object, ie the tooltip that will appear when the user stay with the cursor on the element
      Parameters:
      onlyExplicit - boolean that defines if the title must be the one explicitly set or can be automatically created using the label, when the label is trimmed
      Returns:
      The string that represents the title

    • getFKValue

      public String getFKValue()
      Returns the string that defines the value of the field used as foreign key (for the InputLookup and only with the multi lookup mechanism)
      Returns:
      The foreign key field value

    • isVisible

      public boolean isVisible()
      Returns the visibility state of the MatchingOption object
      Returns:
      A boolean value that defines if the value is visible (true) or not (false)