| Titleable.java |
1 /**
2 * Distribution License:
3 * JSword is free software; you can redistribute it and/or modify it under
4 * the terms of the GNU Lesser General Public License, version 2.1 as published by
5 * the Free Software Foundation. This program is distributed in the hope
6 * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8 * See the GNU Lesser General Public License for more details.
9 *
10 * The License is available on the internet at:
11 * http://www.gnu.org/copyleft/lgpl.html
12 * or by writing to:
13 * Free Software Foundation, Inc.
14 * 59 Temple Place - Suite 330
15 * Boston, MA 02111-1307, USA
16 *
17 * Copyright: 2005
18 * The copyright to this program is held by it's authors.
19 *
20 * ID: $Id: Titleable.java 1966 2009-10-30 01:15:14Z dmsmith $
21 */
22 package org.crosswire.common.swing.desktop;
23
24 import org.crosswire.common.swing.desktop.event.TitleChangedListener;
25
26 /**
27 * A Titleable object has a title which may be gotten.
28 *
29 * @see gnu.lgpl.License for license details.<br>
30 * The copyright to this program is held by it's authors.
31 * @author DM Smith [ dmsmith555 at yahoo dot com]
32 */
33 public interface Titleable {
34 /**
35 * The title is something that can be displayed to a user either in the tab
36 * of a TDIViewLayout or a title bar of a MDIViewLayout window.
37 *
38 * @return the title
39 */
40 String getTitle();
41
42 /**
43 * Register an interest in being notified of changes to the title.
44 *
45 * @param listener
46 */
47 void addTitleChangedListener(TitleChangedListener listener);
48
49 /**
50 * Remove regristration of interest in listening for title changes
51 *
52 * @param listener
53 */
54 void removeTitleChangedListener(TitleChangedListener listener);
55 }
56