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.client.ui.input.upload;
029
030import com.google.gwt.core.client.JsArray;
031import com.google.gwt.dom.client.InputElement;
032
033/**
034 * The interface for various implementations of a file input field.<p>
035 *
036 * @since 8.0.0
037 */
038public interface I_CmsFileInputService {
039
040    /**
041     * Returns a JsArray of CmsFile objects.<p>
042     *
043     * @param inputElement the input element
044     *
045     * @return a JsArray of CmsFile objects
046     */
047    JsArray<CmsFileInfo> getFiles(InputElement inputElement);
048
049    /**
050     * The default implementation of the file input field does not support multiple file selection.<p>
051     *
052     * @param inputElement the input element
053     *
054     * @return <code>false</code> by default
055     */
056    boolean isAllowMultipleFiles(InputElement inputElement);
057
058    /**
059     * A dummy method, only used for sub classes.<p>
060     *
061     * @param inputElement the input element
062     *
063     * @param allow the flag that indicates if multiple file selection is supported
064     */
065    void setAllowMultipleFiles(InputElement inputElement, boolean allow);
066
067    /**
068     * The default implementation of the file input field does not support multiple file selection.<p>
069     *
070     * @return <code>false</code> by default
071     */
072    boolean supportsFileAPI();
073
074}