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

File IWemListenerProgramming.java

 

Code metrics

0
0
0
1
77
8
0
-
-
0
-

Classes

Class Line # Actions
IWemListenerProgramming 36 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.rendering.wikimodel;
21   
22    /**
23    * This interface re-groups all listener methods related to document elements
24    * which should be interpreted by the client code. The meaning of extensions and
25    * macros is not defined by the WikiModel. The general recommended semantic of
26    * macros - macros can be used to define interpreted/executable code in the
27    * handled document. Extensions are used mostly to <em>call</em> already defined
28    * somewhere code to insert back the results of these calls in the document.
29    * handled document. But the exact semantic and associated actions of these
30    * elements should be defined by the client code in an implementation-specific
31    * way.
32    *
33    * @version $Id: 5f25e5f37b564e5e49aa123dd2ae8d0197dc507b $
34    * @since 4.0M1
35    */
 
36    public interface IWemListenerProgramming
37    {
38    /**
39    * This method is used to notify about a new extension which CAN generate
40    * block elements as a result of its interpretation.
41    *
42    * @param extensionName the name of the extension
43    * @param params parameters for the extension
44    */
45    void onExtensionBlock(String extensionName, WikiParameters params);
46   
47    /**
48    * This method is used to notify about a new extension which CAN generate
49    * in-line elements as a result of its interpretation. This method CAN NOT
50    * generate block elements.
51    *
52    * @param extensionName the name of the extension
53    * @param params parameters for the extension
54    */
55    void onExtensionInline(String extensionName, WikiParameters params);
56   
57    /**
58    * This method is used to notify about a new in-line macro which CAN
59    * generate block elements as a result of its interpretation.
60    *
61    * @param macroName the name of the macro
62    * @param params parameters of the macro
63    * @param content the content of the macro
64    */
65    void onMacroBlock(String macroName, WikiParameters params, String content);
66   
67    /**
68    * This method is used to notify about a new in-line macro which CAN
69    * generate only in-line elements as a result of its interpretation. This
70    * method CAN NOT generate block elements.
71    *
72    * @param macroName the name of the macro
73    * @param params parameters of the macro
74    * @param content the content of the macro
75    */
76    void onMacroInline(String macroName, WikiParameters params, String content);
77    }