org.netbeans.validation.api.ui
Interface ValidationUI


public interface ValidationUI

User interface controller which can show the user a problem, possibly disabling closing a dialog or similar if the problem is of Severity.FATAL.

ValidationPanel provides an implementation of this interface; it is also relatively easy to write an adapter to drive an existing UI in an existing application.

Note: An instance of ValidationUI should only be used with one ValidationGroup - otherwise one UI having no problems will clear the problem passed by another UI.

Author:
Tim Boudreau

Method Summary
Modifier and Type Method and Description
 void clearProblem()
          Set the user interface to the state where no problem is displayed and the user is free to continue.
 void setProblem(Problem problem)
          Set the problem to be displayed to the user.
 

Method Detail

clearProblem

void clearProblem()
Set the user interface to the state where no problem is displayed and the user is free to continue.


setProblem

void setProblem(Problem problem)
Set the problem to be displayed to the user. Depending on the severity of the problem, the user interface may want to block the user from continuing until it is fixed (for example, disabling the Next button in a wizard or the OK button in a dialog)

Parameters:
problem - A problem that the user should be shown, which may affect the state of the UI as a whole