狙い・効果

マスクの不透明度マスクの不透明度を指定します。

処理の概要

マスクの色を指定して指定矩形内を塗りつぶすとき、不透明度についてコマンドライン引数を用いて指定します。3.1.1 マスクの色とは異なり、透明度を指定したことが分かりやすいよう、何も削除しないよう指定しています。（詳細は3.2 削除する対象を参照してください。）このプログラムでは削除指定をしていませんが、この機能の応用例として、マスクを用いて要素を削除した部分を透明にすることでそこに元々何もなかったように加工できます。

『PDF Tool API』の主な機能

PtlParamSetMask.APIsetOpacity(float opacity): マスク色の不透明度を設定

0.0から1.0の間の小数を用いて指定し、0.0が透明を、1.0が不透明を表します。

PtlParamSetMask.APIsetRemoveElement(PtlParamSetMask.REMOVE_NONE): 矩形内の何も削除しないように指定

プログラム例

package cookbook;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.IOException;

import jp.co.antenna.ptl.*;

public class SetMaskColorWithOpacity {

    // そのクラスのusageを表示する関数
    private static void printUsage() {
            System.out.println("usage: java SetMaskColor in-pdf-file out-pdf-file" +
                               " page-num colorR colorG colorB opacity");
    }

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        if (args.length < 7) {
            printUsage();
            return;
        }

        // コマンドライン引数の読み取り
        float colorR = Float.parseFloat(args[3]);
        float colorG = Float.parseFloat(args[4]);
        float colorB = Float.parseFloat(args[5]);
        float opacity = Float.parseFloat(args[6]);
        if((opacity < 0) || (1 < opacity)) {
            System.out.println("opacity は0から1の間の小数値を指定してください。");
            printUsage();
            return;
        }

        try (PtlParamInput inputFile = new PtlParamInput(args[0]);
             PtlParamOutput outputFile = new PtlParamOutput(args[1]);
             PtlPDFDocument doc = new PtlPDFDocument();
             BufferedReader br = new BufferedReader(new InputStreamReader(System.in))) {
            // PDFファイルをロード
            doc.load(inputFile);

            // コマンドライン引数の判定
            int pageToAdd = Integer.parseInt(args[2]);
            int numPages = doc.getPageCount();
            System.out.println("ページ数：" + numPages);
            if((numPages < 0)||(numPages < pageToAdd))
            {
                System.err.println("page-numは入力PDFの全ページ数よりも小さい正の値を" +
                                   "指定してください。");
                return;
            }

            try (PtlPages pages = doc.getPages()) {// ページコンテナの取得
                // ページコンテナが空かどうか
                if (pages.isEmpty()) {
                    System.out.println("ページコンテナが空\n");
                    return;
                }

                // ページの取得(パラメータindexは0が先頭のため1を引く)
                try (PtlPage page = pages.get(pageToAdd - 1);
                     PtlParamSetMask paramSetMask = new PtlParamSetMask();
                     // 矩形の形を指定
                     PtlRect rect = new PtlRect(setRectCoordinate(br));
                     // 矩形の色を指定
                     PtlColorDeviceRGB color = new PtlColorDeviceRGB(colorR,
                                                                     colorG,
                                                                     colorB)) {
                    // マスク色の不透明度を設定
                    paramSetMask.setOpacity(opacity);

                    // マスク設定
                    paramSetMask.appendRect(rect);
                    paramSetMask.setMaskColor(color);
                    paramSetMask.setRemoveElement(PtlParamSetMask.REMOVE_NONE);
                    page.setMask(paramSetMask);
                }
            }

            // ファイルに保存します。
            doc.save(outputFile);
        }

	...【ExtractText.javaと同じ処理のため省略
	　・エラーメッセージ処理と出力】...

    }

    /**
     * 矩形の各値を入力してその座標値をもつ矩形を返す関数。
     * 原点はPDFの左下端。
     * bottomよりtopが大きい、leftよりもrightが大きいなどの矛盾した数値は入力できない。
     * 特に外部からの呼び出しを想定しないためprivateとする。
     * 
     * @param br BufferedReader。数値の読み取りに使う。
     * @return 指定したleft, bottom, right, topの数値を持つPtlRect
     */
    private static PtlRect setRectCoordinate(BufferedReader br)
        throws IOException, PtlException, Exception, Error {

	...【SetMaskColor.javaと同じ処理のため省略】...

        }                   
        return outputRect;
    }
}

プログラムファイル名

SetMaskColorWithOpacity.java

入出力操作の例

C:\samples>java cookbook.SetMaskColorWithOpacity 
usage: java SetMaskColor in-pdf-file out-pdf-file page-num colorR colorG colorB opacity

C:\samples>java cookbook.SetMaskColorWithOpacity novelText.pdf SetMaskColorWithOpacity.pdf 1 1 0 0 0.5 
ページ数：2
配置矩形の各数値を入力してください。
top (mm) : 200
bottom (mm) : 150
left (mm) : 40
right (mm) : 90 : 
-- 完了 --

指定した矩形領域を半透明の赤で塗りつぶします。テキストは削除しないで矩形の塗りつぶしのみ行っています。