01: package net.sourceforge.squirrel_sql.fw.datasetviewer;
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.util.IMessageHandler;
24:
25: public interface IDataSetViewer {
26: /** Minimum width (in nbr of characters) for a column. */
27: int MIN_COLUMN_WIDTH = 3;
28:
29: /** Maximum width (in nbr of characters) for a column. */
30: int MAX_COLUMN_WIDTH = 50;
31:
32: /**
33: * Allow some DataSetViewers to complete their initialization.
34: */
35: public void init(IDataSetUpdateableModel updateableObject);
36:
37: /**
38: * Get the rowcount of the DataSet
39: */
40: int getRowCount();
41:
42: /**
43: * Clear the output.
44: */
45: void clear();
46:
47: /**
48: * Specify the column headings to use.
49: *
50: * @param hdgs Column headings to use.
51: */
52: void setColumnDefinitions(ColumnDisplayDefinition[] hdgs);
53:
54: /**
55: * Return the column headings to use.
56: *
57: * @return the column headings to use.
58: */
59: ColumnDisplayDefinition[] getColumnDefinitions();
60:
61: /**
62: * Specify whether to show the column headings.
63: *
64: * @param show <TT>true</TT> if headibgs to be shown else <TT>false</TT>.
65: */
66: void showHeadings(boolean show);
67:
68: /**
69: * Return whether to show the column headings.
70: *
71: * @return whether to show the column headings.
72: */
73: boolean getShowHeadings();
74:
75: void show(IDataSet ds) throws DataSetException;
76:
77: void show(IDataSet ds, IMessageHandler msgHandler)
78: throws DataSetException;
79:
80: /**
81: * Indicates that the output display should scroll to the top.
82: */
83: void moveToTop();
84:
85: /**
86: * Get the component for this viewer.
87: *
88: * @return The component for this viewer.
89: */
90: Component getComponent();
91:
92: /**
93: * Get the reference to the updateable model object that represents the
94: * actual data behind the GUI that fw is displaying.
95: *
96: * @return the object IDataSetUpdateableModel object.
97: */
98: IDataSetUpdateableModel getUpdateableModelReference();
99: }
|