WizardDescriptor.ExtendedAsynchronousValidatingPanel (Dialogs API)

Type Parameters:: Data -

All Superinterfaces:: WizardDescriptor.AsynchronousValidatingPanel<Data>, WizardDescriptor.Panel<Data>, WizardDescriptor.ValidatingPanel<Data>

Enclosing class:: WizardDescriptor

public static interface WizardDescriptor.ExtendedAsynchronousValidatingPanel<Data> extends WizardDescriptor.AsynchronousValidatingPanel<Data>

A special interface for panels that need to do additional asynchronous validation when Next or Finish button is clicked.

During background validation is Next or Finish button disabled. On validation success wizard automatically progress to next panel or finishes.

During background validation Cancel button is hooked to signal the validation thread using interrupt().

Since:: 7.31

Method Summary

Modifier and Type

Method

Description

void

finishValidation()

Called synchronously from UI thread when the background validation is finished (even when throwing validation exception).

void

prepareValidation()

Called synchronously from UI thread when Next of Finish buttons clicked.

void

validate()

Is called in separate thread when Next of Finish buttons are clicked and allows deeper check to find out that panel is in valid state and it is ok to leave it.

Methods inherited from interface org.openide.WizardDescriptor.Panel
addChangeListener, getComponent, getHelp, isValid, readSettings, removeChangeListener, storeSettings

Method Details
- prepareValidation
  
  void prepareValidation()
  
  Called synchronously from UI thread when Next of Finish buttons clicked. It allows to lock user input to assure official data for background validation.
  
  Specified by:
  
  prepareValidation in interface WizardDescriptor.AsynchronousValidatingPanel<Data>
- validate
  
  void validate() throws WizardValidationException
  
  Is called in separate thread when Next of Finish buttons are clicked and allows deeper check to find out that panel is in valid state and it is ok to leave it.
  
  Specified by:
  
  validate in interface WizardDescriptor.AsynchronousValidatingPanel<Data>
  
  Specified by:
  
  validate in interface WizardDescriptor.ValidatingPanel<Data>
  
  Throws:
  
  WizardValidationException - when validation fails
- finishValidation
  
  void finishValidation()
  
  Called synchronously from UI thread when the background validation is finished (even when throwing validation exception). It allows to enable user input locked in prepareValidation() method.