daee1a962d51987b11612bdbd6d5ffd23a063d81
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / ui / InputValidator.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.ui;
17
18 /**
19  * The validator for input dialogs.
20  *
21  * @see Messages#showInputDialog(String, String, javax.swing.Icon, String, InputValidator)
22  * @see Messages#showInputDialog(java.awt.Component, String, String, javax.swing.Icon, String, InputValidator)
23  * @see Messages#showInputDialog(com.intellij.openapi.project.Project, String, String, javax.swing.Icon, String, InputValidator)
24  * @see Messages#showEditableChooseDialog(String, String, javax.swing.Icon, String[], String, InputValidator)
25  */
26 public interface InputValidator {
27   /**
28    * Checks whether the <code>inputString</code> is valid. It is invoked each time
29    * input changes.
30    *
31    * @param inputString the input to check
32    * @return true if input string is valid
33    */
34   boolean checkInput(String inputString);
35
36   /**
37    * This method is invoked just before message dialog is closed with OK code.
38    * If <code>false</code> is returned then then the message dialog will not be closed.
39    *
40    * @param inputString the input to check
41    * @return true if the dialog could be closed, false otherwhise.
42    */
43   boolean canClose(String inputString);
44 }