org.docx4j.convert.out.html.BookmarkStartWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docx4j-core Show documentation

docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.

There is a newer version: 11.4.11

Show newest version

/*
 *  Copyright 2009, Plutext Pty Ltd.
 *   
 *  This file is part of docx4j.

    docx4j is licensed 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.docx4j.convert.out.html;

import javax.xml.transform.TransformerException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.docx4j.Docx4jProperties;
import org.docx4j.convert.out.common.AbstractWmlConversionContext;
import org.docx4j.convert.out.common.writer.AbstractBookmarkStartWriter;
import org.docx4j.wml.CTBookmark;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/** Generate a reference so that the w:bookmarkStart it can be referenced.

 *  The preprocessing step BookmarkMover should have moved any Bookmarks 
 *  to the beginning of a paragraph, therefore an inline should always work.
 */
public class BookmarkStartWriter extends AbstractBookmarkStartWriter {
	
	private final static Logger log = LoggerFactory.getLogger(BookmarkStartWriter.class);
	
	private static String mapTo;
	
	static {
		mapTo = Docx4jProperties.getProperty("docx4j.Convert.Out.HTML.BookmarkStartWriter.mapTo", "a");
	}
	
	public BookmarkStartWriter() {
		super();
	}

	@Override
	public Node toNode(AbstractWmlConversionContext context, Object unmarshalledNode, 
			Node modelContent, TransformState state, Document doc)
			throws TransformerException {
		
		if (mapTo.equals("id")) {
			
			CTBookmark modelData = (CTBookmark)unmarshalledNode;
			((HTMLConversionContext)context).setBookmarkStart(modelData);
			return null;
			
		} else if (mapTo.equals("null")) {

			// do nothing
			return null;
			
		} else {
		
			// the default
			CTBookmark modelData = (CTBookmark)unmarshalledNode;
			Element ret = doc.createElement("a");
			ret.setAttribute("name", modelData.getName());
			return ret;
		}
  }
  
}