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 * AutoBean interface that represents the configuration for the client-side CodeMirror editor widget.
032 */
033public interface I_CmsCodeMirrorClientConfiguration {
034
035    /**
036     * Gets the height, in pixels.
037     *
038     *  @return the height (or null if no height was set)
039     */
040    public Integer getHeight();
041
042    /**
043     * Gets the CodeMirror I18N phrases, as a JSON string.
044     *
045     * @return a JSON string containing the CodeMirror I18N phrases
046     */
047    public String getPhrasesJSON();
048
049    /**
050     * Gets the start mode.
051     *
052     * @return the start mode
053     */
054    public String getStartMode();
055
056    /**
057     * Sets the height in pixels.
058     *
059     * @param height the height in pixesls
060     */
061    public void setHeight(Integer height);
062
063    /**
064     * Sets the CodeMirror I18N phrases as a JSON string
065     *
066     * @param json a JSON string with the CodeMirror I18N phrases
067     */
068    public void setPhrasesJSON(String json);
069
070    /**
071     * Sets the start mode.
072     *
073     * @param startMode the start mode
074     */
075    public void setStartMode(String startMode);
076
077}