addHeader

the first page or title page.
even pages.
odd pages (this one is the default header for the whole document if no other headers are defined for the first or even pages).

The contents of the different headers are defined via the use of WordFragments. These header WordFragments allow for the insertion of:

text paragraphs
current date and/or hour
images
links
lists
page numbers
shapes
tables

Parameters

headers

A HashMap with the different header contents.

Option	Type	Description
default	WordFragment	The WordML fragment object containing the contents for the default (odd pages) header.
even	WordFragment	The WordML fragment object containing the contents for the even pages header.
first	WordFragment	The WordML fragment object containing the contents for the first (title) page header.

Code samples

Example #1:

package examples.LayoutAndGeneral.addHeader;

import java.util.HashMap;

import com.javadocx.CreateDocx;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setDpi(300);
        
        WordFragment headerImage = new WordFragment(docx, "defaultHeader");
        headerImage.addImage("src/examples/files/img/image.png", imageOptions);
        
        HashMap<String, WordFragment> headers = new HashMap<String, WordFragment>();
        headers.put("default", headerImage);
        
        docx.addHeader(headers);
        
        docx.addText("This document has a header with just one image.");
        
        docx.createDocx("example_addHeader_1");
    }
}

The resulting Word document looks like this:

Example #2:

package examples.LayoutAndGeneral.addHeader;

import java.util.ArrayList;
import java.util.HashMap;

import com.javadocx.CreateDocx;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setDpi(600);
        
        WordFragment headerImage = new WordFragment(docx, "defaultHeader");
        headerImage.addImage("src/examples/files/img/image.png", imageOptions);
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("Javadocx Header Title")
                   .setFontSize(13)
                   .setBold(true)
                   .setColor("567899");
        
        WordFragment headerText = new WordFragment(docx, "defaultHeader");
        headerText.addText(textOptions);
        
        WordFragment headerPageNumber = new WordFragment(docx, "defaultHeader");
        OptionsPageNumber pageNumberOptions = new OptionsPageNumber();
        pageNumberOptions.setTextAlign("right")
                         .setFontSize(11);
        headerPageNumber.addPageNumber("numerical", pageNumberOptions);
        
        ArrayList<OptionsTableData> valuesRow1 = new ArrayList<OptionsTableData>();
        
        OptionsTableData valuesRow1Cell1 = new OptionsTableData();
        valuesRow1Cell1.setValue(headerImage)
                       .setvAlign("center");
        
        OptionsTableData valuesRow1Cell2 = new OptionsTableData();
        valuesRow1Cell2.setValue(headerText)
                       .setvAlign("center");
        
        OptionsTableData valuesRow1Cell3 = new OptionsTableData();
        valuesRow1Cell3.setValue(headerPageNumber)
                       .setvAlign("center");
        
        valuesRow1.add(valuesRow1Cell1);
        valuesRow1.add(valuesRow1Cell2);
        valuesRow1.add(valuesRow1Cell3);
        
        ArrayList<ArrayList<OptionsTableData>> valuesTable = new ArrayList<ArrayList<OptionsTableData>>();
        valuesTable.add(valuesRow1);
        
        ArrayList<String> columnWidths = new ArrayList<String>();
        columnWidths.add("700");
        columnWidths.add("7500");
        columnWidths.add("500");
        
        OptionsTableProperties tableProperties = new OptionsTableProperties();
        tableProperties.setBorder("nil")
                       .setColumnWidthVariable(columnWidths);
        
        WordFragment headerTable = new WordFragment(docx, "defaultHeader");
        headerTable.addTable(valuesTable, tableProperties);
        
        HashMap<String, WordFragment> headers = new HashMap<String, WordFragment>();
        headers.put("default", headerTable);
        
        docx.addHeader(headers);
        
        docx.addText("This document has a header with an image, some text and page numbering.");
        
        OptionsBreak breakOptions = new OptionsBreak();
        breakOptions.setType("page");
        docx.addBreak(breakOptions);
        
        docx.addText("Now some text in the second page.");
        
        docx.createDocx("example_addHeader_2");
    }
}