Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
AnnotationConfiguration | 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.annotation; | |
21 | ||
22 | import java.util.List; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.model.reference.DocumentReference; | |
26 | import org.xwiki.model.reference.SpaceReference; | |
27 | ||
28 | /** | |
29 | * The configuration of the Annotations Application for the current wiki. | |
30 | * | |
31 | * @version $Id: 32280422491f17a2ced38607e93928464a2527a5 $ | |
32 | * @since 4.0M2 | |
33 | */ | |
34 | @Role | |
35 | public interface AnnotationConfiguration | |
36 | { | |
37 | /** | |
38 | * The configuration page's space name. | |
39 | */ | |
40 | String CONFIGURATION_PAGE_SPACE_NAME = "AnnotationCode"; | |
41 | ||
42 | /** | |
43 | * The configuration page's name. | |
44 | */ | |
45 | String CONFIGURATION_PAGE_NAME = "AnnotationConfig"; | |
46 | ||
47 | /** | |
48 | * @return true if the annotations application is installed. | |
49 | */ | |
50 | boolean isInstalled(); | |
51 | ||
52 | /** | |
53 | * @return true if the annotations UI is activated, false otherwise. | |
54 | */ | |
55 | boolean isActivated(); | |
56 | ||
57 | /** | |
58 | * @return the list of spaces where the annotations UI should not be displayed. | |
59 | */ | |
60 | List<SpaceReference> getExceptionSpaces(); | |
61 | ||
62 | /** | |
63 | * @return true if annotations are displayed by default in the UI. | |
64 | */ | |
65 | boolean isDisplayedByDefault(); | |
66 | ||
67 | /** | |
68 | * @return true if the annotations should be highlighted by default in the UI. | |
69 | */ | |
70 | boolean isDisplayedHighlightedByDefault(); | |
71 | ||
72 | /** | |
73 | * @return the reference of the XWiki class defining an annotation's structure. | |
74 | */ | |
75 | DocumentReference getAnnotationClassReference(); | |
76 | } |