Package com.xwiki.macros.viewfile.macro

Class ViewFileMacroParameters

  • public class ViewFileMacroParameters
extends Object
    Parameter bean class for ViewFileMacro.
    Since:
    1.27
    Version:
    $Id$

    • Constructor Detail

      • ViewFileMacroParameters

        public ViewFileMacroParameters()

    • Method Detail

      • getName

        public String getName()
        Returns:
        the name of the attachment.

      • setName

        public void setName​(String name)
        Set the attachment name.
        Parameters:
        name - the name of the attachment.

      • getPage

        public String getPage()
        Returns:
        the source document of the attachments.

      • setPage

        public void setPage​(String page)
        Set the source document for the attachments.
        Parameters:
        page - the source document of the attachments.

      • getDisplay

        public ViewFileDisplay getDisplay()
        Returns:
        the display type.

      • setDisplay

        public void setDisplay​(ViewFileDisplay display)
        Set the display type.
        Parameters:
        display - the display type.

      • getWidth

        public String getWidth()
        Returns:
        the width of the display window.

      • setWidth

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

      • getHeight

        public String getHeight()
        Returns:
        the height of the display window.

      • setHeight

        public void setHeight​(String height)
        Set the height of the display window.
        Parameters:
        height - the height of the display window.

      • getAttFilename

        public String getAttFilename()
        Returns:
        the attachment filename.

      • setAttFilename

        public void setAttFilename​(String attFilename)
        Alias of File name used for compatibility reasons.
        Parameters:
        attFilename - the attachment filename.

      • setCSVFormat

        public void setCSVFormat​(String csvFormat)
        Set the CSV format to use for CSV files.
        Parameters:
        csvFormat - the CSV format
        Since:
        1.30.0

      • getCSVFormat

        public String getCSVFormat()
        Returns:
        the format to use for CSV files
        Since:
        1.30.0

      • getCSVDelimiter

        public String getCSVDelimiter()
        Returns:
        the delimiter to use for CSV files
        Since:
        1.30.0

      • setCSVDelimiter

        public void setCSVDelimiter​(String csvDelimiter)
        Set the CSV delimiter to use for CSV files.
        Parameters:
        csvDelimiter - the CSV delimiter
        Since:
        1.30.0

      • getCSVFirstLineIsHeader

        public boolean getCSVFirstLineIsHeader()
        Returns:
        whether the first line is to be considered the header for CSV files
        Since:
        1.30.0

      • setCSVFirstLineIsHeader

        public void setCSVFirstLineIsHeader​(boolean csvFirstLineIsHeader)
        Set whether the first line is to be considered the header for CSV files.
        Parameters:
        csvFirstLineIsHeader - the CSV delimiter
        Since:
        1.30.0