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

File WikiMacroParameterClassDocumentInitializer.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
9
2
1
67
30
2
0.22
4.5
2
1

Classes

Class Line # Actions
WikiMacroParameterClassDocumentInitializer 40 9 0% 2 0
1.0100%
 

Contributing tests

This file is covered by 4 tests. .

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.wikimacro.internal;
21   
22    import javax.inject.Named;
23    import javax.inject.Singleton;
24   
25    import org.xwiki.component.annotation.Component;
26   
27    import com.xpn.xwiki.doc.XWikiDocument;
28    import com.xpn.xwiki.internal.mandatory.AbstractMandatoryDocumentInitializer;
29    import com.xpn.xwiki.objects.classes.BaseClass;
30   
31    /**
32    * Update XWiki.XWikiComments document with all required informations.
33    *
34    * @version $Id: c450f9d8a99e0e00a863bf0aeb0479cde393b067 $
35    * @since 4.3M1
36    */
37    @Component
38    @Named(WikiMacroConstants.WIKI_MACRO_PARAMETER_CLASS)
39    @Singleton
 
40    public class WikiMacroParameterClassDocumentInitializer extends AbstractMandatoryDocumentInitializer implements
41    WikiMacroConstants
42    {
43    /**
44    * Default constructor.
45    */
 
46  23 toggle public WikiMacroParameterClassDocumentInitializer()
47    {
48  23 super(WIKI_MACRO_PARAMETER_CLASS_SPACE, WIKI_MACRO_PARAMETER_CLASS_PAGE);
49    }
50   
 
51  57 toggle @Override
52    public boolean updateDocument(XWikiDocument document)
53    {
54  57 boolean needsUpdate = false;
55   
56  57 BaseClass bclass = document.getXClass();
57   
58  57 needsUpdate |= bclass.addTextField(PARAMETER_NAME_PROPERTY, "Parameter name", 30);
59  57 needsUpdate |= bclass.addTextAreaField(PARAMETER_DESCRIPTION_PROPERTY, "Parameter description", 40, 5);
60  57 needsUpdate |= bclass.addBooleanField(PARAMETER_MANDATORY_PROPERTY, "Parameter mandatory", "yesno");
61  57 needsUpdate |= bclass.addTextField(PARAMETER_DEFAULT_VALUE_PROPERTY, "Parameter default value", 30);
62   
63  57 needsUpdate |= setClassDocumentFields(document, "XWiki Wiki Macro Parameter Class");
64   
65  57 return needsUpdate;
66    }
67    }