Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
EditConfiguration | 35 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.edit; | |
21 | ||
22 | import java.lang.reflect.Type; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.stability.Unstable; | |
26 | ||
27 | /** | |
28 | * Edit configuration options. | |
29 | * | |
30 | * @version $Id: 262a94895c9ae64b7330093043b9c303824c9f22 $ | |
31 | * @since 8.2RC1 | |
32 | */ | |
33 | @Role | |
34 | @Unstable | |
35 | public interface EditConfiguration | |
36 | { | |
37 | /** | |
38 | * Returns the component hint of the configured default editor or the id of the configured default editor category | |
39 | * associated with the specified data type. Returns {@code null} if there's no configured default editor or default | |
40 | * editor category for the specified data type. | |
41 | * | |
42 | * @param dataType some data type | |
43 | * @return an editor component hint, or a editor category id or {@code null} | |
44 | */ | |
45 | String getDefaultEditor(Type dataType); | |
46 | ||
47 | /** | |
48 | * Returns the component hint of the configured default editor within the specified category, or the id of the | |
49 | * configured default editor sub-category within the specified category, associated with the specified data type. | |
50 | * Returns {@code null} if there's no configured default editor or default editor sub-category for the specified | |
51 | * data type. | |
52 | * | |
53 | * @param dataType some data type | |
54 | * @param category some editor category | |
55 | * @return an editor component hint, or a editor sub-category id or {@code null} | |
56 | */ | |
57 | String getDefaultEditor(Type dataType, String category); | |
58 | } |