com.businessobjects.rebean.wi
Interface ImageOption

public interface ImageOption

The ImageOption interface contains image manipulation methods for documents opened using DocumentInstance.

Note: To activate SDK image control of document images, the variable MANAGE_IMAGES must be set to 1 in the webi.properties file.

MANAGE_IMAGES=1

Example:Setting an image callback script using ImageOption

 HTMLView htmlView = null;

 ImageOption    webiImgOpt = null;

 String sBody = "";

 PrintWriter writer = response.getWriter();

 webiImgOpt = docInstance.getImageOption(); 

 webiImgOpt.setImageCallback("imageCallback.jsp?");

 webiImgOpt.setImageNameHolder("imgName");

 webiImgOpt.setStorageTokenHolder("imgToken");

 htmlView = webiDoc.getView(OutputFormatType.HTML);

 writer.println(htmlView.getStringPart("body", false));

 

For example code that can be used in a callback file, see Image.

See Also:

DocumentInstance, OutputFormatType, CharacterView, Image

Method Summary

java.lang.String	getImageCallback() Returns the image callback asp or jsp name.
java.lang.String	getImageNameHolder() Returns the query string image name holder.
java.lang.String	getStorageTokenHolder() Returns the query string token holder.
void	setImageCallback(java.lang.String imageCallback) Provides the image callback asp or jsp page name.
void	setImageNameHolder(java.lang.String imageNameHolder) Provides the query string image name holder.
void	setStorageTokenHolder(java.lang.String storageTokenHolder) Provides the query string tokan holder.

Method Detail

getImageCallback

java.lang.String getImageCallback()

Returns the image callback asp or jsp name.

Returns:

The page called to retrieve report images.

setImageCallback

void setImageCallback(java.lang.String imageCallback)

Provides the image callback asp or jsp page name. The default value is getImages.jsp? The report engine will generate an URL like this: <IMG SRC="http:://serverName/path_info/getImages.jsp?boImgName=g000001.gif">

Parameters:

imageCallback - The jsp page called to retrieve the report images.

getImageNameHolder

java.lang.String getImageNameHolder()

Returns the query string image name holder.

Returns:

The query string image name holder.

setImageNameHolder

void setImageNameHolder(java.lang.String imageNameHolder)

Provides the query string image name holder. This is the name of the image parameter in the query string. The default image name holder is boImgName

Parameters:

imageNameHolder - The image name holder used in the query string.

getStorageTokenHolder

java.lang.String getStorageTokenHolder()

Returns the query string token holder.

Returns:

The query string token holder.

setStorageTokenHolder

void setStorageTokenHolder(java.lang.String storageTokenHolder)

Provides the query string tokan holder. This is the document token parameter in the query string.

The default token holder is boImgName

Parameters:

storageTokenHolder - The token holder used in the query string.