Package com.xwiki.pdfviewer.macro

Class PDFViewerMacroParameters

  • public class PDFViewerMacroParameters
extends Object
    Parameters for PDF Viewer Macro.
    Since:
    2.3
    Version:
    $Id$

    • Constructor Detail

      • PDFViewerMacroParameters

        public PDFViewerMacroParameters()

    • Method Detail

      • getFile

        public String getFile()
        Returns:
        one or a list of PDF files

      • setFile

        public void setFile​(String file)
        Set the value of one or multiple files. One file is represented by using a full attachment reference, an absolute URL or simply the file name.
        Parameters:
        file - one or a list of PDF files

      • getFileFromExternalUrl

        @Unstable
public String getFileFromExternalUrl()
        Returns:
        one or a comma-separated list of PDF files from external URLs
        Since:
        2.6.3

      • setFileFromExternalUrl

        @Unstable
public void setFileFromExternalUrl​(String fileFromExternalUrl)
        Set one or multiple PDF files from external URLs.
        Parameters:
        fileFromExternalUrl - a single URL or a comma-separated list of URLs
        Since:
        2.6.3

      • getWidth

        public String getWidth()
        Returns:
        the display width of the PDF file

      • setWidth

        public void setWidth​(String width)
        Set the display width of the PDF file.
        Parameters:
        width - display width of the PDF file

      • getHeight

        public int getHeight()
        Returns:
        the display height of the PDF file

      • setHeight

        public void setHeight​(int height)
        Set the display height of the PDF file.
        Parameters:
        height - display height of the PDF file

      • getDocument

        public String getDocument()
        Returns:
        the reference of the document that contains the PDF files to be viewed

      • setDocument

        public void setDocument​(String document)
        Set the reference of the document that contains the PDF files to be viewed.
        Parameters:
        document - reference of the document that contains the PDF files

      • getAsAuthor

        public String getAsAuthor()
        Returns:
        whether to access the PDF file on behalf of the last author of the page calling the PDF Viewer macro (using their access rights) rather than on behalf of the current user (using the access rights of the current user)

      • setAsAuthor

        public void setAsAuthor​(String asAuthor)
        Set whether to access the PDF file on behalf of the last author of the page calling the PDF Viewer macro (using their access rights) rather than on behalf of the current user (using the access rights of the current user).
        Parameters:
        asAuthor - true (or 1 or yes) if the view right of the PDF file document should be delegated to the users that requests to see it through the macro, false (or 0 or no) otherwise