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

File OfficeViewer.java

 

Code metrics

0
0
0
1
48
11
0
-
-
0
-

Classes

Class Line # Actions
OfficeViewer 37 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.model.reference.AttachmentReference;
26    import org.xwiki.rendering.block.XDOM;
27   
28    /**
29    * The component responsible for creating XDOM views from office attachments.
30    *
31    * @since 2.5M2
32    * @version $Id: 4e1b0a30c04740bd52027fd7cbea04ca7ec90f78 $
33    * @deprecated since 5.4.6/6.2.2, use {@link OfficeResourceViewer} instead
34    */
35    @Role
36    @Deprecated
 
37    public interface OfficeViewer
38    {
39    /**
40    * Creates a {@link XDOM} view of the specified office attachment.
41    *
42    * @param attachmentReference reference to the office attachment to be viewed
43    * @param parameters implementation specific view parameters
44    * @return {@link XDOM} representation of the specified office document
45    * @throws Exception if an error occurs while accessing the office attachment or while creating the view
46    */
47    XDOM createView(AttachmentReference attachmentReference, Map<String, String> parameters) throws Exception;
48    }