org.apache.fop.render.rtf.rtflib.rtfdoc.RtfBookmark Maven / Gradle / Ivy
/*
* 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.
*/
/* $Id: RtfBookmark.java 1805173 2017-08-16 10:50:04Z ssteiner $ */
package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
* created by Bertrand Delacretaz [email protected] and by other
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
import java.io.IOException;
import java.io.Writer;
/**
* RTF Bookmark.
* Create an RTF bookmark as a child of given container with default attributes.
* This class belongs to the "id" attribute processing.
*
* This work was authored by Andreas Putz ([email protected]).
*/
public class RtfBookmark extends RtfElement {
//////////////////////////////////////////////////
// @@ Members
//////////////////////////////////////////////////
/** Name of the bokkmark */
private String bookmark;
/** Word 2000 supports a length of 40 characters only */
public static final int MAX_BOOKMARK_LENGTH = 40;
/** Word 2000 converts '.' in bookmarks to "_", thats why we control this replacement. */
public static final char REPLACE_CHARACTER = '_';
//////////////////////////////////////////////////
// @@ Construction
//////////////////////////////////////////////////
/**
* Constructor.
*
* @param parent a RtfBookmarkContainer value
* @param writer a Writer value
* @param bookmark Name of the bookmark
*/
RtfBookmark(RtfContainer parent, Writer writer, String bookmark) throws IOException {
super(parent, writer);
int now = bookmark.length();
this.bookmark = bookmark.substring(0,
now < MAX_BOOKMARK_LENGTH ? now : MAX_BOOKMARK_LENGTH);
this.bookmark = this.bookmark.replace('.', REPLACE_CHARACTER);
this.bookmark = this.bookmark.replace(' ', REPLACE_CHARACTER);
}
//////////////////////////////////////////////////
// @@ RtfElement implementation
//////////////////////////////////////////////////
/**
* Is called before writing the Rtf content.
*
* @throws IOException On Error
*/
public void writeRtfPrefix() throws IOException {
startBookmark();
}
/**
* Writes the RTF content to m_writer.
*
* @exception IOException On error
*/
public void writeRtfContent() throws IOException {
// this.getRtfFile ().getLog ().logInfo ("Write bookmark '" + bookmark + "'.");
// No content to write
}
/**
* Is called after writing the Rtf content.
*
* @throws IOException On Error
*/
public void writeRtfSuffix() throws IOException {
endBookmark();
}
//////////////////////////////////////////////////
// @@ Private methods
//////////////////////////////////////////////////
/**
* Writes RTF content to begin the bookmark.
*
* @throws IOException On error
*/
private void startBookmark() throws IOException {
// {\*\bkmkstart test}
writeRtfBookmark("bkmkstart");
}
/**
* Writes RTF content to close the bookmark.
*
* @throws IOException On error
*/
private void endBookmark() throws IOException {
// {\*\bkmkend test}
writeRtfBookmark("bkmkend");
}
/**
* Writes the rtf bookmark.
*
* @param tag Begin or close tag
*
* @throws IOException On error
*/
private void writeRtfBookmark(String tag) throws IOException {
if (bookmark == null) {
return;
}
this.writeGroupMark(true);
//changed. Now using writeStarControlWord
this.writeStarControlWord(tag);
writer.write(bookmark);
this.writeGroupMark(false);
}
/**
* @return true if this element would generate no "useful" RTF content
*/
public boolean isEmpty() {
return bookmark == null || bookmark.trim().length() == 0;
}
}