com.groupdocs.watermark.contents

Class OfficeImageFillFormat<TWatermarkableImage extends WatermarkableImage>

java.lang.Object

com.groupdocs.watermark.contents.OfficeImageFillFormat<TWatermarkableImage>

Direct Known Subclasses:

PresentationImageFillFormat, SpreadsheetImageFillFormat, WordProcessingImageFillFormat

public abstract class OfficeImageFillFormat<TWatermarkableImage extends WatermarkableImage>
extends Object

Represents the image fill format settings in any supported office content.

TWatermarkableImage: The exact type of the watermarkable image that is used as background.

Constructor Summary

Constructors

Constructor and Description
OfficeImageFillFormat()

Method Summary

Modifier and Type	Method and Description
void	checkIfBackgroundImageIsSet()
abstract TWatermarkableImage	getBackgroundImage() Gets the background image.
abstract boolean	getTileAsTexture() Gets a value indicating whether the image is tiled across the background.
abstract double	getTransparency() Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
abstract void	setBackgroundImage(TWatermarkableImage value) Sets the background image.
abstract void	setTileAsTexture(boolean value) Sets a value indicating whether the image is tiled across the background.
abstract void	setTransparency(double value) Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OfficeImageFillFormat

public OfficeImageFillFormat()

Method Detail

checkIfBackgroundImageIsSet

public final void checkIfBackgroundImageIsSet()

getBackgroundImage

public abstract TWatermarkableImage getBackgroundImage()

Gets the background image.

Returns:

The background image. Returns null if the image is not set.

getTileAsTexture

public abstract boolean getTileAsTexture()

Gets a value indicating whether the image is tiled across the background.

Returns:

True if the image is tiled across the background; otherwise, false (the image is stretched).

getTransparency

public abstract double getTransparency()

Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Returns:

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

setBackgroundImage

public abstract void setBackgroundImage(TWatermarkableImage value)

Sets the background image.

Parameters:

value - The background image. Returns null if the image is not set.

setTileAsTexture

public abstract void setTileAsTexture(boolean value)

Sets a value indicating whether the image is tiled across the background.

Parameters:

value - True if the image is tiled across the background; otherwise, false (the image is stretched).

setTransparency

public abstract void setTransparency(double value)

Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Parameters:

value - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).