01: /*
02: * Copyright 2002 Sun Microsystems, Inc. All
03: * rights reserved. Use of this product is subject
04: * to license terms. Federal Acquisitions:
05: * Commercial Software -- Government Users
06: * Subject to Standard License Terms and
07: * Conditions.
08: *
09: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
10: * are trademarks or registered trademarks of Sun Microsystems,
11: * Inc. in the United States and other countries.
12: */
13:
14: package com.sun.portal.providers.containers.jsp.tab;
15:
16: import java.util.Map;
17:
18: /**
19: * This interface represents a tab that cannot be modified.
20: *
21: */
22: public interface UnmodifiableTab {
23: /**
24: * Gets the name of the tab
25: *
26: * @return Name of the tab as a string
27: */
28: public String getName();
29:
30: /**
31: * Gets the display name of the tab
32: *
33: * @return Displayname of the tab as a string
34: */
35: public String getDisplayname();
36:
37: /**
38: * Gets the html encoded name of the tab
39: *
40: * @return HTML Encoded name as a string
41: */
42: public String getEncodedName();
43:
44: /**
45: * Gets the description of the tab
46: *
47: * @return Description of the tab as a string
48: */
49: public String getDesc();
50:
51: /**
52: * Determines if the tab is removable.
53: *
54: * @return <code>true</code> or <code>false</code>, indicating if the
55: * tab is removable
56: */
57: public boolean isRemovable();
58:
59: /**
60: * Determines if the tab is renamable.
61: *
62: * @return <code>true</code> or <code>false</code>, indicating if the
63: * tab is renamable
64: */
65: public boolean isRenamable();
66:
67: /**
68: * Determines if the tab is predefined or user created.
69: *
70: * @return <code>true</code> or <code>false</code>, indicating if the
71: * tab is predefined
72: */
73: public boolean isPredefined();
74:
75: /**
76: * Gets the TabProperties as a map
77: *
78: * @return Properties of the tab as a map.
79: */
80: public Map getTabMap();
81:
82: }
|