KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > event > ActionEvent


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet.event;
56
57 import org.apache.jetspeed.portlet.*;
58
59 /**
60  ** An <CODE>ActionEvent</CODE> is sent by the portlet container when
61  ** an HTTP request is received that is associated with one more
62  ** actions.
63  **
64  ** @see PortletAction
65  ** @see ActionListener
66  ** @see ActionAdapter
67  **
68  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
69  **/
70
71 public interface ActionEvent extends Event
72 {
73     /**
74      * Event identifier indicating that portlet request has been
75      * received that one or more actions associated with it. Each
76      * action will result in a separate event being fired.
77      *
78      * <P>
79      * An event with this id is fired when an action has to be
80      * performed.
81      * </P>
82      */
83     public final static int ACTION_PERFORMED = 1001;
84
85     /**
86      * Returns the action that this action event carries.
87      *
88      * @return the portlet action
89      */
90     public PortletAction getAction ();
91
92     /**
93      * Changes the mode of the portlet. Use this function to set the
94      * mode in which the portlet is shown next.
95      *
96      * @param mode the new portlet mode
97      */
98     public void changePortletMode(Portlet.Mode mode);
99     
100     /**
101      * Changes the state of the portlet window. Use this function
102      * to set the state in which the portlet window is shown next.
103      *
104      * @param state the new portlet window state
105      */
106     public void changePortletWindowState(PortletWindow.State state);
107 }
Popular Tags