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
030/**
031 * Constants used by the data view widget code (client/server side).<p>
032 */
033public final class CmsDataViewConstants {
034
035    /** Key used for the callback. */
036    public static final String PARAM_CALLBACK = "cb";
037
038    /** Key used for the callback argument. */
039    public static final String PARAM_CALLBACK_ARG = "cbp";
040
041    /** JSON Key used for the view class. */
042    public static final String CONFIG_VIEW_CLASS = "class";
043
044    /** JSON key used for the view configuration. */
045    public static final String CONFIG_VIEW_ARG = "config";
046
047    /** JSON key for enabling / disabling multiselect. */
048    public static final String CONFIG_MULTI_SELECT = "multiselect";
049
050    /** Name of the request parameter used to send the widget configuration from the client to the embedded Vaadin dialog. */
051    public static final String PARAM_CONFIG = "config";
052
053    /** The renderer id. */
054    public static final String RENDERER_ID = "dataview";
055
056    /** JSON key for the result. */
057    public static final String KEY_RESULT = "result";
058
059    /** JSON key for a result's id. */
060    public static final String FIELD_ID = "id";
061
062    /** JSON key for a results's title. */
063    public static final String FIELD_TITLE = "title";
064
065    /** JSON key for a result's description. */
066    public static final String FIELD_DESCRIPTION = "description";
067
068    /** JSON key for a result's additional data. */
069    public static final String FIELD_DATA = "data";
070
071    /** JSON key for the dialog name. */
072    public static final String DATAVIEW_DIALOG = "org.opencms.ui.dialogs.embedded.CmsDataViewAction";
073
074    /** JSON key for the preview option. */
075    public static final String CONFIG_PREVIEW = "preview";
076
077    /** The accessor. */
078    public static final String ACCESSOR = "acc";
079
080    /** JSON key for the icon option. */
081    public static final String CONFIG_ICON = "icon";
082
083    /** Title content field name. */
084    public static final String VALUE_TITLE = "Title";
085
086    /** Description content field name. */
087    public static final String VALUE_DESCRIPTION = "Description";
088
089    /** Id content field name. */
090    public static final String VALUE_ID = "Id";
091
092    /** Data content field name. */
093    public static final String VALUE_DATA = "Data";
094
095    /** Default constructor. */
096    private CmsDataViewConstants() {
097        // do nothing
098    }
099
100}