com.digisigner.api
Class SignatureAppearanceData

java.lang.Object
  extended by com.digisigner.api.SignatureAppearanceData

public class SignatureAppearanceData
extends Object

Allows to customize the appearance for your visible signature. The default signature appearance consists of two parts, left and right:

 ---------------------------------------------------
 |    Left part           |     Right part         |
 |                        |                        |
 |    Can be              |     Can be             |
 |     - your name        |      - your name       |
 |     - graphic          |      - graphic         |
 |     - signature text   |      - signature text  |
 |                        |                        |
 ---------------------------------------------------
Each of these parts can be your name (which is the common name from your certificate), a graphic or signature text, which contains information like signature reason, signer name, date etc.
You can also hide one of the parts. The other part will then take up the whole space of the signature.

Author:
DigiSigner Software

Nested Class Summary
static class SignatureAppearanceData.SignaturePartData
          Allows to customize a particular signature part.
 
Constructor Summary
SignatureAppearanceData()
           
 
Method Summary
 SignatureAppearanceData.SignaturePartData getLeftPartData()
          Returns appearance data for the left part of the signature.
 String getLogoFilename()
          Returns the file name of the logo image in background of the signature.
 SignatureAppearanceData.SignaturePartData getRightPartData()
          Returns appearance data for the right part of the signature.
 boolean isShowDate()
          Indicates if the date is included in the signature text.
 boolean isShowDistinguishedName()
          Indicates if the distinguished name is included in the signature text.
 boolean isShowFrame()
          Indicates if there will be a frame painted around the signature field.
 boolean isShowLabels()
          Indicates if labels are included in the signature text.
 boolean isShowLocation()
          Indicates if the location is included in the signature text.
 boolean isShowLogo()
          Indicates if the logo is shown.
 boolean isShowName()
          Indicates if the signer name is included in the signature text.
 boolean isShowReason()
          Indicates if the reason is included in the signature text.
 void setLeftPartData(SignatureAppearanceData.SignaturePartData leftPartData)
          Sets appearance data for the left part of the signature.
 void setLogoFilename(String logoFilename)
          Specifies the file name with the logo image.
 void setRightPartData(SignatureAppearanceData.SignaturePartData rightPartData)
          Sets appearance data for the right part of the signature.
 void setShowDate(boolean showDate)
          Sets if the date is included in the signature text.
 void setShowDistinguishedName(boolean showDistinguishedName)
          Sets if the distinguished name is included in the signature text.
 void setShowFrame(boolean showFrame)
          Sets if there will be a frame painted around the signature field.
 void setShowLabels(boolean showLabels)
          Sets if labels (like "Location:", "Date:") are included in the signature text.
 void setShowLocation(boolean showLocation)
          Sets if the location is included in the signature text.
 void setShowLogo(boolean showLogo)
          Sets if the logo is shown.
 void setShowName(boolean showName)
          Sets if the signer name is included in the signature text.
 void setShowReason(boolean showReason)
          Sets if the reason is included in the signature text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SignatureAppearanceData

public SignatureAppearanceData()
Method Detail

getLeftPartData

public SignatureAppearanceData.SignaturePartData getLeftPartData()
Returns appearance data for the left part of the signature.

Returns:
left part of the signature

setLeftPartData

public void setLeftPartData(SignatureAppearanceData.SignaturePartData leftPartData)
Sets appearance data for the left part of the signature.

Parameters:
leftPartData - left part of the signature

getRightPartData

public SignatureAppearanceData.SignaturePartData getRightPartData()
Returns appearance data for the right part of the signature.

Returns:
right part of the signature

setRightPartData

public void setRightPartData(SignatureAppearanceData.SignaturePartData rightPartData)
Sets appearance data for the right part of the signature.

Parameters:
rightPartData - right part of the signature

isShowName

public boolean isShowName()
Indicates if the signer name is included in the signature text.

Returns:
flag indicating if the signer name is shown in signature text

setShowName

public void setShowName(boolean showName)
Sets if the signer name is included in the signature text.

Parameters:
showName - flag indicating if the signer name is shown in signature text

isShowReason

public boolean isShowReason()
Indicates if the reason is included in the signature text.

Returns:
flag indicating if reason is shown in signature text

setShowReason

public void setShowReason(boolean showReason)
Sets if the reason is included in the signature text.

Parameters:
showReason - flag indicating if reason is shown in signature text

isShowLocation

public boolean isShowLocation()
Indicates if the location is included in the signature text.

Returns:
flag indicating if location is shown in signature text

setShowLocation

public void setShowLocation(boolean showLocation)
Sets if the location is included in the signature text.

Parameters:
showLocation - flag indicating if location is shown in signature text

isShowDate

public boolean isShowDate()
Indicates if the date is included in the signature text.

Returns:
flag indicating if date is shown in signature text

setShowDate

public void setShowDate(boolean showDate)
Sets if the date is included in the signature text.

Parameters:
showDate - flag indicating if date is shown in signature text

isShowDistinguishedName

public boolean isShowDistinguishedName()
Indicates if the distinguished name is included in the signature text.

Returns:
flag indicating if distinguished name is shown in signature text

setShowDistinguishedName

public void setShowDistinguishedName(boolean showDistinguishedName)
Sets if the distinguished name is included in the signature text. Default is false.

Parameters:
showDistinguishedName - flag indicating if distinguished name is shown in signature text

isShowLabels

public boolean isShowLabels()
Indicates if labels are included in the signature text.

Returns:
flag indicating if labels are shown in signature text

setShowLabels

public void setShowLabels(boolean showLabels)
Sets if labels (like "Location:", "Date:") are included in the signature text. Default is true.

Parameters:
showLabels - flag indicating if labels are shown in signature text

isShowFrame

public boolean isShowFrame()
Indicates if there will be a frame painted around the signature field.

Returns:
flag indicating if the signature is frame is painted around the signature

setShowFrame

public void setShowFrame(boolean showFrame)
Sets if there will be a frame painted around the signature field.

Parameters:
showFrame - flag indicating if the signature is frame is painted around the signature

getLogoFilename

public String getLogoFilename()
Returns the file name of the logo image in background of the signature.

Returns:
logo file name

setLogoFilename

public void setLogoFilename(String logoFilename)
Specifies the file name with the logo image. This image will be painted in the background of the signature.

Parameters:
logoFilename - logo file name

isShowLogo

public boolean isShowLogo()
Indicates if the logo is shown.

Returns:
flag indicating if logo is displayed in the background

setShowLogo

public void setShowLogo(boolean showLogo)
Sets if the logo is shown. Default is false.

Parameters:
showLogo - flag indicating if logo is displayed in the background