01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/editors/I_CmsEditorCssHandler.java,v $
03: * Date : $Date: 2008-02-27 12:05:23 $
04: * Version: $Revision: 1.4 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.workplace.editors;
33:
34: import org.opencms.file.CmsObject;
35:
36: /**
37: * Provides methods to determine the CSS style sheet URI for the editors based on the edited resource path.<p>
38: *
39: * The method {@link #matches(CmsObject, String)} can be used to check
40: * if the handler matches the currently edited resource.<p>
41: *
42: * @author Andreas Zahner
43: *
44: * @version $Revision: 1.4 $
45: *
46: * @since 6.9.2
47: */
48: public interface I_CmsEditorCssHandler {
49:
50: /**
51: * Returns the absolute VFS path of the CSS style sheet to use.<p>
52: *
53: * @param cms the current OpenCms user context
54: * @param editedResourcePath the absolute VFS path of the currently edited resource
55: * @return the absolute VFS path of the CSS style sheet to use
56: */
57: String getUriStyleSheet(CmsObject cms, String editedResourcePath);
58:
59: /**
60: * Checks if the handler can be used to determine the CSS style sheet based on the edited resource.<p>
61: *
62: * @param cms the current OpenCms user context
63: * @param editedResourcePath the absolute VFS path of the currently edited resource
64: * @return true if the handler matches, otherwise false
65: */
66: boolean matches(CmsObject cms, String editedResourcePath);
67:
68: }
|