com.mindoo.domino.jna.html.IHtmlImageRef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation

Java project to access the HCL Domino C API using Java Native Access (JNA)

There is a newer version: 0.9.53

package com.mindoo.domino.jna.html;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.util.EnumSet;

import com.mindoo.domino.jna.NotesNote.HtmlConvertOption;
import com.mindoo.domino.jna.NotesNote.IHtmlItemImageConversionCallback;

/**
 * Convenience interface to access an image that is referenced from HTML as a result
 * of a richtext-html conversion
 * 
 * @author Karsten Lehmann
 */
public interface IHtmlImageRef {

	/**
	 * Results the whole img tag URL (src attribute value)
	 * 
	 * @return relative image URL
	 */
	public String getReferenceText();
	
	/**
	 * Returns the parsed item name that contains the image
	 * 
	 * @return item name
	 */
	public String getItemName();
	
	/**
	 * Returns the item index to extract the image data from the item
	 * 
	 * @return index
	 */
	public int getItemIndex();
	
	/**
	 * Returns the item offset to extract the image data from the item
	 * 
	 * @return offset
	 */
	public int getItemOffset();
	
	/**
	 * Returns the conversion options used for the richtext-html conversion
	 * 
	 * @return conversion options
	 */
	public EnumSet getOptions();
	
	/**
	 * Method to directly access the image data
	 * 
	 * @param callback callback to receive data
	 */
	public void readImage(IHtmlItemImageConversionCallback callback);
	
	/**
	 * Convenience method to write the whole image to a file on disk
	 * 
	 * @param f file
	 * @throws IOException on case of I/O errors
	 */
	public void writeImage(File f) throws IOException;
	
	/**
	 * Convenience method to write the whole image to an output stream
	 * 
	 * @param out stream
	 * @throws IOException on case of I/O errors
	 */
	public void writeImage(OutputStream out) throws IOException;

	/**
	 * Returns the image format, either "gif" or "jpg"
	 * 
	 * @return format
	 */
	public String getFormat();
}