1 /***
2 * Copyright (c) 2003 held jointly by the individual authors.
3 *
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2.1 of the License, or
7 * (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; with out even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation,
16 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 *
18 * > http://www.gnu.org/copyleft/lesser.html
19 * > http://www.opensource.org/licenses/lgpl-license.php
20 */
21 package net.mlw.vlh.web.util;
22
23 import javax.servlet.jsp.JspException;
24 import javax.servlet.jsp.PageContext;
25
26 /***
27 * Abstracts the means by which text is displayed.
28 *
29 * @author Matthew L. Wilson
30 * @version $Revision: 1.2 $ $Date: 2004/07/26 12:56:21 $
31 *
32 */
33 public interface DisplayHelper
34 {
35 /***
36 * Abstracts the means by which text is displayed.
37 *
38 * @param pageContext
39 * The jsp PageContext
40 * @param key
41 * The key, which could be the value to display or some sort of key
42 * to the text value.
43 *
44 * @throws JspException
45 * Thrown by underling implementation.
46 *
47 * @return The text value.
48 */
49 public abstract String help(PageContext pageContext, String key) throws JspException;
50 }