Class XWPFHeaderFooter

    • Constructor Detail

      • XWPFHeaderFooter

        public XWPFHeaderFooter​(POIXMLDocumentPart parent,
                                PackagePart part)
                         throws java.io.IOException
        Throws:
        java.io.IOException
        Since:
        by POI 3.14-Beta1
    • Method Detail

      • getBodyElements

        public java.util.List<IBodyElement> getBodyElements()
        Description copied from interface: IBody
        Returns an Iterator with paragraphs and tables, in the order that they occur in the text.
        Specified by:
        getBodyElements in interface IBody
      • getParagraphs

        public java.util.List<XWPFParagraph> getParagraphs()
        Returns the paragraph(s) that holds the text of the header or footer. Normally there is only the one paragraph, but there could be more in certain cases, or a table.
        Specified by:
        getParagraphs in interface IBody
      • getTables

        public java.util.List<XWPFTable> getTables()
                                            throws java.lang.ArrayIndexOutOfBoundsException
        Return the table(s) that holds the text of the header or footer, for complex cases where a paragraph isn't used. Normally there's just one paragraph, but some complex headers/footers have a table or two in addition.
        Specified by:
        getTables in interface IBody
        Throws:
        java.lang.ArrayIndexOutOfBoundsException
      • getText

        public java.lang.String getText()
        Returns the textual content of the header/footer, by flattening out the text of its paragraph(s)
      • setHeaderFooter

        public void setHeaderFooter​(CTHdrFtr headerFooter)
        set a new headerFooter
      • getTable

        public XWPFTable getTable​(CTTbl ctTable)
        if there is a corresponding XWPFTable of the parameter ctTable in the tableList of this header the method will return this table if there is no corresponding XWPFTable the method will return null
        Specified by:
        getTable in interface IBody
        Parameters:
        ctTable -
      • getParagraph

        public XWPFParagraph getParagraph​(CTP p)
        if there is a corresponding XWPFParagraph of the parameter ctTable in the paragraphList of this header or footer the method will return this paragraph if there is no corresponding XWPFParagraph the method will return null
        Specified by:
        getParagraph in interface IBody
        Parameters:
        p - is instance of CTP and is searching for an XWPFParagraph
        Returns:
        null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer XWPFParagraph with the correspondig CTP p
      • getParagraphArray

        public XWPFParagraph getParagraphArray​(int pos)
        Returns the paragraph that holds the text of the header or footer.
        Specified by:
        getParagraphArray in interface IBody
      • getListParagraph

        public java.util.List<XWPFParagraph> getListParagraph()
        get a List of all Paragraphs
        Returns:
        a list of XWPFParagraph
      • getAllPackagePictures

        public java.util.List<XWPFPictureData> getAllPackagePictures()
        get all Pictures in this package
        Returns:
        all Pictures in this package
      • addPictureData

        public java.lang.String addPictureData​(byte[] pictureData,
                                               int format)
                                        throws InvalidFormatException
        Adds a picture to the document.
        Parameters:
        pictureData - The picture data
        format - The format of the picture.
        Returns:
        the index to this picture (0 based), the added picture can be obtained from getAllPictures() .
        Throws:
        InvalidFormatException - If the format of the picture is not known.
      • addPictureData

        public java.lang.String addPictureData​(java.io.InputStream is,
                                               int format)
                                        throws InvalidFormatException,
                                               java.io.IOException
        Adds a picture to the document.
        Parameters:
        is - The stream to read image from
        format - The format of the picture.
        Returns:
        the index to this picture (0 based), the added picture can be obtained from getAllPictures() .
        Throws:
        InvalidFormatException - If the format of the picture is not known.
        java.io.IOException - If reading the picture-data from the stream fails.
      • getPictureDataByID

        public XWPFPictureData getPictureDataByID​(java.lang.String blipID)
        returns the PictureData by blipID
        Parameters:
        blipID -
        Returns:
        XWPFPictureData of a specificID
        Throws:
        java.lang.Exception
      • createParagraph

        public XWPFParagraph createParagraph()
        Adds a new paragraph at the end of the header or footer
        Returns:
        new XWPFParagraph object
      • createTable

        public XWPFTable createTable​(int rows,
                                     int cols)
        Adds a new table at the end of the header or footer
        Parameters:
        rows - - number of rows in the table
        cols - - number of columns in the table
        Returns:
        new XWPFTable object
      • removeParagraph

        public void removeParagraph​(XWPFParagraph paragraph)
        Removes a specific paragraph from this header / footer
        Parameters:
        paragraph - - XWPFParagraph object to remove
      • removeTable

        public void removeTable​(XWPFTable table)
        Removes a specific table from this header / footer
        Parameters:
        table - - XWPFTable object to remove
      • clearHeaderFooter

        public void clearHeaderFooter()
        Clears all paragraphs and tables from this header / footer
      • insertNewParagraph

        public XWPFParagraph insertNewParagraph​(XmlCursor cursor)
        add a new paragraph at position of the cursor
        Specified by:
        insertNewParagraph in interface IBody
        Parameters:
        cursor -
        Returns:
        the inserted paragraph
      • insertNewTbl

        public XWPFTable insertNewTbl​(XmlCursor cursor)
        Description copied from interface: IBody
        inserts a new Table at the cursor position.
        Specified by:
        insertNewTbl in interface IBody
        Parameters:
        cursor -
        Returns:
        the inserted table
      • insertTable

        public void insertTable​(int pos,
                                XWPFTable table)
        inserts an existing XWPFTable to the arrays bodyElements and tables
        Specified by:
        insertTable in interface IBody
        Parameters:
        pos -
        table -
      • readHdrFtr

        public void readHdrFtr()
      • getTableCell

        public XWPFTableCell getTableCell​(CTTc cell)
        get the TableCell which belongs to the TableCell
        Specified by:
        getTableCell in interface IBody
        Parameters:
        cell -
      • setXWPFDocument

        public void setXWPFDocument​(XWPFDocument doc)
      • getPart

        public POIXMLDocumentPart getPart()
        returns the Part, to which the body belongs, which you need for adding relationship to other parts
        Specified by:
        getPart in interface IBody
        Returns:
        the Part, to which the body belongs
        See Also:
        IBody.getPart()