01: /*
02: * This file is part of the Tucana Echo2 Library.
03: * Copyright (C) 2006.
04: *
05: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
06: *
07: * The contents of this file are subject to the Mozilla Public License Version
08: * 1.1 (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: * http://www.mozilla.org/MPL/
11: *
12: * Software distributed under the License is distributed on an "AS IS" basis,
13: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14: * for the specific language governing rights and limitations under the
15: * License.
16: *
17: * Alternatively, the contents of this file may be used under the terms of
18: * either the GNU General Public License Version 2 or later (the "GPL"), or
19: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20: * in which case the provisions of the GPL or the LGPL are applicable instead
21: * of those above. If you wish to allow use of your version of this file only
22: * under the terms of either the GPL or the LGPL, and not to allow others to
23: * use your version of this file under the terms of the MPL, indicate your
24: * decision by deleting the provisions above and replace them with the notice
25: * and other provisions required by the GPL or the LGPL. If you do not delete
26: * the provisions above, a recipient may use your version of this file under
27: * the terms of any one of the MPL, the GPL or the LGPL.
28: */
29:
30: package tucana.echo2.app.widgetdash;
31:
32: /**
33: * Provides the state of a WidgetDash. The state consists of the widgets in the panel,
34: * and their positions. Additionally, the state contains the number of columns in the
35: * panel.
36: *
37: * @author Jeremy Volkman
38: *
39: */
40: public interface WidgetDashState {
41:
42: public static final int COLUMN_COUNT_DEFAULT = -1;
43:
44: /**
45: * Get the number of columns in the WidgetDash
46: * @return The number of columns
47: */
48: public int getColumnCount();
49:
50: /**
51: * Get the WidgetPosition for the given widget
52: * @param widget The widget
53: * @return The position of the given widget, or null if there is none set.
54: */
55: public WidgetPosition getWidgetPosition(WidgetIdentifier widget);
56:
57: /**
58: * Get the widgets in the WidgetDash. Since the state should be able
59: * to be serialized, only the WidgetIdentifiers are returned.
60: * @return The ids of the widgets in the WidgetDash.
61: */
62: public WidgetIdentifier[] getWidgetIdentifiers();
63: }
|