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_VIEW_ONLINE = "viewonline";
104
105    /** Attribute for container id. */
106    public static final String ATTR_CONTAINER_ID = "ATTR_CONTAINER_ID";
107
108    /** Collector data attribute name. */
109    public static final String ATTR_DATA_COLLECTOR = "data-oc-collector";
110
111    /** Container data attribute name. */
112    public static final String ATTR_DATA_CONTAINER = "data-oc-container";
113
114    /** Editable data attribute name. */
115    public static final String ATTR_DATA_EDITABLE = "data-oc-editable";
116
117    /** Element data attribute name. */
118    public static final String ATTR_DATA_ELEMENT = "data-oc-element";
119
120    /** Content field data attribute name. */
121    public static final String ATTR_DATA_FIELD = "data-oc-field";
122
123    /** Entity id data attribute name. */
124    public static final String ATTR_DATA_ID = "data-oc-id";
125
126    /** Key for the element id attribute. */
127    public static final String ATTR_ELEMENT_ID = "ATTR_ELEMENT_ID";
128
129    public static final String ATTR_EXTENSIONS = "ext";
130
131    /** Element data to enable / disable the favorite button. */
132    public static final String ATTR_FAVORITE = "fav";
133
134    /** Key for the page root path attribute. */
135    public static final String ATTR_PAGE_ROOT_PATH = "ATTR_PAGE_ROOT_PATH";
136
137    /** Name of the Javascript callback used to handle property changes triggered from the locale compare view. */
138    public static final String CALLBACK_HANDLE_CHANGED_PROPERTIES = "cmsHandleChangedProperties";
139
140    /** Javascript function name for showing the locale compare view. */
141    public static final String CALLBACK_REFRESH_LOCALE_COMPARISON = "cmsRefreshLocaleComparison";
142
143    /** The CSS class name used for the DOM elements containing collector information. */
144    public static final String CLASS_COLLECTOR_INFO = "oc-collector-info";
145
146    /** CSS class for containers inflated due to an element dragged into them that is of lower height than the empty container HTML. */
147    public static final String CLASS_CONTAINER_INFLATED = "oc-container-inflated";
148
149    /** CSS class for elements in detail containers which are used to transfer their settings to the detail eleemnt. */
150    public static final String CLASS_DETAIL_PREVIEW = "oc-detail-preview";
151
152    /** The CSS class name for data elements which precede the direct editable elements. */
153    public static final String CLASS_EDITABLE = "oc-editable";
154
155    /** The CSS class name for elements which end the direct editable elements. */
156    public static final String CLASS_EDITABLE_END = CLASS_EDITABLE + "-end";
157
158    /** The CSS class name for elements which mark elements to be skipped during direct edit. */
159    public static final String CLASS_EDITABLE_SKIP = CLASS_EDITABLE + "-skip";
160
161    /** Class for dnd placeholders which are too big. */
162    public static final String CLASS_PLACEHOLDER_TOO_BIG = "oc-placeholder-too-big";
163
164    /** Name for configuration  setting to limit collector results while computing publish lists for collectors. */
165    public static final String COLLECTOR_PUBLISH_LIST_LIMIT = "collectorPublishListLimit";
166
167    /** The context type sitemap toolbar. */
168    public static final String CONTEXT_TYPE_APP_TOOLBAR = "appToolbar";
169
170    /** The context type containerpage toolbar. */
171    public static final String CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR = "containerpageToolbar";
172
173    /** The context type file table. */
174    public static final String CONTEXT_TYPE_FILE_TABLE = "fileTable";
175
176    /** The context type sitemap toolbar. */
177    public static final String CONTEXT_TYPE_SITEMAP_TOOLBAR = "sitemapToolbar";
178
179    /** Special 'type' name (that isn't actually a type) used to mark default detail pages in the sitemap configuration. */
180    public static final String DEFAULT_DETAILPAGE_TYPE = "##DEFAULT##";
181
182    public static final String EDITOR_PAGE_ID = "pageId";
183
184    /** 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. */
185    public static final String FORMATTER_RELOAD_MARKER = "<!--FORMATTER_RELOAD_g3jf9o0n-->";
186
187    /** 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). */
188    public static final String FORMATTER_SUBKEY_SEPARATOR = "#";
189
190    /** Sub-path for the page unlock service. */
191    public static final String HANDLER_UNLOCK_PAGE = "/unlockPage";
192
193    /** Sub-path for the session update handler. */
194    public static final String HANDLER_UPDATE_SESSION = "/updateSession";
195
196    /** Element id for locale comparison view. */
197    public static final String ID_LOCALE_COMPARISON = "cmsLocaleComparison";
198
199    /** Id of the element ussed to  display the sitemap header from Vaadin code. */
200    public static final String ID_LOCALE_HEADER_CONTAINER = "locale-header-container";
201
202    /** Name of the Javascript callback used to open the locale comparison view. */
203    public static final String LOCALECOMPARE_EDIT_PROPERTIES = "cmsLocaleCompareEditProperties";
204
205    /** The maximum DND placeholder height. */
206    public static final int MAX_PLACEHOLDER_HEIGHT = 300;
207
208    /** Parameter for the button left position. */
209    public static final String PARAM_BUTTON_LEFT = "__buttonLeft";
210
211    /** Parameter to disable direct edit. */
212    public static final String PARAM_DISABLE_DIRECT_EDIT = "__disableDirectEdit";
213
214    /** Name of the request parameter used to store the redirect target after login. */
215    public static final String PARAM_LOGIN_REDIRECT = "loginRedirect";
216
217    /** Parameter to force a specific template context. */
218    public static final String PARAM_TEMPLATE_CONTEXT = "__templateContext";
219
220    /** Name of property containing focal point for images. */
221    public static final String PROPERTY_IMAGE_FOCALPOINT = "image.focalpoint";
222
223    /** Tab id for the preference dialog. */
224    public static final String TAB_BASIC = "basic";
225
226    /** Tab id for the preference dialog. */
227    public static final String TAB_EXTENDED = "extended";
228
229    /** Tab id for the preference dialog. */
230    public static final String TAB_HIDDEN = "hidden";
231
232    /** Type name for container pages. */
233    public static final String TYPE_CONTAINERPAGE = "containerpage";
234
235    /** The resource icon CSS class prefix. */
236    public static final String TYPE_ICON_CLASS = "cms_type_icon";
237
238    /** The image resource type name. */
239    public static final String TYPE_IMAGE = "image";
240
241    /** Name for the pseudo-type 'modelgroup'. */
242    public static final String TYPE_MODELGROUP = "modelgroup";
243
244    /** Name for the pseudo-type 'modelgroupreuse'. */
245    public static final String TYPE_MODELGROUP_COPY = "modelgroupcopy";
246
247    /** Name for the pseudo-type 'modelgrouppage'. */
248    public static final String TYPE_MODELGROUP_PAGE = "modelgrouppage";
249
250    /** Name for the type 'modelpage'. */
251    public static final String TYPE_MODELPAGE = "modelpage";
252
253    /** Name for the pseudo-type 'navlevel'. */
254    public static final String TYPE_NAVLEVEL = "navlevel";
255
256    /** 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. */
257    public static final String VAR_LOCALE_ROOT = "cmsLocaleCompareRoot";
258
259    /**
260     * Hide constructor.<p>
261     */
262    private CmsGwtConstants() {
263
264        // nop
265
266    }
267
268    /**
269     * Maximum DND placeholder height, as a string for stylesheets.
270     *
271     * @return the maximum DND placeholder height as a string
272     */
273    public static String getPlaceholderMaxHeight() {
274
275        return MAX_PLACEHOLDER_HEIGHT + "px";
276    }
277}