KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opencms > workplace > CmsXmlWpBoxDefFile


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsXmlWpBoxDefFile.java,v $
3 * Date : $Date: 2005/06/27 23:22:07 $
4 * Version: $Revision: 1.2 $
5 *
6 * This library is part of OpenCms -
7 * the Open Source Content Mananagement System
8 *
9 * Copyright (C) 2001 The OpenCms Group
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 OpenCms, please see the
22 * OpenCms Website: http://www.opencms.org
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 */
28
29
30 package com.opencms.workplace;
31
32 import org.opencms.file.CmsFile;
33 import org.opencms.file.CmsObject;
34 import org.opencms.main.CmsException;
35
36 import com.opencms.template.A_CmsXmlContent;
37
38 /**
39  * Content definition for the workplace messagebox element definition file.
40  *
41  * @author Michael Emmerich
42  * @version $Revision: 1.2 $ $Date: 2005/06/27 23:22:07 $
43  *
44  * @deprecated Will not be supported past the OpenCms 6 release.
45  **/
46
47 public class CmsXmlWpBoxDefFile extends A_CmsXmlContent {
48     
49     /**
50      * Default constructor.
51      */
52     
53     public CmsXmlWpBoxDefFile() throws CmsException {
54         super();
55     }
56     
57     /**
58      * Constructor for creating a new object containing the content
59      * of the given filename.
60      *
61      * @param cms CmsObject object for accessing system resources.
62      * @param filename Name of the body file that shoul be read.
63      */
64     
65     public CmsXmlWpBoxDefFile(CmsObject cms, CmsFile file) throws CmsException {
66         super();
67         init(cms, file);
68     }
69     
70     /**
71      * Constructor for creating a new object containing the content
72      * of the given filename.
73      *
74      * @param cms CmsObject object for accessing system resources.
75      * @param filename Name of the body file that shoul be read.
76      */
77     
78     public CmsXmlWpBoxDefFile(CmsObject cms, String JavaDoc filename) throws CmsException {
79         super();
80         init(cms, filename);
81     }
82     
83     /**
84      * Gets a description of this content type.
85      * @return Content type description.
86      */
87     
88     public String JavaDoc getContentDescription() {
89         return "OpenCms workplace messagebox";
90     }
91     
92     public String JavaDoc getErrorpage(String JavaDoc title, String JavaDoc message, String JavaDoc reason,
93             String JavaDoc suggestion, String JavaDoc link, String JavaDoc msgReason, String JavaDoc msgButton) throws CmsException {
94         setData(CmsWorkplaceDefault.C_ERROR_TITLE, title);
95         setData(CmsWorkplaceDefault.C_ERROR_MESSAGE, message);
96         setData(CmsWorkplaceDefault.C_ERROR_REASON, reason);
97         setData(CmsWorkplaceDefault.C_ERROR_SUGGESTION, suggestion);
98         setData(CmsWorkplaceDefault.C_ERROR_LINK, link);
99         setData(CmsWorkplaceDefault.C_ERROR_MSG_REASON, msgReason);
100         setData(CmsWorkplaceDefault.C_ERROR_MSG_BUTTON, msgButton);
101         return getProcessedDataValue(CmsWorkplaceDefault.C_TAG_ERRORPAGE);
102     }
103     
104     /**
105      * Gets the processed data for a errorbox.
106      * @param title The title of this errorbox.
107      * @param message The message of this errorbox.
108      * @param reason The reason of this errorbox.
109      * @param suggestion The suggestion of this errorbox.
110      * @param link The reference where this errorbox forwards to.
111      * @param msgReason Fixed reason text in errorbox.
112      * @param msgButton Fixed button text.
113      * @return Processed errorbox.
114      * @throws CmsException
115      */
116     
117     /**
118      * Gets the processed data for a messagebox.
119      * @param title The title of this messagebox.
120      * @param message1 The first message of this messagebox.
121      * @param message2 The second message of this messagebox.
122      * @param button1 The first button of this messagebox.
123      * @param button2 The second button of this messagebox.
124      * @param link1 The link of button1 of this messagebox.
125      * @param link2 The link of button2 of this messagebox.
126      * @return Processed messagebox.
127      * @throws CmsException
128      */
129     
130     public String JavaDoc getMessagebox(String JavaDoc title, String JavaDoc message1, String JavaDoc message2,
131             String JavaDoc button1, String JavaDoc button2, String JavaDoc link1, String JavaDoc link2) throws CmsException {
132         setData(CmsWorkplaceDefault.C_MESSAGE_TITLE, title);
133         setData(CmsWorkplaceDefault.C_MESSAGE_MESSAGE1, message1);
134         setData(CmsWorkplaceDefault.C_MESSAGE_MESSAGE2, message2);
135         setData(CmsWorkplaceDefault.C_MESSAGE_BUTTON1, button1);
136         setData(CmsWorkplaceDefault.C_MESSAGE_BUTTON2, button2);
137         setData(CmsWorkplaceDefault.C_MESSAGE_LINK1, link1);
138         setData(CmsWorkplaceDefault.C_MESSAGE_LINK2, link2);
139         return getProcessedDataValue(CmsWorkplaceDefault.C_TAG_MESSAGEBOX);
140     }
141     
142     /**
143      * Gets the expected tagname for the XML documents of this content type
144      * @return Expected XML tagname.
145      */
146     
147     public String JavaDoc getXmlDocumentTagName() {
148         return "WP_MESSAGE";
149     }
150 }
151
Free Books   Free Magazines  
Popular Tags