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

File SheetClassDocumentInitializer.java

 

Coverage histogram

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

Code metrics

2
8
2
1
71
30
3
0.38
4
2
1.5

Classes

Class Line # Actions
SheetClassDocumentInitializer 42 8 0% 3 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   
31    /**
32    * Update XWiki.SheetClass document with all required informations.
33    *
34    * @version $Id: c8842dfc33a9fa3c2d8681486fb4dc0227d7b18b $
35    * @deprecated since 3.1M2 edit mode class should be used for this purpose, not the sheet class
36    * @since 4.3M1
37    */
38    @Component
39    @Named("XWiki.SheetClass")
40    @Singleton
41    @Deprecated
 
42    public class SheetClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
43    {
44    /**
45    * Default constructor.
46    */
 
47  60 toggle public SheetClassDocumentInitializer()
48    {
49  60 super(XWiki.SYSTEM_SPACE, "SheetClass");
50    }
51   
 
52  92 toggle @Override
53    public boolean updateDocument(XWikiDocument document)
54    {
55  92 boolean needsUpdate = false;
56   
57  92 BaseClass bclass = document.getXClass();
58   
59    // Note: Ideally we don't want a special field in the sheet class but XWiki classes must have at
60    // least one field or they're not saved. Thus we are introducing a "defaultEditMode" which will
61    // tell what edit mode to use. If empty it'll default to "inline".
62  92 needsUpdate |= bclass.addTextField("defaultEditMode", "Default Edit Mode", 15);
63   
64  92 if (document.isNew()) {
65  38 needsUpdate |= setClassDocumentFields(document, "XWiki Sheet Class");
66  38 document.setContent(document.getContent() + "\n\nClass that should be used to recognize sheet pages.");
67    }
68   
69  92 return needsUpdate;
70    }
71    }