1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.display.internal

File DisplayConfiguration.java

 

Code metrics

0
0
0
1
44
8
0
-
-
0
-

Classes

Class Line # Actions
DisplayConfiguration 31 0 - 0 0
-1.0 -
 

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.display.internal;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Configuration properties for the display module.
26    *
27    * @version $Id: f1bd0090069a03e013fbdf7a18c095b2fcf8814f $
28    * @since 3.2M3
29    */
30    @Role
 
31    public interface DisplayConfiguration
32    {
33    /**
34    * @return the {@link DocumentDisplayer} hint
35    */
36    String getDocumentDisplayerHint();
37   
38    /**
39    * @return the maximum heading depth to look for when computing a document's title from its content. If no heading
40    * with a level equal or lower to the specified depth is found then the computed title falls back to the
41    * document name.
42    */
43    int getTitleHeadingDepth();
44    }