01: /**
02: * L2FProd.com Common Components 7.3 License.
03: *
04: * Copyright 2005-2007 L2FProd.com
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: */package com.l2fprod.common.swing;
18:
19: /**
20: * A model for {@link com.l2fprod.common.swing.JTipOfTheDay}.<br>
21: */
22: public interface TipModel {
23:
24: /**
25: * @return the number of tips in this model
26: */
27: int getTipCount();
28:
29: /**
30: * @param index
31: * @return the tip at <code>index</code>
32: * @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= getTipCount()).
33: */
34: Tip getTipAt(int index);
35:
36: /**
37: * A tip.<br>
38: */
39: interface Tip {
40:
41: /**
42: * @return very short (optional) description for the tip
43: */
44: String getTipName();
45:
46: /**
47: * The tip object to show. See {@link JTipOfTheDay} for supported object
48: * types.
49: *
50: * @return the tip to display
51: */
52: Object getTip();
53: }
54:
55: }
|