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 /** Name for the attribute used to store list-add metadata. */ 130 public static final String ATTR_DATA_LISTADD = "data-oc-listadd"; 131 132 /** Marker attribute for dead links. */ 133 public static final String ATTR_DEAD_LINK_MARKER = "data-oc-broken-link"; 134 135 /** Key for the element id attribute. */ 136 public static final String ATTR_ELEMENT_ID = "ATTR_ELEMENT_ID"; 137 138 public static final String ATTR_EXTENSIONS = "ext"; 139 140 /** Element data to enable / disable the favorite button. */ 141 public static final String ATTR_FAVORITE = "fav"; 142 143 /** Key for the page root path attribute. */ 144 public static final String ATTR_PAGE_ROOT_PATH = "ATTR_PAGE_ROOT_PATH"; 145 146 /** Name of the Javascript callback used to handle property changes triggered from the locale compare view. */ 147 public static final String CALLBACK_HANDLE_CHANGED_PROPERTIES = "cmsHandleChangedProperties"; 148 149 /** Javascript function name for showing the locale compare view. */ 150 public static final String CALLBACK_REFRESH_LOCALE_COMPARISON = "cmsRefreshLocaleComparison"; 151 152 /** The CSS class name used for the DOM elements containing collector information. */ 153 public static final String CLASS_COLLECTOR_INFO = "oc-collector-info"; 154 155 /** CSS class for containers inflated due to an element dragged into them that is of lower height than the empty container HTML. */ 156 public static final String CLASS_CONTAINER_INFLATED = "oc-container-inflated"; 157 158 /** CSS class for elements in detail containers which are used to transfer their settings to the detail eleemnt. */ 159 public static final String CLASS_DETAIL_PREVIEW = "oc-detail-preview"; 160 161 /** The CSS class name for data elements which precede the direct editable elements. */ 162 public static final String CLASS_EDITABLE = "oc-editable"; 163 164 /** The CSS class name for elements which end the direct editable elements. */ 165 public static final String CLASS_EDITABLE_END = CLASS_EDITABLE + "-end"; 166 167 /** The CSS class name for elements which mark elements to be skipped during direct edit. */ 168 public static final String CLASS_EDITABLE_SKIP = CLASS_EDITABLE + "-skip"; 169 170 /** Class for dnd placeholders which are too big. */ 171 public static final String CLASS_PLACEHOLDER_TOO_BIG = "oc-placeholder-too-big"; 172 173 /** Name for configuration setting to limit collector results while computing publish lists for collectors. */ 174 public static final String COLLECTOR_PUBLISH_LIST_LIMIT = "collectorPublishListLimit"; 175 176 /** The context type sitemap toolbar. */ 177 public static final String CONTEXT_TYPE_APP_TOOLBAR = "appToolbar"; 178 179 /** The context type containerpage toolbar. */ 180 public static final String CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR = "containerpageToolbar"; 181 182 /** The context type file table. */ 183 public static final String CONTEXT_TYPE_FILE_TABLE = "fileTable"; 184 185 /** The context type sitemap toolbar. */ 186 public static final String CONTEXT_TYPE_SITEMAP_TOOLBAR = "sitemapToolbar"; 187 188 /** Special 'type' name (that isn't actually a type) used to mark default detail pages in the sitemap configuration. */ 189 public static final String DEFAULT_DETAILPAGE_TYPE = "##DEFAULT##"; 190 191 public static final String EDITOR_PAGE_ID = "pageId"; 192 193 /** 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. */ 194 public static final String FORMATTER_RELOAD_MARKER = "<!--FORMATTER_RELOAD_g3jf9o0n-->"; 195 196 /** 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). */ 197 public static final String FORMATTER_SUBKEY_SEPARATOR = "#"; 198 199 /** Sub-path for the page unlock service. */ 200 public static final String HANDLER_UNLOCK_PAGE = "/unlockPage"; 201 202 /** Sub-path for the session update handler. */ 203 public static final String HANDLER_UPDATE_SESSION = "/updateSession"; 204 205 /** The settings widget name for hidden entries. */ 206 public static final String HIDDEN_SETTINGS_WIDGET_NAME = "hidden"; 207 208 /** Element id for locale comparison view. */ 209 public static final String ID_LOCALE_COMPARISON = "cmsLocaleComparison"; 210 211 /** Id of the element ussed to display the sitemap header from Vaadin code. */ 212 public static final String ID_LOCALE_HEADER_CONTAINER = "locale-header-container"; 213 214 /** Json field name for typograf locale passed to input widget. */ 215 public static final String JSON_INPUT_LOCALE = "locale"; 216 217 /** Json field name for enabling typograf, passed to input widget. */ 218 public static final String JSON_INPUT_TYPOGRAF = "typograf"; 219 220 /** Field name for the internal textarea configuration. */ 221 public static final String JSON_TEXTAREA_CONFIG = "config"; 222 223 /** Field name for the internal textarea configuration. */ 224 public static final String JSON_TEXTAREA_LOCALE = "locale"; 225 226 /** 227 * Session storage key for memorizing the last opened container page. 228 */ 229 public static final String LAST_CONTAINER_PAGE_ID = "lastContainerPageId"; 230 231 /** Name of the Javascript callback used to open the locale comparison view. */ 232 public static final String LOCALECOMPARE_EDIT_PROPERTIES = "cmsLocaleCompareEditProperties"; 233 234 /** The maximum DND placeholder height. */ 235 public static final int MAX_PLACEHOLDER_HEIGHT = 300; 236 237 /** Name of the meta tag used to set the editor stylesheet. */ 238 public static final String META_EDITOR_STYLESHEET = "cms-editor-stylesheet"; 239 240 /** Parameter to pass detail id to page editor context menu actions. */ 241 public static final String PARAM_ADE_DETAIL_ID = "adeDetailId"; 242 243 /** Parameter for the button left position. */ 244 public static final String PARAM_BUTTON_LEFT = "__buttonLeft"; 245 246 /** Parameter to disable direct edit. */ 247 public static final String PARAM_DISABLE_DIRECT_EDIT = "__disableDirectEdit"; 248 249 /** Name of the request parameter used to store the redirect target after login. */ 250 public static final String PARAM_LOGIN_REDIRECT = "loginRedirect"; 251 252 /** Parameter to force a specific template context. */ 253 public static final String PARAM_TEMPLATE_CONTEXT = "__templateContext"; 254 255 /** Marker for the 'prefill' context menu action. */ 256 public static final String PREFILL_MENU_PLACEHOLDER = "PREFILL_MENU_PLACEHOLDER"; 257 258 /** Name of property containing focal point for images. */ 259 public static final String PROPERTY_IMAGE_FOCALPOINT = "image.focalpoint"; 260 261 /** Tab id for the preference dialog. */ 262 public static final String TAB_BASIC = "basic"; 263 264 /** Tab id for the preference dialog. */ 265 public static final String TAB_EXTENDED = "extended"; 266 267 /** Tab id for the preference dialog. */ 268 public static final String TAB_HIDDEN = "hidden"; 269 270 /** Tag name for the edit button bars injected into the page HTML in the container page editor. */ 271 public static final String TAG_OC_EDITPOINT = "oc-editpoint"; 272 273 /** Tag name for the list-add metadata injected into the page. */ 274 public static final String TAG_OC_LISTADD = "oc-listadd"; 275 276 /** Action placeholder for the template contexts menu option. */ 277 public static final String TEMPLATECONTEXT_MENU_PLACEHOLDER = "templatecontexts"; 278 279 /** Type name for container pages. */ 280 public static final String TYPE_CONTAINERPAGE = "containerpage"; 281 282 /** The resource icon CSS class prefix. */ 283 public static final String TYPE_ICON_CLASS = "cms_type_icon"; 284 285 /** The image resource type name. */ 286 public static final String TYPE_IMAGE = "image"; 287 288 /** Name for the pseudo-type 'modelgroup'. */ 289 public static final String TYPE_MODELGROUP = "modelgroup"; 290 291 /** Name for the pseudo-type 'modelgroupreuse'. */ 292 public static final String TYPE_MODELGROUP_COPY = "modelgroupcopy"; 293 294 /** Name for the pseudo-type 'modelgrouppage'. */ 295 public static final String TYPE_MODELGROUP_PAGE = "modelgrouppage"; 296 297 /** Name for the type 'modelpage'. */ 298 public static final String TYPE_MODELPAGE = "modelpage"; 299 300 /** Name for the pseudo-type 'navlevel'. */ 301 public static final String TYPE_NAVLEVEL = "navlevel"; 302 303 /** Part of the URL used to unlock files. */ 304 public static final String UNLOCK_FILE_PREFIX = "/unlockFile/"; 305 306 /** 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. */ 307 public static final String VAR_LOCALE_ROOT = "cmsLocaleCompareRoot"; 308 309 /** 310 * Hide constructor.<p> 311 */ 312 private CmsGwtConstants() { 313 314 // nop 315 316 } 317 318 /** 319 * Maximum DND placeholder height, as a string for stylesheets. 320 * 321 * @return the maximum DND placeholder height as a string 322 */ 323 public static String getPlaceholderMaxHeight() { 324 325 return MAX_PLACEHOLDER_HEIGHT + "px"; 326 } 327}