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

File OfficeResourceViewer.java

 

Code metrics

0
0
0
1
47
10
0
-
-
0
-

Classes

Class Line # Actions
OfficeResourceViewer 36 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.office.viewer;
21   
22    import java.util.Map;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.rendering.block.XDOM;
26    import org.xwiki.rendering.listener.reference.ResourceReference;
27   
28    /**
29    * The component responsible for creating XDOM views from office resource.
30    *
31    * @version $Id: 74ea05c0154287dc7ab69c1e52b210cfc6d61864 $
32    * @since 5.4.6
33    * @since 6.2.2
34    */
35    @Role
 
36    public interface OfficeResourceViewer
37    {
38    /**
39    * Creates a {@link XDOM} view of the specified office file.
40    *
41    * @param reference reference to the office file to be viewed
42    * @param parameters implementation specific view parameters
43    * @return {@link XDOM} representation of the specified office document
44    * @throws Exception if an error occurs while accessing the office attachment or while creating the view
45    */
46    XDOM createView(ResourceReference reference, Map<String, ?> parameters) throws Exception;
47    }