Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
TransformationContextMode | 33 | 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.rendering.macro.context; | |
21 | ||
22 | /** | |
23 | * Defines the strategy to use for setting the Transformation Context for the Context Macro. Namely this controls | |
24 | * the context for the macros located inside the Context Macro. For example some macros will use as input the other | |
25 | * XDOM elements before or after the current Macro block that they correspond to. For example the TOC macro executes | |
26 | * late (with a low priority) so that all other macros have a chance to execute and then it looks for all Heading | |
27 | * Blocks in the XDOM, from the root. | |
28 | * | |
29 | * @version $Id: cb8ff325b2b2b22cfe494ecae04496ac2172c113 $ | |
30 | * @since 8.3 | |
31 | * @since 8.4RC1 | |
32 | */ | |
33 | public enum TransformationContextMode | |
34 | { | |
35 | /** | |
36 | * The XDOM on which the macros in the Context macro execute is the current document's XDOM. | |
37 | */ | |
38 | CURRENT, | |
39 | ||
40 | /** | |
41 | * The XDOM on which the macros in the Context macro execute is the referenced document's XDOM (but without | |
42 | * transformations applied to that XDOM). | |
43 | */ | |
44 | DOCUMENT, | |
45 | ||
46 | /** | |
47 | * The XDOM on which the macros in the Context macro execute is the referenced document's XDOM but with | |
48 | * transformations applied to that XDOM. IMPORTANT: This can be dangerous since it means executing macros, and thus | |
49 | * also script macros defined in the referenced document. To be used with caution since that have side effects. | |
50 | */ | |
51 | TRANSFORMATIONS | |
52 | } |