Module omix.api
Package omix.lang

Interface UserRequest

public interface UserRequest
This interface offers access to Omix dialog widgets for messaging and user input in OVL scripts. User requests do not take effect during initialization of OVL extensions.
Author:
Dr. Peter Droste, Omix Visualization

  • Method Summary

    Modifier and Type Method Description
    void critical​(String message)
    Shows an error message dialog window with the given text.
    Brush getBrush​(String message)
    Asks the user to choose a paint brush by displaying the submitted message.
    Color getColor​(String message)
    Asks the user to choose a color by displaying the submitted message.
    Date getDate​(String message)
    Asks the user to enter a date by displaying the submitted message.
    DateTime getDateTime​(String message)
    Asks the user to enter date and time by displaying the submitted message.
    double getDouble​(String message)
    Asks the user to enter a double value by displaying the submitted message.
    double getDouble​(String message, double min, double max)
    Asks the user to enter a double value by displaying the submitted message.
    File getFile()
    Asks the user to choose a file.
    File getFile​(String filter)
    Asks the user to choose a file of the given file suffix (for example: *.csv, *.txt).
    int getInteger​(String message)
    Asks the user to enter an integer value by displaying the submitted message.
    int getInteger​(String message, int min, int max)
    Asks the user to enter an integer value by displaying the submitted message.
    Paint getPaint​(String message)
    Asks the user to choose a paint value by displaying the submitted message.
    String getPassword​(String message)
    Asks the user to enter a password by displaying the submitted message.
    String getText​(String message)
    Asks the user to enter a text value by displaying the submitted message.
    String getText​(String message, String regExp)
    Asks the user to enter a text value by displaying the submitted message.
    Time getTime​(String message)
    Asks the user to enter a time by displaying the submitted message.
    void information​(String message)
    Shows an information message dialog window with the given message.
    boolean message​(String message)
    Shows an message dialog window with the given message and OK-Cancel-buttons.
    boolean question​(String message)
    Shows an message dialog window with the given message and Yes-No-buttons.
    <T> T select​(String message, List<T> entries)
    Asks the user to select an item from the submitted list of entries.
    <T> T selectFromCustomProperties​(Class<T> type, Component item)
    Asks the user to select an object from custom properties.
    @IsVarType Object selectFromCustomProperties​(Component item)
    Asks the user to select an object from custom properties.
    <T> List<T> selectMultiple​(String message, List<T> entries)
    Asks the user to select multiple items from the submitted list of entries.
    void warning​(String message)
    Shows a warning message dialog window with the given message.

  • Method Details

    • getInteger

      int getInteger​(String message)
      Asks the user to enter an integer value by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered value

    • getInteger

      int getInteger​(String message, int min, int max)
      Asks the user to enter an integer value by displaying the submitted message. The int value must match the minimum and maximum value.
      Parameters:
      message - displayed message
      min - minimum value
      max - maximum value
      Returns:
      the entered value

    • getDouble

      double getDouble​(String message)
      Asks the user to enter a double value by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered value

    • getDouble

      double getDouble​(String message, double min, double max)
      Asks the user to enter a double value by displaying the submitted message. The double value must match the minimum and maximum value.
      Parameters:
      message - displayed message
      min - minimum value
      max - maximum value
      Returns:
      the entered value

    • getText

      String getText​(String message)
      Asks the user to enter a text value by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered text

    • getText

      String getText​(String message, String regExp)
      Asks the user to enter a text value by displaying the submitted message. The text string must match the regular expression (see regular expressions in the java reference documentation).
      Parameters:
      message - displayed message
      regExp - regular expression
      Returns:
      the entered text

    • getPassword

      String getPassword​(String message)
      Asks the user to enter a password by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered password

    • getColor

      Color getColor​(String message)
      Asks the user to choose a color by displaying the submitted message.

      Color

      Parameters:
      message - displayed message
      Returns:
      the choosen color

    • getPaint

      Paint getPaint​(String message)
      Asks the user to choose a paint value by displaying the submitted message.

      Paint

      Parameters:
      message - displayed message
      Returns:
      the choosen paint

    • getBrush

      Brush getBrush​(String message)
      Asks the user to choose a paint brush by displaying the submitted message.

      Brush

      Parameters:
      message - displayed message
      Returns:
      the choosen paint brush

    • getDate

      Date getDate​(String message)
      Asks the user to enter a date by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered date

    • getDateTime

      DateTime getDateTime​(String message)
      Asks the user to enter date and time by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered date and time

    • getTime

      Time getTime​(String message)
      Asks the user to enter a time by displaying the submitted message.
      Parameters:
      message - displayed message
      Returns:
      the entered time

    • getFile

      File getFile​(String filter)
      Asks the user to choose a file of the given file suffix (for example: *.csv, *.txt).
      Parameters:
      filter - file filter
      Returns:
      the selected file

    • getFile

      File getFile()
      Asks the user to choose a file.
      Returns:
      the selected file

    • select

      <T> T select​(String message, List<T> entries)
      Asks the user to select an item from the submitted list of entries.
      Type Parameters:
      T - type of the entries
      Parameters:
      message - to be displayed
      entries - a list of available options
      Returns:
      the chosen entry

    • selectMultiple

      <T> List<T> selectMultiple​(String message, List<T> entries)
      Asks the user to select multiple items from the submitted list of entries.
      Type Parameters:
      T - type of the entries
      Parameters:
      message - to be displayed
      entries - a list of available options
      Returns:
      the chosen entries

    • selectFromCustomProperties

      @IsVarType Object selectFromCustomProperties​(Component item)
      Asks the user to select an object from custom properties.
      Parameters:
      item - the network item
      Returns:
      the chosen custom property value
      Since:
      Omix 1.8.0

    • selectFromCustomProperties

      <T> T selectFromCustomProperties​(Class<T> type, Component item)
      Asks the user to select an object from custom properties.
      Type Parameters:
      T - type of the selected value
      Parameters:
      type - restrict selection to class type
      item - the network item
      Returns:
      the chosen custom property value
      Since:
      Omix 1.8.0

    • question

      boolean question​(String message)
      Shows an message dialog window with the given message and Yes-No-buttons. This method returns true of the Yes button was pressed, false otherwise.
      Parameters:
      message - displayed message
      Returns:
      true if YES

    • message

      boolean message​(String message)
      Shows an message dialog window with the given message and OK-Cancel-buttons. This method returns true of the OK button was pressed, false otherwise.
      Parameters:
      message - displayed message
      Returns:
      true if OK

    • information

      void information​(String message)
      Shows an information message dialog window with the given message.
      Parameters:
      message - displayed message

    • warning

      void warning​(String message)
      Shows a warning message dialog window with the given message.
      Parameters:
      message - displayed message

    • critical

      void critical​(String message)
      Shows an error message dialog window with the given text.
      Parameters:
      message - displayed message