Author: chatellier Date: 2009-05-29 13:46:15 +0000 (Fri, 29 May 2009) New Revision: 2293 Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/ui/SaveVerifier.java Log: Add documentation on SaveVerifier. Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/ui/SaveVerifier.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/ui/SaveVerifier.java 2009-05-29 13:32:33 UTC (rev 2292) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/ui/SaveVerifier.java 2009-05-29 13:46:15 UTC (rev 2293) @@ -20,9 +20,28 @@ package fr.ifremer.isisfish.ui; /** + * Isis interface modification verifier. + * + * Check that unsaved datas need to be saved. + * + * @author letellier + * + * @version $Revision$ * - * @author letellier + * Last update: $Date$ + * by : $Author$ */ public interface SaveVerifier { + + /** + * Tell verifier to check for unsaved modification. + * + * Then return user choice ({@link javax.swing.JOptionPane} type). + * + * @return user JOptionPane response + * @see javax.swing.JOptionPane#YES_OPTION + * @see javax.swing.JOptionPane#NO_OPTION + * @see javax.swing.JOptionPane#CANCEL_OPTION + */ public int checkEdit(); } Property changes on: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/ui/SaveVerifier.java ___________________________________________________________________ Name: svn:keywords + Date Author Revision