001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/editors/directedit/CmsDirectEditJQueryProvider.java,v $
003: * Date : $Date: 2008-02-27 12:05:54 $
004: * Version: $Revision: 1.2 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.workplace.editors.directedit;
033:
034: import org.opencms.file.CmsObject;
035: import org.opencms.i18n.CmsEncoder;
036: import org.opencms.util.CmsStringUtil;
037: import org.opencms.workplace.editors.Messages;
038:
039: /**
040: * Provider for the OpenCms graphical "direct edit" buttons. <p>
041: *
042: * Uses the JQuery library to create the buttons and place it to the correct position.<p>
043: *
044: * This provider DOES NOT support {@link CmsDirectEditMode#MANUAL} mode.<p>
045: *
046: * @author Anja Röttgers
047: *
048: * @version $Revision: 1.2 $
049: *
050: * @since 7.0.3
051: */
052: public class CmsDirectEditJQueryProvider extends
053: CmsDirectEditDefaultProvider {
054:
055: /** Default direct edit include file URI for the jQuery direct edit provider. */
056: protected static final String INCLUDE_FILE_JQUERY = "/system/workplace/editors/jquery_direct_edit_include.txt";
057:
058: /** Contains the close link.**/
059: private String m_closeLink;
060:
061: /**
062: *
063: * @see org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider#getDirectEditIncludes(org.opencms.workplace.editors.directedit.CmsDirectEditParams)
064: */
065: public String getDirectEditIncludes(CmsDirectEditParams params) {
066:
067: m_closeLink = getLink(params.getLinkForClose());
068: return super .getDirectEditIncludes(params);
069: }
070:
071: /**
072: * @see org.opencms.workplace.editors.directedit.I_CmsDirectEditProvider#init(org.opencms.file.CmsObject, org.opencms.workplace.editors.directedit.CmsDirectEditMode, java.lang.String)
073: */
074: public void init(CmsObject cms, CmsDirectEditMode mode,
075: String fileName) {
076:
077: if (CmsStringUtil.isEmpty(fileName)) {
078: fileName = INCLUDE_FILE_JQUERY;
079: }
080: super .init(cms, mode, fileName);
081: }
082:
083: /**
084: * @see org.opencms.workplace.editors.directedit.I_CmsDirectEditProvider#newInstance()
085: */
086: public I_CmsDirectEditProvider newInstance() {
087:
088: CmsDirectEditJQueryProvider result = new CmsDirectEditJQueryProvider();
089: result.m_configurationParameters = m_configurationParameters;
090: return result;
091: }
092:
093: /**
094: *
095: * @see org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider#startDirectEditDisabled(org.opencms.workplace.editors.directedit.CmsDirectEditParams, org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo)
096: */
097: public String startDirectEditDisabled(CmsDirectEditParams params,
098: CmsDirectEditResourceInfo resourceInfo) {
099:
100: return appendDirectEditData(params, false);
101: }
102:
103: /**
104: *
105: * @see org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider#startDirectEditEnabled(org.opencms.workplace.editors.directedit.CmsDirectEditParams, org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo)
106: */
107: public String startDirectEditEnabled(CmsDirectEditParams params,
108: CmsDirectEditResourceInfo resourceInfo) {
109:
110: return appendDirectEditData(params, false);
111: }
112:
113: /**
114: * Appends the data for the direct edit buttons, which are dynamically created with jQuery.<p>
115: *
116: * Generates the following code:<p>
117: * <pre>
118: * <script type="text/javascript" >
119: * ocms_de_data['key']= {
120: * id: key,
121: * resource: res,
122: * ...
123: * };
124: * </script >
125: * </pre>
126: *
127: * @param params the direct edit parameters
128: * @param disabled if the buttons are disabled or not
129: *
130: * @return the data needed for the direct edit buttons
131: */
132: private String appendDirectEditData(CmsDirectEditParams params,
133: boolean disabled) {
134:
135: StringBuffer result = new StringBuffer(512);
136: String editId = getNextDirectEditId();
137:
138: result.append("\n<script type=\"text/javascript\">\n");
139:
140: result.append("ocms_de_data['").append(editId)
141: .append("']= {\n");
142: result.append("\t").append("id: '").append(editId).append(
143: "',\n");
144: result.append("\t").append("deDisabled: ").append(disabled)
145: .append(",\n");
146: result.append("\t").append("hasEdit: ").append(
147: params.getButtonSelection().isShowEdit()).append(",\n");
148: result.append("\t").append("hasDelete: ").append(
149: params.getButtonSelection().isShowDelete()).append(
150: ",\n");
151: result.append("\t").append("hasNew: ").append(
152: params.getButtonSelection().isShowNew()).append(",\n");
153: result.append("\t").append("resource: '").append(
154: params.getResourceName()).append("',\n");
155: result.append("\t").append("editLink: '").append(
156: getLink(params.getLinkForEdit())).append("',\n");
157: result.append("\t").append("language: '").append(
158: m_cms.getRequestContext().getLocale().toString());
159: result.append("',\n");
160: result.append("\t").append("element: '").append(
161: params.getElement()).append("',\n");
162: result.append("\t").append("backlink: '").append(
163: m_cms.getRequestContext().getUri()).append("',\n");
164: result.append("\t").append("newlink: '").append(
165: CmsEncoder.encode(params.getLinkForNew())).append(
166: "',\n");
167: result.append("\t").append("closelink: '").append(m_closeLink)
168: .append("',\n");
169: result.append("\t").append("deletelink: '").append(
170: getLink(params.getLinkForDelete())).append("',\n");
171: if (!disabled) {
172: result.append("\t").append("button_edit: '");
173: result
174: .append(
175: m_messages
176: .key(Messages.GUI_EDITOR_FRONTEND_BUTTON_EDIT_0))
177: .append("',\n");
178: result.append("\t").append("button_delete: '");
179: result.append(m_messages.key(Messages.GUI_BUTTON_DELETE_0))
180: .append("',\n");
181: result.append("\t").append("button_new: '");
182: result.append(m_messages.key(Messages.GUI_BUTTON_NEW_0))
183: .append("',\n");
184: } else {
185: result.append("\t").append("button_edit: '");
186: result
187: .append(
188: m_messages
189: .key(Messages.GUI_EDITOR_FRONTEND_BUTTON_LOCKED_0))
190: .append("',\n");
191: result.append("\t").append("button_delete: '");
192: result
193: .append(
194: m_messages
195: .key(Messages.GUI_EDITOR_FRONTEND_BUTTON_LOCKED_0))
196: .append("',\n");
197: result.append("\t").append("button_new: '");
198: result
199: .append(
200: m_messages
201: .key(Messages.GUI_EDITOR_FRONTEND_BUTTON_LOCKED_0))
202: .append("',\n");
203: }
204: result.append("\t").append("editortitle: '").append(
205: m_messages.key(Messages.GUI_EDITOR_TITLE_NEW_0));
206:
207: result.append("'\n");
208: result.append("};\n");
209: result.append("</script>\n");
210:
211: result.append("<div id=\"").append(editId).append(
212: "\" class=\"ocms_de_norm\">");
213: return result.toString();
214: }
215: }
|