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

File EditorBindingClassDocumentInitializer.java

 

Coverage histogram

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

Code metrics

0
7
2
1
72
31
2
0.29
3.5
2
1

Classes

Class Line # Actions
EditorBindingClassDocumentInitializer 42 7 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   
33    /**
34    * Update the {@code XWiki.EditorBindingClass} document with all the required information.
35    *
36    * @version $Id: 085c52111a888147eb757b13b20034134a099684 $
37    * @since 8.2RC1
38    */
39    @Component
40    @Named("XWiki.EditorBindingClass")
41    @Singleton
 
42    public class EditorBindingClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
43    {
44    /**
45    * The local reference of the editor binding class.
46    */
47    public static final LocalDocumentReference REFERENCE = new LocalDocumentReference(XWiki.SYSTEM_SPACE,
48    "EditorBindingClass");
49   
50    /**
51    * Default constructor.
52    */
 
53  60 toggle public EditorBindingClassDocumentInitializer()
54    {
55  60 super(REFERENCE);
56    }
57   
 
58  92 toggle @Override
59    public boolean updateDocument(XWikiDocument document)
60    {
61  92 boolean needsUpdate = false;
62   
63  92 BaseClass bclass = document.getXClass();
64   
65  92 needsUpdate |= bclass.addTextField("dataType", "Data Type", 30);
66  92 needsUpdate |= bclass.addTextField("roleHint", "Role Hint", 30);
67   
68  92 needsUpdate |= setClassDocumentFields(document, "Editor Binding Class");
69   
70  92 return needsUpdate;
71    }
72    }