001    /*
002    * $Id: ErrorReporter.java,v 1.3 2006/04/19 21:56:12 rbair Exp $
003    *
004    * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
005    * Santa Clara, California 95054, U.S.A. All rights reserved.
006     *
007     * This library is free software; you can redistribute it and/or
008     * modify it under the terms of the GNU Lesser General Public
009     * License as published by the Free Software Foundation; either
010     * version 2.1 of the License, or (at your option) any later version.
011     * 
012     * This library is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015     * Lesser General Public License for more details.
016     * 
017     * You should have received a copy of the GNU Lesser General Public
018     * License along with this library; if not, write to the Free Software
019     * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
020    */
021    
022    package org.jdesktop.swingx;
023    
024    /**
025     * Abstract class contains all the declarations that needs to be
026     * implemented to add error reporting to standard JXErrorDislog.
027     *
028     * @author Alexander Zuev
029     * @version 1.0
030     */
031    public abstract class ErrorReporter {
032        /**
033         * This method will be called if user clicks 'report' button
034         * on the error dialog.
035         *
036         * @param info <code>IncidentInfo</code> that incapsulates all the information
037         *        system wants to report using this report facility.
038         */
039        public abstract void reportIncident(IncidentInfo info);
040    
041        /**
042         * This method allows on-the-fly configuration of the 'report' button.
043         * If this method returns non-null value this string will replace default
044         * text on this button.
045         *
046         * @return string to be put on 'report' button or null for default string.
047         */
048        public String getActionName() {
049            return null;
050        }
051    }