001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (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
030import com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * An interface that holds some constants for the upload dialog.<p>
034 *
035 * @since 8.0.0
036 */
037public interface I_CmsUploadConstants extends IsSerializable {
038
039    /** The request attribute name for the close link. */
040    String ATTR_CLOSE_LINK = "closeLink";
041
042    /** The request attribute name for the current folder. */
043    String ATTR_CURRENT_FOLDER = "currentFolder";
044
045    /** The request attribute name for the dialog mode. */
046    String ATTR_DIALOG_MODE = "dialogMode";
047
048    /** The explorer URI for the back link. */
049    String EXPLORER_URI = "/system/workplace/views/explorer/explorer_files.jsp?mode=explorerview";
050
051    /** If this field is 'true', don'T perform file name translation (used for replace dialog). */
052    String KEEP_FILE_NAMES = "keepFileNames";
053
054    /** Key for the JSON object. */
055    String KEY_MESSAGE = "message";
056
057    /** Key for the JSON object. */
058    String KEY_REQUEST_SIZE = "requestsize";
059
060    /** Key for the JSON object. */
061    String KEY_STACKTRACE = "stacktrace";
062
063    /** Key for the JSON object. */
064    String KEY_SUCCESS = "success";
065
066    /** Key for the upload hook. */
067    String KEY_UPLOAD_HOOK = "uploadHook";
068
069    /** Key for the uploaded file names. */
070    String KEY_UPLOADED_FILE_NAMES = "uploadedFileNames";
071
072    /** Key for the uploaded file ids. */
073    String KEY_UPLOADED_FILES = "uploadedFiles";
074
075    /** The resources parameter name. */
076    String PARAM_RESOURCES = "resources";
077
078    /** The post-create handler parameter. */
079    String POST_CREATE_HANDLER = "post_create_handler";
080
081    /** Upload action JSP URI. */
082    String UPLOAD_ACTION_JSP_URI = "/system/workplace/commons/uploadAction.jsp";
083
084    /** The encoded file name field name suffix. */
085    String UPLOAD_FILENAME_ENCODED_SUFFIX = "_filename_encoded";
086
087    /** Name of the form field which stores whether the target folder is given as a root path. */
088    String UPLOAD_IS_ROOT_PATH_FIELD_NAME = "isRootPath";
089
090    /** Upload JSP URI. */
091    String UPLOAD_JSP_URI = "/system/workplace/commons/upload.jsp";
092
093    /** The name of the form field that stores the target folder for the upload. */
094    String UPLOAD_TARGET_FOLDER_FIELD_NAME = "upload_target_folder";
095
096    /** The name of the form field that stores the file names to unzip. */
097    String UPLOAD_UNZIP_FILES_FIELD_NAME = "upload_unzip_files";
098
099    /** The javascript variable name for the upload target folder. */
100    String VAR_TARGET_FOLDER = "targetFolder";
101}