KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > list > CmsListMacroFormatter


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/CmsListMacroFormatter.java,v $
3  * Date : $Date: 2005/06/23 11:11:43 $
4  * Version: $Revision: 1.7 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.list;
33
34 import org.opencms.i18n.CmsMessageContainer;
35
36 import java.text.MessageFormat JavaDoc;
37 import java.util.Locale JavaDoc;
38
39 /**
40  * This list formatter uses the <code>{@link MessageFormat}</code> class for macro like formatting.<p>
41  *
42  * @author Michael Moossen
43  *
44  * @version $Revision: 1.7 $
45  *
46  * @since 6.0.0
47  */
48 public class CmsListMacroFormatter implements I_CmsListFormatter {
49
50     /** pattern for <code>{@link MessageFormat}</code>. */
51     private final CmsMessageContainer m_mask;
52
53     /**
54      * Default constructor that sets the mask to use.<p>
55      *
56      * @param mask pattern for <code>{@link MessageFormat}</code>
57      */
58     public CmsListMacroFormatter(CmsMessageContainer mask) {
59
60         m_mask = mask;
61     }
62
63     /**
64      * @see org.opencms.workplace.list.I_CmsListFormatter#format(java.lang.Object, java.util.Locale)
65      */
66     public String JavaDoc format(Object JavaDoc data, Locale JavaDoc locale) {
67
68         if (data == null) {
69             return null;
70         }
71         String JavaDoc locMask = m_mask.key(locale);
72         MessageFormat JavaDoc formatter = new MessageFormat JavaDoc(locMask, locale);
73         return formatter.format(new Object JavaDoc[] {data});
74     }
75
76     /**
77      * Returns the mask.<p>
78      *
79      * @return the mask
80      */
81     public CmsMessageContainer getMask() {
82
83         return m_mask;
84     }
85 }
Popular Tags