1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.internal.mandatory

File XWikiCommentsDocumentInitializer.java

 

Coverage histogram

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

Code metrics

0
10
2
1
70
31
2
0.2
5
2
1

Classes

Class Line # Actions
XWikiCommentsDocumentInitializer 41 10 0% 2 0
1.0100%
 

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 com.xpn.xwiki.internal.mandatory;
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.XWiki;
28    import com.xpn.xwiki.doc.XWikiDocument;
29    import com.xpn.xwiki.objects.classes.BaseClass;
30    import com.xpn.xwiki.objects.classes.TextAreaClass.EditorType;
31   
32    /**
33    * Update XWiki.XWikiComments document with all required informations.
34    *
35    * @version $Id: b72d871705ea5c970e8cd25bf6bb22345248501d $
36    * @since 4.3M1
37    */
38    @Component
39    @Named("XWiki.XWikiComments")
40    @Singleton
 
41    public class XWikiCommentsDocumentInitializer extends AbstractMandatoryDocumentInitializer
42    {
43    /**
44    * Default constructor.
45    */
 
46  60 toggle public XWikiCommentsDocumentInitializer()
47    {
48  60 super(XWiki.SYSTEM_SPACE, "XWikiComments");
49    }
50   
 
51  101 toggle @Override
52    public boolean updateDocument(XWikiDocument document)
53    {
54  101 boolean needsUpdate = false;
55   
56  101 BaseClass bclass = document.getXClass();
57   
58  101 needsUpdate |= bclass.addTextField("author", "Author", 30);
59  101 needsUpdate |= bclass.addTextAreaField("highlight", "Highlighted Text", 40, 2);
60  101 needsUpdate |= bclass.addNumberField("replyto", "Reply To", 5, "integer");
61  101 needsUpdate |= bclass.addDateField("date", "Date");
62    // Use the Text editor for backwards compatibility (e.g. the annotation module which uses the comment class
63    // doesn't expect the WYSIWYG editor).
64  101 needsUpdate |= bclass.addTextAreaField("comment", "Comment", 40, 5, EditorType.TEXT);
65   
66  101 needsUpdate |= setClassDocumentFields(document, "XWiki Comment Class");
67   
68  101 return needsUpdate;
69    }
70    }