Module org.tentackle.fx
Package org.tentackle.fx

Interface ErrorPopupSupported

All Known Subinterfaces:
FxComponent, FxTextComponent
All Known Implementing Classes:
AbstractTextFieldDelegate, FxCheckBox, FxCheckBoxDelegate, FxChoiceBox, FxChoiceBoxDelegate, FxColorPicker, FxColorPickerDelegate, FxComboBox, FxComboBoxDelegate, FxComponentDelegate, FxDatePicker, FxDatePickerDelegate, FxHTMLEditor, FxHTMLEditorDelegate, FxListView, FxListViewDelegate, FxPasswordField, FxPasswordFieldDelegate, FxRadioButton, FxRadioButtonDelegate, FxTableView, FxTableViewDelegate, FxTextArea, FxTextAreaDelegate, FxTextComponentDelegate, FxTextField, FxTextFieldDelegate, FxToggleButton, FxToggleButtonDelegate, FxTreeTableView, FxTreeTableViewDelegate, FxTreeView, FxTreeViewDelegate, TotalsTableView
public interface ErrorPopupSupported
Controls that support error popups must implement this interface.
Author:
harald

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getError()
    Gets the error message.
    void
    hideErrorPopup()
    Hides the error popup if shown.
    boolean
    isErrorTemporary()
    Returns whether this is a temporary error.
    Temporary errors are set by the value translators typically if some parsing failed.
    void
    setError(String error)
    Sets the error message.
    Notice that an empty string will set the style but does not show any popup.
    void
    setErrorTemporary(boolean errorTemporary)
    Sets the temporary error flag.
    void
    showErrorPopup()
    Shows the error popup.
    Requires the error message set.

  • Method Details

    • getError

      String getError()
      Gets the error message.
      Returns:
      the message, null if no error

    • setError

      void setError(String error)
      Sets the error message.
      Notice that an empty string will set the style but does not show any popup.
      Parameters:
      error - the error message, null to clear

    • isErrorTemporary

      boolean isErrorTemporary()
      Returns whether this is a temporary error.
      Temporary errors are set by the value translators typically if some parsing failed. Non-temporary are set by the application, for example when a persistence validation failed.
      Returns:
      true if temporary error

    • setErrorTemporary

      void setErrorTemporary(boolean errorTemporary)
      Sets the temporary error flag.
      Parameters:
      errorTemporary - true if this is a temporary error

    • showErrorPopup

      void showErrorPopup()
      Shows the error popup.
      Requires the error message set.

    • hideErrorPopup

      void hideErrorPopup()
      Hides the error popup if shown.