com.oracle.outsidein.options

Class Watermark

java.lang.Object

com.oracle.outsidein.options.Watermark

public class Watermark
extends java.lang.Object

Describes a watermark image and its associated attributes.

See Also:

OptionsCache.getWatermark(), OptionsCache.setWatermark(Watermark)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Watermark.ScaleModeValue Indicates the method of scaling the watermark image.

Constructor Summary

Constructors

Constructor and Description
Watermark() Create a disabled Watermark object.
Watermark(java.io.File file, int opacity) Create a Watermark object using the specified image file and opacity.
Watermark(java.io.File file, int opacity, int verticalOffset, int horizontalOffset) Create a Watermark object using the specified image file, opacity, and offsets.

Method Summary

Methods

Modifier and Type	Method and Description
int	getHorzOffset() Obtains the horizontal distance, in twips, to move the watermark from the center.
java.io.File	getImageFile() Obtains the File object describing the watermark image.
int	getOpacity() Obtains the opacity of the watermark as a value between 0 and 255, inclusive.
int	getPercent() Obtains the scaling value of the watermark image as a percentage of the image's original size.
int	getVertOffset() Obtains the vertical distance, in twips, to move the watermark from the center.
void	setHorzOffset(int offset) Specifies the horizontal distance, in twips, to move the watermark from the center.
void	setImageFile(java.io.File file) Specifies the File object describing the watermark image.
void	setOpacity(int opacity) Specifies the opacity of the watermark as a value between 0 and 255, inclusive.
void	setPercent(int percent) Specifies the scaling value of the watermark image as a percentage of the image's original size.
void	setVertOffset(int offset) Specifies the vertical distance, in twips, to move the watermark from the center.

Methods inherited from class java.lang.Object

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

Constructor Detail

Watermark

public Watermark()

Create a disabled Watermark object. This can be used to disable watermarks.

Watermark

public Watermark(java.io.File file,
         int opacity)
          throws OutsideInException

Create a Watermark object using the specified image file and opacity.

Parameters:

file - the image file

opacity - the opacity of the watermark image as an integer between 0 and 255 inclusive (0 is disabled and 255 is fully opaque

Throws:

OutsideInException

Watermark

public Watermark(java.io.File file,
         int opacity,
         int verticalOffset,
         int horizontalOffset)
          throws OutsideInException

Create a Watermark object using the specified image file, opacity, and offsets.

Parameters:

file - the image file

opacity - the opacity of the watermark image as an integer between 0 and 255 inclusive (0 is disabled and 255 is fully opaque

verticalOffset - the vertical offset from center, in twips (negative values correspond to below center, and positive values correspond to above center)

horizontalOffset - the horizontal offset from center, in twips (negative values correspond to left of center, and positive values correspond to right of center)

Throws:

OutsideInException

Method Detail

getOpacity

public int getOpacity()

Obtains the opacity of the watermark as a value between 0 and 255, inclusive. A value of 0 means the watermark is disabled. A value of 255 is fully opaque.

Returns:

the opacity value

setOpacity

public void setOpacity(int opacity)
                throws OutsideInException

Specifies the opacity of the watermark as a value between 0 and 255, inclusive. A value of 0 means the watermark is disabled. A value of 255 is fully opaque.

Parameters:

opacity - the opacity value

Throws:

OutsideInException

getPercent

public int getPercent()

Obtains the scaling value of the watermark image as a percentage of the image's original size. This value is only used if the scaling method is set to Watermark.ScaleModeValue.PERCENT.

Returns:

the scaling value

setPercent

public void setPercent(int percent)

Specifies the scaling value of the watermark image as a percentage of the image's original size. This value is only used if the scaling method is set to Watermark.ScaleModeValue.PERCENT.

Parameters:

percent - the scaling value

getImageFile

public java.io.File getImageFile()

Obtains the File object describing the watermark image.

Returns:

the watermark file

setImageFile

public void setImageFile(java.io.File file)

Specifies the File object describing the watermark image.

Parameters:

file - the watermark file

getVertOffset

public int getVertOffset()

Obtains the vertical distance, in twips, to move the watermark from the center. Negative values correspond to below center, and positive values correspond to above center.

Returns:

the offset value in twips

setVertOffset

public void setVertOffset(int offset)

Specifies the vertical distance, in twips, to move the watermark from the center. Negative values correspond to below center, and positive values correspond to above center. The default value is 0.

Parameters:

offset - the offset value in twips

getHorzOffset

public int getHorzOffset()

Obtains the horizontal distance, in twips, to move the watermark from the center. Negative values correspond to left of center, and positive values correspond to right of center.

Returns:

the offset value in twips

setHorzOffset

public void setHorzOffset(int offset)

Specifies the horizontal distance, in twips, to move the watermark from the center. Negative values correspond to left of center, and positive values correspond to right of center. The default value is 0.

Parameters:

offset - the offset value in twips