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

File EditorClassDocumentInitializer.java

 

Coverage histogram

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

Code metrics

0
11
2
1
77
36
2
0.18
5.5
2
1

Classes

Class Line # Actions
EditorClassDocumentInitializer 43 11 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 org.xwiki.edit.internal;
21   
22    import javax.inject.Named;
23    import javax.inject.Singleton;
24   
25    import org.xwiki.component.annotation.Component;
26    import org.xwiki.model.reference.LocalDocumentReference;
27   
28    import com.xpn.xwiki.XWiki;
29    import com.xpn.xwiki.doc.XWikiDocument;
30    import com.xpn.xwiki.internal.mandatory.AbstractMandatoryDocumentInitializer;
31    import com.xpn.xwiki.objects.classes.BaseClass;
32    import com.xpn.xwiki.objects.classes.TextAreaClass.EditorType;
33   
34    /**
35    * Update the {@code XWiki.EditorClass} document with all the required information.
36    *
37    * @version $Id: 4af6c20a515c98516603b097acdaad55050493e6 $
38    * @since 8.2RC1
39    */
40    @Component
41    @Named("XWiki.EditorClass")
42    @Singleton
 
43    public class EditorClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
44    {
45    /**
46    * The local reference of the editor class.
47    */
48    public static final LocalDocumentReference REFERENCE =
49    new LocalDocumentReference(XWiki.SYSTEM_SPACE, "EditorClass");
50   
51    /**
52    * Default constructor.
53    */
 
54  60 toggle public EditorClassDocumentInitializer()
55    {
56  60 super(REFERENCE);
57    }
58   
 
59  92 toggle @Override
60    public boolean updateDocument(XWikiDocument document)
61    {
62  92 boolean needsUpdate = false;
63   
64  92 BaseClass bclass = document.getXClass();
65   
66  92 needsUpdate |= bclass.addTextField("dataType", "Data Type", 30);
67  92 needsUpdate |= bclass.addTextField("roleHint", "Role Hint", 30);
68  92 needsUpdate |= bclass.addTextAreaField("code", "Code", 40, 20, EditorType.TEXT);
69  92 needsUpdate |= bclass.addTextField("icon", "Icon", 30);
70  92 needsUpdate |= bclass.addTextField("category", "Category", 30);
71  92 needsUpdate |= bclass.addStaticListField("scope", "Scope", "wiki=Current Wiki|user=Current User|global=Global");
72   
73  92 needsUpdate |= setClassDocumentFields(document, "Editor Class");
74   
75  92 return needsUpdate;
76    }
77    }