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

File UIExtension.java

 

Code metrics

0
0
0
1
58
12
0
-
-
0
-

Classes

Class Line # Actions
UIExtension 34 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.uiextension;
21   
22    import java.util.Map;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.rendering.block.Block;
26   
27    /**
28    * Represents a User Interface Extension.
29    *
30    * @version $Id: 1c0f1d707b8afe19e6e3198a71c3b8b868dba534 $
31    * @since 4.2M3
32    */
33    @Role
 
34    public interface UIExtension
35    {
36    /**
37    * @return the ID of this extension
38    */
39    String getId();
40   
41    /**
42    * @return the ID of the extension point this UI extension is providing an extension for
43    */
44    String getExtensionPointId();
45   
46    /**
47    * A map of parameters provided by the extension. When providing a new Extension Point the developer must document
48    * the list of parameters he requires.
49    *
50    * @return a map of parameters provided by the extension
51    */
52    Map<String, String> getParameters();
53   
54    /**
55    * @return the {@link Block} that must be rendered when this extension is displayed
56    */
57    Block execute();
58    }