パッケージ jp.co.antenna.ptl

クラス PtlParamRestriction

java.lang.Object
jp.co.antenna.ptl.PtlParamRestriction
すべての実装されたインタフェース:
AutoCloseable
public class PtlParamRestriction extends Object implements AutoCloseable
PDFの閲覧制限を表現したクラスです。

  • コンストラクタの詳細

    • PtlParamRestriction

      public PtlParamRestriction() throws PtlException
      コンストラクタ
      例外:
      PtlException - 例外

    • PtlParamRestriction

      public PtlParamRestriction(PtlParamRestriction obj) throws PtlException
      コピーコンストラクタ
      パラメータ:
      obj - コピー元オブジェクト。
      例外:
      PtlException - 例外

  • メソッドの詳細

    • close

      public void close()
      終了処理。

      このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
      このオブジェクトを使い終わったら必ず呼ばなければなりません。

      定義:
      close インタフェース内 AutoCloseable

    • appendValidURL

      public void appendValidURL(String url) throws PtlException
      閲覧可能とするURLを追加。

      複数URLを閲覧可能としたい場合はこの関数を複数呼ぶことで実現できます。

      パラメータ:
      url - 閲覧可能とするURL。
      例外:
      PtlException - 例外

    • setValidTermStart

      public void setValidTermStart(PtlDate start) throws PtlException
      閲覧可能とする期間の開始日を設定。
      パラメータ:
      start - 開始日。
      例外:
      PtlException - 例外

    • setValidTermEnd

      public void setValidTermEnd(PtlDate end) throws PtlException
      閲覧可能とする期間の終了日を設定。
      パラメータ:
      end - 終了日。
      例外:
      PtlException - 例外

    • setWatermark

      public void setWatermark(PtlParamWaterMark paramWM) throws PtlException
      閲覧不可時に表示するウォーターマークを設定。

      設定しない場合は閲覧不可時に何も表示されません。

      パラメータ:
      paramWM - ウォーターマーク。
      例外:
      PtlException - 例外

    • setEnableParamWatermark

      public void setEnableParamWatermark(boolean enableParam) throws PtlException
      閲覧不可時に表示するウォーターマークのパラメータを有効にするかの設定。

      有効にすると、PtlParamWaterMarkに設定したページ範囲、setDisplayWaterMark/setPrintWaterMarkが使用されます。
      但し、閲覧制限を設定するページにのみウォーターマークは設定されます。

      パラメータ:
      enableParam - ウォーターマークに設定したパラメータを有効にするか。
      例外:
      PtlException - 例外

    • setPageRange

      public void setPageRange(PtlParamRestriction.PAGE_RANGE pageRange) throws PtlException
      閲覧制限を行うページの範囲を設定。

      PAGE_RANGE_CUSTOMを設定した場合は、setCustomPageRangeでページ範囲を設定します。

      パラメータ:
      pageRange - 閲覧制限を行うページの範囲。PAGE_RANGE_XXXのいずれか。
      例外:
      PtlException - 例外

    • setCustomPageRange

      public void setCustomPageRange(String customPageRange) throws PtlException
      閲覧制限を行うページの範囲の指定を設定。

      setPageRangeでPAGE_RANGE_CUSTOMを設定した場合のみ有効。
      例)
      "0,2-4" と指定すると、1ページと3から5ページに閲覧制限が入ります。ページは0オリジンです。

      パラメータ:
      customPageRange - 閲覧制限を行うページの範囲の指定。
      例外:
      PtlException - 例外