trunk/simple/src/test/java/org/odftoolkit/simple/text/FooterTest.java

/* 
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/

package org.odftoolkit.simple.text;

import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import junit.framework.Assert;

import org.junit.Test;
import org.odftoolkit.odfdom.dom.element.style.StyleFooterElement;
import org.odftoolkit.odfdom.dom.element.table.TableTableElement;
import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.type.Color;
import org.odftoolkit.simple.TextDocument;
import org.odftoolkit.simple.common.field.VariableField;
import org.odftoolkit.simple.common.field.VariableField.VariableType;
import org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType;
import org.odftoolkit.simple.table.Cell;
import org.odftoolkit.simple.table.Table;
import org.odftoolkit.simple.table.Table.TableBuilder;
import org.odftoolkit.simple.utils.ResourceUtilities;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

public class FooterTest {

	String footerDocumentPath = "FooterTableDocument.odt";

	@Test
	public void testAddTable() {
		try {
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			Assert.assertNotNull(footer);

			Table table = footer.addTable(1, 1);
			table.setTableName("footerTable");
			int rowCount = table.getRowCount();
			int columnCount = table.getColumnCount();
			String expectedCellValue = "footer table cell";
			Cell cellByPosition = table.getCellByPosition(0, 0);
			cellByPosition.setStringValue(expectedCellValue);
			cellByPosition.setHorizontalAlignment(HorizontalAlignmentType.CENTER);
			cellByPosition.setCellBackgroundColor(Color.GREEN);
			
			//first page
			footer = doc.getFooter(true);
			Assert.assertNotNull(footer);
			table = footer.addTable(1, 2);
			table.setTableName("footerFTable");
			doc.save(ResourceUtilities.newTestOutputFile(footerDocumentPath));

			// load the document again.
			doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream(footerDocumentPath));
			footer = doc.getFooter();
			table = footer.getTableByName("footerTable");
			Assert.assertEquals(rowCount, table.getRowCount());
			Assert.assertEquals(columnCount, table.getColumnCount());
			Assert.assertEquals(expectedCellValue, cellByPosition.getStringValue());

			footer = doc.getFooter(true);
			table = footer.getTableByName("footerFTable");
			Assert.assertNotNull(table);
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	@Test
	public void testFooterHidden() {
		try {
			TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			Footer footer = doc.getFooter();
			Assert.assertEquals(true, footer.isVisible());
			footer.setVisible(false);
			Assert.assertEquals(false, footer.isVisible());
			doc.save(ResourceUtilities.newTestOutputFile("footerHiddenOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	@Test
	public void testGetOdfElement() {
		try {
			//TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			StyleFooterElement footerEle = footer.getOdfElement();
			footerEle.setTextContent("hello world");
			Assert.assertEquals("hello world", footerEle.getTextContent());

			//save
			//doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testAddtable() {
		try {
			//TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			Table tab = footer.addTable();
			Assert.assertNotNull(tab);
			Assert.assertTrue(2 == tab.getRowCount());
			Assert.assertTrue(5 == tab.getColumnCount());
			
			TableTableElement tabEle = tab.getOdfElement();
			System.out.println(tabEle);
			
			//save
			//doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testGetTableList() {
		try {
			//TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			Table tab = footer.addTable();
			
			List<Table> tabList = footer.getTableList();
			Assert.assertEquals(tab, tabList.get(0));
			
			//save
			//doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testGetTableBuilder() {
		try {
			//TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			//Table tab = footer.addTable();
			
			TableBuilder tb = footer.getTableBuilder();
			Table tab = tb.newTable();
			
			Assert.assertNotNull(tab);
			Assert.assertTrue(2 == tab.getRowCount());
			Assert.assertTrue(5 == tab.getColumnCount());
			
			//save
			doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testGetVariableContainerElement() {
		try {
			//TextDocument doc = TextDocument.loadDocument(ResourceUtilities.getTestResourceAsStream("headerFooterHidden.odt"));
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			OdfElement odfEle = footer.getVariableContainerElement();
			
			TableBuilder tb = footer.getTableBuilder();
			Table tab = tb.newTable();
			
			Assert.assertNotNull(tab);
			Assert.assertTrue(2 == tab.getRowCount());
			Assert.assertTrue(5 == tab.getColumnCount());
			
			Node nod = odfEle.getFirstChild();
			Assert.assertEquals("table:table", nod.getNodeName());
			
			//save
			doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testDeclareVariable() {
		try {
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			footer.declareVariable("footername", VariableType.USER);
			
			//validate
			StyleFooterElement styleFoot = footer.getOdfElement();
			Node nod = styleFoot.getFirstChild().getFirstChild();
			NamedNodeMap nameMap = nod.getAttributes();
			Node nodtext = nameMap.getNamedItem("text:name");
			Assert.assertEquals("footername", nodtext.getNodeValue());
			
			//save
			doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}
	
	
	@Test
	public void testGetVariableFieldByName() {
		try {
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			footer.declareVariable("footername", VariableType.USER);
			VariableField vField = footer.getVariableFieldByName("footername");
			String vName = vField.getVariableName();
			
			//validate
			StyleFooterElement styleFoot = footer.getOdfElement();
			Node nod = styleFoot.getFirstChild().getFirstChild();
			NamedNodeMap nameMap = nod.getAttributes();
			Node nodtext = nameMap.getNamedItem("text:name");
			Assert.assertEquals(vName, nodtext.getNodeValue());
			
			//save
			//doc.save(ResourceUtilities.newTestOutputFile("footerOutput.odt"));
		} catch (Exception e) {
			Logger.getLogger(FooterTest.class.getName()).log(Level.SEVERE, null, e);
			Assert.fail(e.getMessage());
		}
	}

	@Test
	public void testAppendNewSection() {
		try {
			TextDocument doc = TextDocument.newTextDocument();
			Footer footer = doc.getFooter();
			Section sect = footer.appendSection("Section1");
			Assert.assertNotNull(sect);

			StyleFooterElement styleFoot = footer.getOdfElement();
			Node nod = styleFoot.getFirstChild();
			NamedNodeMap nameMap = nod.getAttributes();
			Node nodtext = nameMap.getNamedItem("text:name");
			Assert.assertEquals("Section1", nodtext.getNodeValue());

		} catch (Exception e) {
			Logger.getLogger(HeaderTest.class.getName()).log(Level.SEVERE,
					null, e);
			Assert.fail(e.getMessage());
		}

	}
}