com.cete.dynamicpdf.pageelements.forms
Class SignaturePanel

java.lang.Object
  com.cete.dynamicpdf.pageelements.forms.SignaturePanel

public class SignaturePanel
extends java.lang.Object

Represents a panel in the visible signature. Visible signature area will be divides in to three panels. Left or Top panel, Right or Bottom Panel and Full panel.

Method Summary

java.lang.String	getCustomMessage() Gets a string for the custom message.
boolean	getFitImage() Gets a value for resizing the given image to get fit with the panel area.
int	getFontSize() Gets a int indicating the font size.
ImageData	getImageData() Gets imaging.ImageData.
boolean	getKeepImageProportional() Gets a value for maintaining image proportion when FitImage is set to true.
boolean	getKeepImagePropotional() Deprecated. as of DynamicPDF v8.0.0 replaced by getKeepImageProportional()
boolean	getShowDate() Gets a value indicating if the full date of signing should be displayed.
boolean	getShowDigitallySignedBy() Gets a value indicating if 'Digitally Signed By {Subject name}' should be displayed.
boolean	getShowDistinguishedName() Gets a value indicating if the distinguished name (Certificate Subject) should be displayed.
boolean	getShowLabels() Gets a value indicating if the signature information should include a label.
boolean	getShowLocation() Gets a value indicating display of location.
boolean	getShowReason() Gets a value indicating if the reason should be displayed.
boolean	getShowSubjectName() Gets a value indicating if the Subject Name from the certificate should be displayed.
TextAlign	getTextAlign() Gets the TextAlign enum that specifies the text align inside the panel.
Color	getTextColor() Gets text color.
boolean	getTextRightToLeft() Gets a value indicating if text should be displayed right to left.
void	hideAllText() Hides all text visibility for the panel.
void	setCustomMessage(java.lang.String value) Sets a string for the custom message.
void	setFitImage(boolean value) Sets a value for resizing the given image to get fit with the panel area.
void	setFontSize(int value) Sets a int indicating the font size.
void	setImage(byte[] data) Sets the image to the panel.
void	setImage(ImageData imageData) Sets the image to the panel.
void	setImage(java.lang.String filePath) Sets the image to the panel.
void	setImageData(ImageData value) Sets imaging.ImageData.
void	setKeepImageProportional(boolean value) Sets a value for maintaining image proportion when setFitImage(String value) is set to true.
void	setKeepImagePropotional(boolean value) Deprecated. as of DynamicPDF v8.0.0 replaced by setKeepImageProportional(boolean)
void	setShowDate(boolean value) Sets a value indicating if the full date of signing should be displayed.
void	setShowDigitallySignedBy(boolean value) Sets a value indicating if 'Digitally Signed By {Subject name}' should be displayed.
void	setShowDistinguishedName(boolean value) Sets a value indicating if the distinguished name (Certificate Subject) should be displayed.
void	setShowLabels(boolean value) Sets a value indicating if the signature information should include a label.
void	setShowLocation(boolean value) Sets a value indicating display of location.
void	setShowReason(boolean value) Sets a value indicating if the reason should be displayed.
void	setShowSubjectName(boolean value) Sets a value indicating if the Subject Name from the certificate should be displayed.
void	setTextAlign(TextAlign value) Sets the TextAlign enum that specifies the text align inside the panel.
void	setTextColor(Color value) Sets text color.
void	setTextRightToLeft(boolean value) Sets a value indicating if text should be displayed right to left.

Methods inherited from class java.lang.Object

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

Method Detail

hideAllText

public void hideAllText()

Hides all text visibility for the panel. Signature.hideAllText() for hiding all the text in all the panels. Custom message string will also set to null.

See Also:

Signature.hideAllText()

setImage

public void setImage(java.lang.String filePath)
              throws java.io.FileNotFoundException

Sets the image to the panel.

Throws:

java.io.FileNotFoundException - if the file is not present.

Parameters:

filePath - Full path of the image file.

setImage

public void setImage(byte[] data)

Sets the image to the panel.

Parameters:

data - Byte array containing a valid image data.

setImage

public void setImage(ImageData imageData)

Sets the image to the panel.

Parameters:

imageData - Instance of ImageData.

getShowLabels

public boolean getShowLabels()

Gets a value indicating if the signature information should include a label. Default is true. Disabling this option will cause a new line for each information item.

Returns:

true the signature information included a label otherwise false.

setShowLabels

public void setShowLabels(boolean value)

Sets a value indicating if the signature information should include a label.

Parameters:

value - A boolean value specifying if the signature information should include a label. Default is true. Disabling this option will cause a new line for each information item.

getTextRightToLeft

public boolean getTextRightToLeft()

Gets a value indicating if text should be displayed right to left. Default is false.

Returns:

right to left value of the panel.

setTextRightToLeft

public void setTextRightToLeft(boolean value)

Sets a value indicating if text should be displayed right to left.

Parameters:

value - A boolean value specifying if text should be displayed right to left. Default is false.

getShowDistinguishedName

public boolean getShowDistinguishedName()

Gets a value indicating if the distinguished name (Certificate Subject) should be displayed. Default - true[only for Right or Bottom]. Label for this information is DN.

Returns:

distinguished name property fo the panel.

setShowDistinguishedName

public void setShowDistinguishedName(boolean value)

Sets a value indicating if the distinguished name (Certificate Subject) should be displayed.

Parameters:

value - A boolean value specifying if the distinguished name (Certificate Subject) should be displayed. Default - true[only for Right or Bottom]. Label for this information is DN.

getShowSubjectName

public boolean getShowSubjectName()

