01: /*
02: *
03: * Copyright 2007 Luca Molino (luca.molino@assetdata.it)
04: *
05: * Licensed under the Apache License, Version 2.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.romaframework.module.portal;
18:
19: import org.romaframework.aspect.view.ViewCallback;
20:
21: /**
22: * Interface that rapresents a portlet
23: *
24: * @author l.molino
25: *
26: */
27: public interface PortalPage extends ViewCallback {
28:
29: /**
30: * Method that returns the mode of PortalPage
31: * @return the current mode of this PortalPage
32: */
33: public byte getMode();
34:
35: /**
36: * Method that minimizes the portlet
37: *
38: */
39: public void minimize();
40:
41: /**
42: * Method that minimizes the portlet
43: *
44: */
45: public void maximize();
46:
47: /**
48: * User operations to do during minimizing
49: *
50: */
51: public void onMinimize();
52:
53: /**
54: * User operations to do during maximizing
55: *
56: */
57: public void onMaximize();
58:
59: public void onShow();
60:
61: public void onDispose();
62:
63: /**
64: * Method that sets a <code>String</code> containing the name of PortalPageContainer that
65: * contains this portlet
66: *
67: * @param iContainerName the name of the <code>PortalPageContaier</code>
68: * @see PortalPageContainer
69: */
70: public void setContainerName(String iContainerName);
71:
72: /**
73: * Method that returns a <code>String</code> containing the name of PortalPageContainer that
74: * contains this portlet
75: *
76: * @return the name of the container of this portlet
77: */
78: public String getContainerName();
79:
80: /**
81: * Method that removes this portlet from the user configuration.
82: *
83: * It uses the {@link #getContainerName()} method to know witch container has to be checked in preferences
84: * and (in case the className of this portlet is found) delete this portlet from its configuration.
85: *
86: */
87: public void removeFromPreferences();
88:
89: }
|