01: package net.sourceforge.squirrel_sql.client.session.mainpanel.objecttree.tabs;
02:
03: /*
04: * Copyright (C) 2001-2004 Colin Bell
05: * colbell@users.sourceforge.net
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation; either
10: * version 2.1 of the License, or (at your option) any later version.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this library; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20: */
21: import java.awt.Component;
22:
23: import net.sourceforge.squirrel_sql.fw.sql.IDatabaseObjectInfo;
24:
25: import net.sourceforge.squirrel_sql.client.session.ISession;
26:
27: /**
28: * This interface defines the behaviour for a tab in one of the object panels.
29: *
30: * @author <A HREF="mailto:colbell@users.sourceforge.net">Colin Bell</A>
31: */
32: public interface IObjectTab {
33: /**
34: * Return the title for the tab.
35: *
36: * @return The title for the tab.
37: */
38: String getTitle();
39:
40: /**
41: * Return the hint for the tab.
42: *
43: * @return The hint for the tab.
44: */
45: String getHint();
46:
47: /**
48: * Return the component to be displayed in the panel.
49: *
50: * @return The component to be displayed in the panel.
51: */
52: Component getComponent();
53:
54: /**
55: * Set the current session.
56: *
57: * @param session Current session.
58: */
59: void setSession(ISession session);
60:
61: /**
62: * Set the <TT>IDatabaseObjectInfo</TT> object that specifies the object that
63: * is to have its information displayed.
64: *
65: * @param value <TT>IDatabaseObjectInfo</TT> object that specifies
66: * the currently selected object. This can be <TT>null</TT>.
67: */
68: void setDatabaseObjectInfo(IDatabaseObjectInfo value);
69:
70: /**
71: * This tab has been selected.
72: */
73: void select();
74:
75: /**
76: * Clears the current view.
77: */
78: void clear();
79:
80: /**
81: * Rebuild the tab. This usually means that some kind of configuration
82: * data has changed (I.E. the output type has changed from text to table).
83: */
84: void rebuild();
85: }
|