001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.shared;
029
030/**
031 * Common constants needed for client side code.<p>
032 */
033public final class CmsGwtConstants {
034
035    /** Parameters for favorite dialog. */
036    public static final class Favorites {
037
038        /** Request parameter. */
039        public static final String PARAM_DETAIL = "detail";
040
041        /** Request parameter. */
042        public static final String PARAM_PAGE = "page";
043
044        /** Request parameter. */
045        public static final String PARAM_PROJECT = "project";
046
047        /** Request parameter. */
048        public static final String PARAM_SITE = "site";
049    }
050
051    /**
052    * Quick launcher constants.<p>
053    */
054    public static final class QuickLaunch {
055
056        /** Context string. */
057        public static final String CONTEXT_PAGE = "page";
058
059        /** Context string. */
060        public static final String CONTEXT_SITEMAP = "sitemap";
061
062        /** Quick launch id. */
063        public static final String Q_ACCOUNTMANAGER = "accountmanager";
064
065        /** Quick launch id. */
066        public static final String Q_EXPLORER = "explorer";
067
068        /** Quick launch id. */
069        public static final String Q_LAUNCHPAD = "launchpad";
070
071        /** Quick launch id. */
072        public static final String Q_PAGEEDITOR = "pageeditor";
073
074        /** Quick launch id. */
075        public static final String Q_SITEMAP = "sitemap";
076
077        /** Quick launch id. */
078        public static final String Q_WORKPLACETOOLS = "workplacetools";
079
080    }
081
082    public static final class RpcContext {
083
084        public static final String PAGE_ID = "pageId";
085    }
086
087    /** Context menu action id. */
088    public static final String ACTION_EDITSMALLELEMENTS = "editsmallelements";
089
090    /** Context menu action parameter dialog id. */
091    public static final String ACTION_PARAM_DIALOG_ID = "dialogId";
092
093    /** Context menu action id. */
094    public static final String ACTION_SELECTELEMENTVIEW = "selectelementview";
095
096    /** Context menu action id. */
097    public static final String ACTION_SHOWLOCALE = "showlocale";
098
099    /** Context menu action id. */
100    public static final String ACTION_TEMPLATECONTEXTS = "templatecontexts";
101
102    /** Context menu action id. */
103    public static final String ACTION_TEMPLATECONTEXTS_ADVANCED = "templatecontexts_advanced";
104
105    /** Context menu action id. */
106    public static final String ACTION_VIEW_ONLINE = "viewonline";
107
108    /** Attribute for container id. */
109    public static final String ATTR_CONTAINER_ID = "ATTR_CONTAINER_ID";
110
111    /** Collector data attribute name. */
112    public static final String ATTR_DATA_COLLECTOR = "data-oc-collector";
113
114    /** Container data attribute name. */
115    public static final String ATTR_DATA_CONTAINER = "data-oc-container";
116
117    /** Editable data attribute name. */
118    public static final String ATTR_DATA_EDITABLE = "data-oc-editable";
119
120    /** Element data attribute name. */
121    public static final String ATTR_DATA_ELEMENT = "data-oc-element";
122
123    /** Content field data attribute name. */
124    public static final String ATTR_DATA_FIELD = "data-oc-field";
125
126    /** Entity id data attribute name. */
127    public static final String ATTR_DATA_ID = "data-oc-id";
128
129    public static final String ATTR_DATA_LISTADD = "data-oc-listadd";
130
131    /** Key for the element id attribute. */
132    public static final String ATTR_ELEMENT_ID = "ATTR_ELEMENT_ID";
133
134    public static final String ATTR_EXTENSIONS = "ext";
135
136    /** Element data to enable / disable the favorite button. */
137    public static final String ATTR_FAVORITE = "fav";
138
139    /** Key for the page root path attribute. */
140    public static final String ATTR_PAGE_ROOT_PATH = "ATTR_PAGE_ROOT_PATH";
141
142    /** Name of the Javascript callback used to handle property changes triggered from the locale compare view. */
143    public static final String CALLBACK_HANDLE_CHANGED_PROPERTIES = "cmsHandleChangedProperties";
144
145    /** Javascript function name for showing the locale compare view. */
146    public static final String CALLBACK_REFRESH_LOCALE_COMPARISON = "cmsRefreshLocaleComparison";
147
148    /** The CSS class name used for the DOM elements containing collector information. */
149    public static final String CLASS_COLLECTOR_INFO = "oc-collector-info";
150
151    /** CSS class for containers inflated due to an element dragged into them that is of lower height than the empty container HTML. */
152    public static final String CLASS_CONTAINER_INFLATED = "oc-container-inflated";
153
154    /** CSS class for elements in detail containers which are used to transfer their settings to the detail eleemnt. */
155    public static final String CLASS_DETAIL_PREVIEW = "oc-detail-preview";
156
157    /** The CSS class name for data elements which precede the direct editable elements. */
158    public static final String CLASS_EDITABLE = "oc-editable";
159
160    /** The CSS class name for elements which end the direct editable elements. */
161    public static final String CLASS_EDITABLE_END = CLASS_EDITABLE + "-end";
162
163    /** The CSS class name for elements which mark elements to be skipped during direct edit. */
164    public static final String CLASS_EDITABLE_SKIP = CLASS_EDITABLE + "-skip";
165
166    /** Class for dnd placeholders which are too big. */
167    public static final String CLASS_PLACEHOLDER_TOO_BIG = "oc-placeholder-too-big";
168
169    /** Name for configuration  setting to limit collector results while computing publish lists for collectors. */
170    public static final String COLLECTOR_PUBLISH_LIST_LIMIT = "collectorPublishListLimit";
171
172    /** The context type sitemap toolbar. */
173    public static final String CONTEXT_TYPE_APP_TOOLBAR = "appToolbar";
174
175    /** The context type containerpage toolbar. */
176    public static final String CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR = "containerpageToolbar";
177
178    /** The context type file table. */
179    public static final String CONTEXT_TYPE_FILE_TABLE = "fileTable";
180
181    /** The context type sitemap toolbar. */
182    public static final String CONTEXT_TYPE_SITEMAP_TOOLBAR = "sitemapToolbar";
183
184    /** Special 'type' name (that isn't actually a type) used to mark default detail pages in the sitemap configuration. */
185    public static final String DEFAULT_DETAILPAGE_TYPE = "##DEFAULT##";
186
187    public static final String EDITOR_PAGE_ID = "pageId";
188
189    /** A HTML comment that will cause the container page editor to reload the page if it is contained in HTML which is reloaded after the element or its settings have been edited. */
190    public static final String FORMATTER_RELOAD_MARKER = "<!--FORMATTER_RELOAD_g3jf9o0n-->";
191
192    /** Separator for separating the main part of a formatter key from the sub-key (the part in front of the separator will be used as a key if there is no formatter for the full key). */
193    public static final String FORMATTER_SUBKEY_SEPARATOR = "#";
194
195    /** Sub-path for the page unlock service. */
196    public static final String HANDLER_UNLOCK_PAGE = "/unlockPage";
197
198    /** Sub-path for the session update handler. */
199    public static final String HANDLER_UPDATE_SESSION = "/updateSession";
200
201    /** Element id for locale comparison view. */
202    public static final String ID_LOCALE_COMPARISON = "cmsLocaleComparison";
203
204    /** Id of the element ussed to  display the sitemap header from Vaadin code. */
205    public static final String ID_LOCALE_HEADER_CONTAINER = "locale-header-container";
206
207    /**
208     * Session storage key for memorizing the last opened container page.
209     */
210    public static final String LAST_CONTAINER_PAGE_ID = "lastContainerPageId";
211
212    /** Name of the Javascript callback used to open the locale comparison view. */
213    public static final String LOCALECOMPARE_EDIT_PROPERTIES = "cmsLocaleCompareEditProperties";
214
215    /** The maximum DND placeholder height. */
216    public static final int MAX_PLACEHOLDER_HEIGHT = 300;
217
218    /** Name of the meta tag used to set the editor stylesheet. */
219    public static final String META_EDITOR_STYLESHEET = "cms-editor-stylesheet";
220
221    /** Parameter for the button left position. */
222    public static final String PARAM_BUTTON_LEFT = "__buttonLeft";
223
224    /** Parameter to disable direct edit. */
225    public static final String PARAM_DISABLE_DIRECT_EDIT = "__disableDirectEdit";
226
227    /** Name of the request parameter used to store the redirect target after login. */
228    public static final String PARAM_LOGIN_REDIRECT = "loginRedirect";
229
230    /** Parameter to force a specific template context. */
231    public static final String PARAM_TEMPLATE_CONTEXT = "__templateContext";
232
233    /** Marker for the 'prefill' context menu action. */
234    public static final String PREFILL_MENU_PLACEHOLDER = "PREFILL_MENU_PLACEHOLDER";
235
236    /** Name of property containing focal point for images. */
237    public static final String PROPERTY_IMAGE_FOCALPOINT = "image.focalpoint";
238
239    /** Tab id for the preference dialog. */
240    public static final String TAB_BASIC = "basic";
241
242    /** Tab id for the preference dialog. */
243    public static final String TAB_EXTENDED = "extended";
244
245    /** Tab id for the preference dialog. */
246    public static final String TAB_HIDDEN = "hidden";
247
248    /** Action placeholder for the template contexts menu option. */
249    public static final String TEMPLATECONTEXT_MENU_PLACEHOLDER = "templatecontexts";
250
251    /** Type name for container pages. */
252    public static final String TYPE_CONTAINERPAGE = "containerpage";
253
254    /** The resource icon CSS class prefix. */
255    public static final String TYPE_ICON_CLASS = "cms_type_icon";
256
257    /** The image resource type name. */
258    public static final String TYPE_IMAGE = "image";
259
260    /** Name for the pseudo-type 'modelgroup'. */
261    public static final String TYPE_MODELGROUP = "modelgroup";
262
263    /** Name for the pseudo-type 'modelgroupreuse'. */
264    public static final String TYPE_MODELGROUP_COPY = "modelgroupcopy";
265
266    /** Name for the pseudo-type 'modelgrouppage'. */
267    public static final String TYPE_MODELGROUP_PAGE = "modelgrouppage";
268
269    /** Name for the type 'modelpage'. */
270    public static final String TYPE_MODELPAGE = "modelpage";
271
272    /** Name for the pseudo-type 'navlevel'. */
273    public static final String TYPE_NAVLEVEL = "navlevel";
274
275    /** Part of the URL used to unlock files. */
276    public static final String UNLOCK_FILE_PREFIX = "/unlockFile/";
277
278    /** Name of Javascript variable used to hold the structure id of the currently selected locale's root folder in the sitemap editor's locale comparison mode. */
279    public static final String VAR_LOCALE_ROOT = "cmsLocaleCompareRoot";
280
281    /**
282     * Hide constructor.<p>
283     */
284    private CmsGwtConstants() {
285
286        // nop
287
288    }
289
290    /**
291     * Maximum DND placeholder height, as a string for stylesheets.
292     *
293     * @return the maximum DND placeholder height as a string
294     */
295    public static String getPlaceholderMaxHeight() {
296
297        return MAX_PLACEHOLDER_HEIGHT + "px";
298    }
299}