Gets a value indicating if the Subject Name from the certificate should be displayed. Default - true[only for Left or Top]. There is no label for this.

Returns:

the show subject name property of the panel.

setShowSubjectName

public void setShowSubjectName(boolean value)

Sets a value indicating if the Subject Name from the certificate should be displayed.

Parameters:

value - A boolean value specifying if the Subject Name from the certificate should be displayed. Default - true[only for Left or Top]. There is no label for this.

getShowDate

public boolean getShowDate()

Gets a value indicating if the full date of signing should be displayed. Default - true[only for the right or bottom panel].

Returns:

the show date property of the panel.

setShowDate

public void setShowDate(boolean value)

Sets a value indicating if the full date of signing should be displayed.

Parameters:

value - A boolean value specifying if the full date of signing should be displayed. Default - true[only for the right or bottom panel].

getShowDigitallySignedBy

public boolean getShowDigitallySignedBy()

Gets a value indicating if 'Digitally Signed By {Subject name}' should be displayed. Default - true[only for the right or bottom panel].

Returns:

the show Show digitally signed by property of the panel.

setShowDigitallySignedBy

public void setShowDigitallySignedBy(boolean value)

Sets a value indicating if 'Digitally Signed By {Subject name}' should be displayed.

Parameters:

value - A boolean value specifying if 'Digitally Signed By {Subject name}' should be displayed. Default - true[only for the right or bottom panel].

getShowReason

public boolean getShowReason()

Gets a value indicating if the reason should be displayed. Default - true[only for the right or bottom panel]. It also requires Signature.setReason(String value) should be set.

Returns:

Show reason property of the panel.

See Also:

Signature.setReason(String value)

setShowReason

public void setShowReason(boolean value)

Sets a value indicating if the reason should be displayed.

Parameters:

value - A boolean value specifying if the reason should be displayed. Default - true[only for the right or bottom panel]. It also requires Signature.setReason(String value) should be set.

See Also:

Signature.setReason(String value)

getShowLocation

public boolean getShowLocation()

Gets a value indicating display of location. Default - true[only for the right or bottom panel]. It also requires Signature.setLocation(String value) should be set.

Returns:

show location property of the panel.

See Also:

Signature.setLocation(String value)

setShowLocation

public void setShowLocation(boolean value)

Sets a value indicating display of location.

Parameters:

value - A boolean value specifying display of location. Default - true[only for the right or bottom panel]. It also requires Signature.setLocation(String value) should be set.

See Also:

Signature.setLocation(String value)

getKeepImagePropotional

public boolean getKeepImagePropotional()

Deprecated. as of DynamicPDF v8.0.0 replaced by getKeepImageProportional()

Gets a value for maintaining image proportion when FitImage is set to true. Default is true.

Returns:

the keep image proportional property of the panel.

See Also:

setFitImage(boolean value)

setKeepImagePropotional

public void setKeepImagePropotional(boolean value)

Deprecated. as of DynamicPDF v8.0.0 replaced by setKeepImageProportional(boolean)

Sets a value for maintaining image proportion when setFitImage(String value) is set to true.

Parameters:

value - A boolean value specifying for maintaining image proportion. Default is true.

See Also:

setFitImage(boolean value)

getKeepImageProportional

public boolean getKeepImageProportional()

Gets a value for maintaining image proportion when FitImage is set to true. Default is true.

Returns:

the keep image proportional property of the panel.

See Also:

setFitImage(boolean value)

setKeepImageProportional

public void setKeepImageProportional(boolean value)

Sets a value for maintaining image proportion when setFitImage(String value) is set to true.

Parameters:

value - A boolean value specifying for maintaining image proportion. Default is true.

See Also:

setFitImage(boolean value)

getFitImage

public boolean getFitImage()

Gets a value for resizing the given image to get fit with the panel area. Default is true.

Returns:

the fit image property of the panel.

setFitImage

public void setFitImage(boolean value)

Sets a value for resizing the given image to get fit with the panel area.

Parameters:

value - A boolean value specifying for resizing the given image to get fit with the panel area. Default is true.

getFontSize

public int getFontSize()

Gets a int indicating the font size. By assiging a value more than zero, will override automatic font size adjustment to make the best fit of text in the panel.

Returns:

font size of the panel.

setFontSize

public void setFontSize(int value)

Sets a int indicating the font size.

Parameters:

value - A boolean value specifying the font size. By assiging a value more than zero, will override automatic font size adjustment to make the best fit of text in the panel.

getCustomMessage

public java.lang.String getCustomMessage()

Gets a string for the custom message. Will be get append at the end of the message relavent to the panel.

Returns:

the custom message of the panel.

setCustomMessage

public void setCustomMessage(java.lang.String value)

Sets a string for the custom message.

Parameters:

value - A string value specifying for the custom message. Will be get append at the end of the message relavent to the panel.

getTextAlign

public TextAlign getTextAlign()

Gets the TextAlign enum that specifies the text align inside the panel. Default will be left align.

Returns:

the text align property of the panel.

See Also:

TextAlign

setTextAlign

public void setTextAlign(TextAlign value)

Sets the TextAlign enum that specifies the text align inside the panel.

Parameters:

value - instance of TextAlign. Default will be left align.

See Also:

TextAlign

getImageData

public ImageData getImageData()

Gets imaging.ImageData.

Returns:

image data of the panel.

See Also:

ImageData

setImageData

public void setImageData(ImageData value)

Sets imaging.ImageData.

Parameters:

value - instance of ImageData.

See Also:

ImageData

getTextColor

public Color getTextColor()

Gets text color.

Returns:

the text color of the panel.

setTextColor

public void setTextColor(Color value)

Sets text color.

Parameters:

value - instance of Color.