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.ui.editors; 029 030import org.opencms.file.CmsObject; 031import org.opencms.file.CmsResource; 032import org.opencms.file.types.I_CmsResourceType; 033import org.opencms.ui.apps.I_CmsAppUIContext; 034 035import java.util.Map; 036 037/** 038 * Interface for resource editors.<p> 039 */ 040public interface I_CmsEditor { 041 042 /** 043 * Gets the priority.<p> 044 * 045 * If multiple editors for the same resource type are available, the one with the highest priority will be picked.<p> 046 * 047 * @return the priority 048 */ 049 int getPriority(); 050 051 /** 052 * Within this method the editor UI should be initialized.<p> 053 * Use the context to add the app's components to the UI.<p> 054 * 055 * @param context the UI context 056 * @param resource the resource to edit 057 * @param backLink the link to return to when closing the editor 058 * @param params optional parameters 059 */ 060 void initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String, String> params); 061 062 /** 063 * Checks whether the editor is available for the given resource.<p> 064 * 065 * @param cms the CMS context 066 * @param resource the resource to edit 067 * @param plainText if plain text editing is required 068 * 069 * @return <code>true</code> if the editor is available for the given resource 070 */ 071 boolean matchesResource(CmsObject cms, CmsResource resource, boolean plainText); 072 073 /** 074 * Checks whether the editor is available for the given resource type.<p> 075 * 076 * @param type the resource type to edit 077 * @param plainText if plain text editing is required 078 * 079 * @return <code>true</code> if the editor is available for the given resource 080 */ 081 boolean matchesType(I_CmsResourceType type, boolean plainText); 082 083 /** 084 * Returns a new editor instance.<p> 085 * 086 * @return the editor instance 087 */ 088 I_CmsEditor newInstance(); 089}