com.levigo.jadice.document.contentscreator.settings

Class ContentsCreatorTextSettings

java.lang.Object

com.levigo.jadice.document.contentscreator.settings.ContentsCreatorTextSettings

All Implemented Interfaces:

ContentsCreatorSettings, ProcessingSettings, SerializableProcessingSettings, Serializable

public class ContentsCreatorTextSettings
extends Object
implements ContentsCreatorSettings

Objects of this class keep the settings used to render text as part of a ContentsCreatorControls object. This class uses a builder-pattern for the setters to simplify the use of the setters.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContentsCreatorTextSettings() Creates a new ContentsCreatorTextSettings.

Method Summary

Modifier and Type	Method and Description
SerializableProcessingSettings	createSnapshot() Returns a deep snapshot of this settings object.
boolean	equals(Object o)
Font	getFont() Get the Font defined in this settings object
double	getFontSizeInPoint() Returns the font size with which the text controlled by these settings is displayed.
int	hashCode()
void	setFont(Font font) Set the Font to be used for the text to be displayed using these settings.
void	setFontSizeInPoint(double fontSizeInPoint) Set the font size in DTP-(PostScript-)point (1/72 inch) to be used to display the text controlled by this settings object.
ContentsCreatorTextSettings	withFont(Font font) Set the Font to be used for the text to be displayed using these settings.
ContentsCreatorTextSettings	withFontSizeInPoint(double fontSizeInPoint) Set the font size in DTP-(PostScript-)point (1/72 inch) to be used to display the text controlled by this settings object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentsCreatorTextSettings

public ContentsCreatorTextSettings()

Creates a new ContentsCreatorTextSettings.

Method Detail

getFont

public Font getFont()

Get the Font defined in this settings object

Returns:

the Font defined in this settings object

setFont

public void setFont(Font font)

Set the Font to be used for the text to be displayed using these settings.

Parameters:

font - the FontSource to be used.

Throws:

IllegalArgumentException - if the given font is null

withFont

public ContentsCreatorTextSettings withFont(Font font)

Set the Font to be used for the text to be displayed using these settings. This method implements a builder-pattern and returns the object it has been called on.

Parameters:

font - the FontSource to be used.

Returns:

This ContentsCreatorTextSettings object to allow a builder pattern.

Throws:

IllegalArgumentException - if the given font is null

getFontSizeInPoint

public double getFontSizeInPoint()

Returns the font size with which the text controlled by these settings is displayed. The actual size the text is displayed with may also be affected by the transformationSettings

Returns:

the font size used to display the text.

setFontSizeInPoint

public void setFontSizeInPoint(double fontSizeInPoint)

Set the font size in DTP-(PostScript-)point (1/72 inch) to be used to display the text controlled by this settings object. The font size must not be <= 0. The rendering of the text may also be affected by the AffineTransform

Parameters:

fontSizeInPoint - the font size in DTP-(PostScript-)point to be used

Throws:

IllegalArgumentException - if the given fontSize is <= 0

withFontSizeInPoint

public ContentsCreatorTextSettings withFontSizeInPoint(double fontSizeInPoint)

Set the font size in DTP-(PostScript-)point (1/72 inch) to be used to display the text controlled by this settings object. The font size must not be <= 0. The rendering of the text may also be affected by the AffineTransform. This method implements a builder-pattern and returns the object it has been called on.

Parameters:

fontSizeInPoint - the font size in DTP-(PostScript-)point to be used

Returns:

This ContentsCreatorTextSettings object to allow a builder pattern.

Throws:

IllegalArgumentException - if the given fontSize is <=0

createSnapshot

public SerializableProcessingSettings createSnapshot()

Returns a deep snapshot of this settings object. The snapshot then contains copies of the setting made in this object. Changing members of this object does not affect the snapshot.

Specified by:

createSnapshot in interface ProcessingSettings

Specified by:

createSnapshot in interface SerializableProcessingSettings

Returns:

A deep copy of this object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object