com.lowagie.text.rtf.field.RtfAnchor Maven / Gradle / Ivy
/*
* $Id: RtfAnchor.java 3580 2008-08-06 15:52:00Z howard_s $
*
* Copyright 2004 by Mark Hall
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.rtf.field;
import java.io.IOException;
import java.io.OutputStream;
import com.lowagie.text.Anchor;
import com.lowagie.text.DocWriter;
import com.lowagie.text.rtf.document.RtfDocument;
import com.lowagie.text.rtf.text.RtfPhrase;
/**
* The RtfAnchor is the RTF representation of an Anchor object.
*
* @version $Id: RtfAnchor.java 3580 2008-08-06 15:52:00Z howard_s $
* @author Mark Hall ([email protected])
* @author Werner Daehn ([email protected])
* @author Thomas Bickel ([email protected])
*/
public class RtfAnchor extends RtfField
{
/**
* Constant for a hyperlink
*/
private static final byte[] HYPERLINK = DocWriter.getISOBytes("HYPERLINK");
/**
* The url of this RtfAnchor
*/
private String url = "";
/**
* The RtfPhrase to display for the url
*/
private RtfPhrase content = null;
/**
* Constructs a RtfAnchor based on a RtfField
*
* @param doc The RtfDocument this RtfAnchor belongs to
* @param anchor The Anchor this RtfAnchor is based on
*/
public RtfAnchor(RtfDocument doc, Anchor anchor) {
super(doc);
this.url = anchor.getReference();
this.content = new RtfPhrase(doc, anchor);
}
/**
* Write the field instructions for this RtfAnchor. Sets the field
* type to HYPERLINK and then writes the url.
*
* @param result The OutputStream to write to.
* @throws IOException on i/o errors.
*/
protected void writeFieldInstContent(OutputStream result) throws IOException
{
result.write(HYPERLINK);
result.write(DELIMITER);
this.document.filterSpecialChar(result, url, true, true);
}
/**
* Write the field result for this RtfAnchor. Writes the content
* of the RtfPhrase.
*
* @param result The OutputStream to write to.
* @throws IOException on i/o errors.
*/
protected void writeFieldResultContent(OutputStream result) throws IOException
{
content.writeContent(result);
}
}