1 /**
2 * This file Copyright (c) 2012-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.imageprovider;
35
36 /**
37 * The {@link ImageProvider} provides portrait or thumbnail images for arbitrary content.
38 * It is primarily used to streamline preview images across the Magnolia UI.
39 *
40 * @deprecated since 6.0. Use new framework and {@link info.magnolia.ui.contentapp.browser.preview.PreviewProvider}.
41 */
42 @Deprecated
43 public interface ImageProvider {
44
45 String PORTRAIT_GENERATOR = "portrait";
46 String THUMBNAIL_GENERATOR = "thumbnail";
47
48 /**
49 * Gets an image preview for the content represented by the given itemId.
50 * This preview may be an image or an icon related to the content type.
51 *
52 * @param itemId the id of an {@link com.vaadin.v7.data.Item Item}
53 * @param generator the name of a registered {@link info.magnolia.imaging.ImageGenerator ImageGenerator} of the imaging module
54 * @return a Vaadin {@link com.vaadin.server.Resource Resource} or a String corresponding to an icon class name
55 */
56 Object getThumbnailResource(Object itemId, String generator);
57
58 /**
59 * Gets an icon class name for the given media type.
60 *
61 * @param mimeType a MIME type
62 * @return a String corresponding to an icon class name
63 */
64 String resolveIconClassName(String mimeType);
65
66 /**
67 * @return a link to the generated "portrait" preview for the content represented by the given itemId.
68 */
69 String getPortraitPath(Object itemId);
70
71 /**
72 * @return a link to the generated "thumbnail" preview for the content represented by the given itemId.
73 */
74 String getThumbnailPath(Object itemId);
75 }