OfficeImageFillFormat
Inheritance: java.lang.Object
public abstract class OfficeImageFillFormat<TWatermarkableImage>
Represents the image fill format settings in any supported office content.
TWatermarkableImage : The exact type of the watermarkable image that is used as background.
Constructors
| Constructor | Description |
|---|---|
| OfficeImageFillFormat() |
Methods
| Method | Description |
|---|---|
| getTileAsTexture() | Gets a value indicating whether the image is tiled across the background. |
| setTileAsTexture(boolean value) | Sets a value indicating whether the image is tiled across the background. |
| getTransparency() | Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| setTransparency(double value) | Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(TWatermarkableImage value) | Sets the background image. |
| checkIfBackgroundImageIsSet() |
OfficeImageFillFormat()
public OfficeImageFillFormat()
getTileAsTexture()
public abstract boolean getTileAsTexture()
Gets a value indicating whether the image is tiled across the background.
Returns: boolean - True if the image is tiled across the background; otherwise, false (the image is stretched).
setTileAsTexture(boolean value)
public abstract void setTileAsTexture(boolean value)
Sets a value indicating whether the image is tiled across the background.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | 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: double - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
setTransparency(double value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | double | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
getBackgroundImage()
public abstract TWatermarkableImage getBackgroundImage()
Gets the background image.
Returns: TWatermarkableImage - The background image. Returns null if the image is not set.
setBackgroundImage(TWatermarkableImage value)
public abstract void setBackgroundImage(TWatermarkableImage value)
Sets the background image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TWatermarkableImage | The background image. Returns null if the image is not set. |
checkIfBackgroundImageIsSet()
public final void checkIfBackgroundImageIsSet()