01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.openide;
42:
43: import javax.swing.JComponent;
44:
45: /** The exception informs about fail in wizard panel validation and provides
46: * a localized description what's wrong. Also can return JComponent which should
47: * be focused to correct wrong values.
48: *
49: * @author Jiri Rechtacek
50: * @since 4.28
51: */
52: final public class WizardValidationException extends Exception {
53: private String localizedMessage;
54: private JComponent source;
55:
56: /** Creates a new instance of WizardValidationException */
57: private WizardValidationException() {
58: }
59:
60: /**
61: * Creates a new exception instance.
62: * @param source component which should have focus to correct wrong values
63: * @param message the detail message
64: * @param localizedMessage description notifies an user what value must be corrected
65: */
66: public WizardValidationException(JComponent source, String message,
67: String localizedMessage) {
68: super (message);
69: this .source = source;
70: this .localizedMessage = localizedMessage;
71: }
72:
73: /**
74: *
75: * @return JComponent for request focus to correct wrong values
76: * or null if there is no useful component to focus it
77: */
78: public JComponent getSource() {
79: return source;
80: }
81:
82: /**
83: *
84: * @return description will notifies an user what value must be corrected
85: */
86: public String getLocalizedMessage() {
87: return (localizedMessage != null) ? localizedMessage : this
88: .getMessage();
89: }
90: }
|