Constructor Detail

• SignatureAppearance.Builder

  SignatureAppearance.Builder()

Method Detail

• build

  @NonNull() SignatureAppearance build()

  Build the SignatureAppearance object from the provided properties.

  Returns:

  SignatureAppearance object with values set in the builder.

• setSignatureAppearanceMode

  @NonNull() SignatureAppearance.Builder setSignatureAppearanceMode(@NonNull() SignatureAppearance.SignatureAppearanceMode signatureAppearanceMode)

  The SignatureAppearanceMode controls how the signature will be displayed. Defaults to SIGNATURE_AND_DESCRIPTION.

  Parameters:

  signatureAppearanceMode - The SignatureAppearanceMode to use.

• setShowSignerName

  @NonNull() SignatureAppearance.Builder setShowSignerName(boolean showSignerName)

  Indicates whether the name of the signer will be shown or not. Defaults to true.

  Parameters:

  showSignerName - true if the name of the signer should be shown, false otherwise.

• setShowSignDate

  @NonNull() SignatureAppearance.Builder setShowSignDate(boolean showSignDate)

  Indicates whether the date of the signature will be shown or not. Defaults to true.

  Parameters:

  showSignDate - true if the date should be shown, false otherwise.

• setShowSignatureReason

  @NonNull() SignatureAppearance.Builder setShowSignatureReason(boolean showSignatureReason)

  Indicates whether or not the reason for the signature will be shown. Defaults to false.

  Parameters:

  showSignatureReason - true if the reason should be shown, false otherwise.

• setShowSignatureLocation

  @NonNull() SignatureAppearance.Builder setShowSignatureLocation(boolean showSignatureLocation)

  Indicates whether or not the location where the signature was created will be shown. Defaults to false.

  Parameters:

  showSignatureLocation - true if the location should be shown, false otherwise.

• setSignatureGraphic

  @NonNull() SignatureAppearance.Builder setSignatureGraphic(@Nullable() SignatureAppearance.SignatureGraphic signatureGraphic)

  The SignatureGraphic can be displayed instead of the signer name. If no is set the signer name will be displayed. If you want to disable the default PSPDFKit watermark that is shown use setShowWatermark.

  Parameters:

  signatureGraphic - The SignatureGraphic to use.

• setSignatureWatermark

  @NonNull() SignatureAppearance.Builder setSignatureWatermark(@Nullable() SignatureAppearance.SignatureGraphic signatureWatermark)

  The SignatureGraphic to be displayed as the watermark. If no is set the PSPDFKit logo will be shown unless setShowWatermark is false.

  Parameters:

  signatureWatermark - The SignatureGraphic to use.

• setReuseExistingSignatureAppearanceStream

  @NonNull() SignatureAppearance.Builder setReuseExistingSignatureAppearanceStream(boolean reuseExistingSignatureAppearanceStream)

  Controls whether or not an existing appearance stream for the signature should be used. Defaults to true.

  Parameters:

  reuseExistingSignatureAppearanceStream - true if an existing appearance stream should be reused, false otherwise.

• setShowWatermark

  @NonNull() SignatureAppearance.Builder setShowWatermark(boolean showWatermark)

  Indicates whether the PSPDFKit watermark with be shown. Defaults to true.

  Parameters:

  showWatermark - true if the PSPDFKit watermark should be shown, false otherwise.

• setShowDateTimezone

  @NonNull() SignatureAppearance.Builder setShowDateTimezone(boolean showDateTimezone)

  Indicates whether the date will include the timezone, if showSignDate is true. Defaults to false.

  Returns:

  true if the signature date should include the timezone, false otherwise.