Package de.espirit.firstspirit.ui.operations

Interface OpenElementDataFormOperation

public interface OpenElementDataFormOperation
Operation providing means to open an element's data form.
Since:
5.0.102

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final OperationType<OpenElementDataFormOperation>
    TYPE
    Operation providing means to open an element's data form.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull RemoteFormData
    perform(@NotNull DataProvider element)
    Performs the operation on a data providing element.
    void
    setField(String name)
    Set a form field's name to focus on.
    void
    setFormData(FormData formData)
    Set a form data container providing overriding values for form fields.
    void
    setLanguage(Language language)
    Defines the language to display the form's data in.
    void
    setOpenEditable(boolean editable)
    Requests the displayed form to be opened for editing.

  • Field Details

  • Method Details

    • setLanguage

      void setLanguage(Language language)
      Defines the language to display the form's data in.
      Parameters:
      language - The project language for the data to be shown in the form.
      Since:
      5.0.102

    • setField

      void setField(String name)
      Set a form field's name to focus on. If the element's form does not have a field with the name given or the respective field cannot be focused, this setting will be ignored.
      Parameters:
      name - The name of the form field.
      Since:
      5.0.102

    • setFormData

      void setFormData(FormData formData)
      Set a form data container providing overriding values for form fields. If a field of the element's form is not provided or is not set, the element's original value of that field will be used.
      Parameters:
      formData - A form data container.
      Since:
      5.0.102

    • setOpenEditable

      void setOpenEditable(boolean editable)
      Requests the displayed form to be opened for editing. If this fails for any reason, this setting will silently be ignored and the form will be displayed read only.
      Parameters:
      editable - true, to request opening the form editable.
      Since:
      5.0.102

    • perform

      @NotNull @NotNull RemoteFormData perform(@NotNull @NotNull DataProvider element) throws OperationSetupException
      Performs the operation on a data providing element.

      Be aware that this method operates asynchronously! That is, the method call will return immediately, while the operation will be performed concurrently. Subsequent calls on the RemoteFormData-instance returned will most probably block until the operation is finished. If such a subsequent call is done from inside the event dispatch thread, that call most probably will time out and throw the respective exception.

      Parameters:
      element - The data providing element.
      Returns:
      A form data providing access to the fields of opened form. If a modifying access is not possible, a read onlyform data will be provided.
      Throws:
      OperationSetupException - If the operation cannot be performed with the given setup.
      Since:
      5.0.102