jp.co.antenna.ptl

クラス PtlParamSearchTextAndSetMask

java.lang.Object

jp.co.antenna.ptl.PtlParamSearchText

jp.co.antenna.ptl.PtlParamSearchTextAndSetMask

すべての実装されたインタフェース:

java.lang.AutoCloseable

public class PtlParamSearchTextAndSetMask
extends PtlParamSearchText

テキスト検索してマスク処理するパラメータを表現したクラスです。

テキスト検索した上でヒットしたテキストをマスク処理します。

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース jp.co.antenna.ptl.PtlParamSearchText

PtlParamSearchText.TEXT_TYPE

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static int	REMOVE_ALL 全を削除対象とする。
static int	REMOVE_IMAGE 画像を削除対象とする。
static int	REMOVE_PATH パスを削除対象とする。
static int	REMOVE_SHADING シェイディングを削除対象とする。
static int	REMOVE_TEXT ヒットしたテキスト以外も削除対象とする。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PtlParamSearchTextAndSetMask() コンストラクタ
PtlParamSearchTextAndSetMask(PtlParamSearchTextAndSetMask obj) コピーコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	setColor(PtlColor color) マスクの色を設定。
void	setOpacity(float opacity) マスク色の不透明度を設定。
void	setRemoveElement(int remove) マスクの削除対象とするエレメントを追加。

クラスから継承されたメソッド jp.co.antenna.ptl.PtlParamSearchText

appendText, close, setCompareCase, setIgnoreActualText, setOverlapAsLine, setTextType

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

REMOVE_TEXT

public static final int REMOVE_TEXT

ヒットしたテキスト以外も削除対象とする。

関連項目:

定数フィールド値

REMOVE_IMAGE

public static final int REMOVE_IMAGE

画像を削除対象とする。

関連項目:

定数フィールド値

REMOVE_PATH

public static final int REMOVE_PATH

パスを削除対象とする。

関連項目:

定数フィールド値

REMOVE_SHADING

public static final int REMOVE_SHADING

シェイディングを削除対象とする。

関連項目:

定数フィールド値

REMOVE_ALL

public static final int REMOVE_ALL

全を削除対象とする。

関連項目:

定数フィールド値

コンストラクタの詳細

PtlParamSearchTextAndSetMask

public PtlParamSearchTextAndSetMask()
                             throws PtlException

コンストラクタ

例外:

PtlException - 例外

PtlParamSearchTextAndSetMask

public PtlParamSearchTextAndSetMask(PtlParamSearchTextAndSetMask obj)
                             throws PtlException

コピーコンストラクタ

パラメータ:

obj - コピー元オブジェクト。

例外:

PtlException - 例外

メソッドの詳細

setColor

public void setColor(PtlColor color)
              throws PtlException

マスクの色を設定。

※ 設定しない場合はデフォルト値として黒色が設定されます。

パラメータ:

color - マスクの色指定。

例外:

PtlException - 例外

setOpacity

public void setOpacity(float opacity)
                throws PtlException

マスク色の不透明度を設定。

※ 設定しない場合はデフォルト値として1.0が使用されます。

パラメータ:

opacity - 0.0 〜 1.0。0.0が透明、1.0が不透明。

例外:

PtlException - 例外

setRemoveElement

public void setRemoveElement(int remove)
                      throws PtlException

マスクの削除対象とするエレメントを追加。

マスク処理ではテキスト検索した上でヒットしたテキストを削除するのが基本動作ですが、
この関数を用いることによりヒットしたテキストの領域にある他のエレメントを削除対象とすることができます。
※ 設定しない場合はヒットしたテキストのみが削除対象となります。

パラメータ:

remove - 追加する削除対象のエレメント。REMOVE_XXXのフラグを論理和で指定します。

例外:

PtlException - 例外