1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.edit

File EditorDescriptor.java

 

Code metrics

0
0
0
1
57
11
0
-
-
0
-

Classes

Class Line # Actions
EditorDescriptor 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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 org.xwiki.stability.Unstable;
23   
24    /**
25    * Describes an {@link Editor}.
26    *
27    * @version $Id: 05165dd5b6f1302bce98af514d643266e39082c9 $
28    * @since 8.2RC1
29    */
30    @Unstable
 
31    public interface EditorDescriptor
32    {
33    /**
34    * @return the editor identifier (normally the editor component hint)
35    */
36    String getId();
37   
38    /**
39    * @return the editor name
40    */
41    String getName();
42   
43    /**
44    * @return the editor description
45    */
46    String getDescription();
47   
48    /**
49    * @return the editor icon
50    */
51    String getIcon();
52   
53    /**
54    * @return the editor category
55    */
56    String getCategory();
57    }