KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > PortletTitle


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;
56
57 import java.util.Locale JavaDoc;
58
59 /**
60  * The <CODE>PortletTitle</CODE> interface has to be implemented if
61  * a portlet wants to support client, device, and/or user dependent
62  * titles. An instance of the implementation can be set in the portlet
63  * descriptor of the portlet, otherwise the portlet container will pick the
64  * title from the portlet configuration.
65  *
66  * @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
67  * @see PortletWindow
68  */
69 public interface PortletTitle
70 {
71     /**
72      ** Called by the portlet container to retrieve the text of the
73      ** portlet title. The given locale, client, and session can but
74      ** don't have to be considered all at once. Examples are
75      **
76      ** <UL>
77      ** <LI>language-dependant titles for multi-lingual portals
78      ** <LI>shorter titles for WAP phones
79      ** <LI>the number of messages in a mailbox portlet
80      ** </UL>
81      **
82      ** The session may be <CODE>null</CODE>, if the user is not logged
83      ** in. If returning <CODE>null</CODE> the portlet container shows
84      ** the static title from the portlet configuration.
85      **
86      ** @param locale
87      ** the locale
88      ** @param client
89      ** the client
90      ** @param session
91      ** the portlet session
92      ** @param context
93      ** the portlet context
94      **
95      ** @return the text of the portlet title
96      **/
97
98     public String JavaDoc getText (Locale JavaDoc locale,
99                            Client client,
100                            PortletSession session,
101                            PortletContext context);
102 }
103
Popular Tags