すべてのパッケージ  クラス階層  このパッケージ  前へ  次へ  索引

クラス com.ibm.eNetwork.ECL.ECLFieldList

java.lang.Object
   |
   +----java.util.Vector
           |
           +----com.ibm.eNetwork.ECL.ECLFieldList

public class ECLFieldList
extends Vector
implements ECLConstants, Observer
ECLFieldList には、 プレゼンテーション・スペース内のフィールドの集合が入っています。 このクラスには、フィールド間を反復して、 位置に基づくフィールドの検索、 および指定した文字列を含むフィールドの検索を行うためのメソッドがあります。 この集合の各要素が ECLField のインスタンスです。

ECLFieldList へのアクセスは、 GetFieldList() メソッドを使用し、ECLPS を介してのみ行うことができます。 ECLFieldList はプレゼンテーション・スペースの静的ビューであり、 その作成後にプレゼンテーション・スペースに対して行われた変更は反映されません。 フィールド・リストをプレゼンテーション・スペースの新しいスナップショットで更新するには、 Refresh() メソッドを使用します。

注:このクラスにあるメソッドで戻された ECLField オブジェクトはすべて、 Refresh() が呼び出されたときに無効になります。

関連項目:
ECLField, ECLPS

メソッド索引

 o FindField(int)
指定された線形位置を含むフィールドを検出します。
 o FindField(int, int)
指定された行および桁の座標を含むフィールドを検出します。
 o FindField(String, int)
指定の文字列を含むフィールドを検出します。
 o FindField(String, int, int)
指定の文字列を含むフィールドを検出します。
 o FindField(String, int, int, int)
指定の文字列を含むフィールドを検出します。
 o GetFieldCount()
フィールド・リストのフィールドの数を取得します。
 o GetFirstField()
フィールド・リストの最初のフィールドを戻します。
 o GetFirstField(int)
フィールド・リストの中の、 指定された属性と一致する最初のフィールドを戻します。
 o GetNextField(ECLField)
フィールド・リストの中の、指定されたフィールドの次のフィールドを戻します。
 o GetNextField(ECLField, int)
フィールド・リストの中の、指定された属性のある次のフィールドを戻します。
 o Refresh()
現行のプレゼンテーション・スペース内のフィールドのスナップショットを使用して、 フィールド・リストを最新表示します。
 o Refresh(int)
現行のプレゼンテーション・スペース内のフィールドのスナップショットを使用して、 フィールド・リストを最新表示します。

メソッド

 o Refresh
 public void Refresh() throws ECLErr
現行のプレゼンテーション・スペース内のフィールドのスナップショットを使用して、 フィールド・リストを最新表示します。 フィールド・リストにそれまで含まれていたフィールドへの参照は、 すべて無効にされます。

新しい ECLField オブジェクトに含まれる情報は、 テキスト・プレーン情報だけです。

Throw (例外) : ECLErr
プレーンのパラメーターが無効か、 またはフィールド・リストを作成する際にエラーが発生した場合に throw されます。
関連項目:
Refresh
 o Refresh
 public void Refresh(int planes) throws ECLErr
現行のプレゼンテーション・スペース内のフィールドのスナップショットを使用して、 フィールド・リストを最新表示します。 フィールド・リストにそれまで含まれていたフィールドへの参照は、 すべて無効にされます。

新しい ECLField オブジェクトには、 指定したプレゼンテーション・スペースのプレーンに関する情報だけが含められます。 ただし、テキストと属性のプレーンは例外で、 それらはいつでも含められます。

パラメーター:
planes - 最新表示するプレーン。 有効な値を後に続け、まとめて ORed にすることができます。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または表示不能ではない文字が含まれます。
FIELD_PLANE - プレーン内のフィールドごとのフィールド属性。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
ALL_PLANES - すべてのプレーンを最新表示します。
Throw (例外) : ECLErr
プレーンのパラメーターが無効か、 またはフィールド・リストを作成する際にエラーが発生した場合に throw されます。
 o GetFieldCount
 public int GetFieldCount()
フィールド・リストのフィールドの数を取得します。

戻り値:
フィールド・リストのフィールドの数。
 o GetFirstField
 public ECLField GetFirstField(int attr)
フィールド・リストの中の、 指定された属性と一致する最初のフィールドを戻します。

パラメーター:
attr - 希望するフィールド属性。 有効な値は以下のとおりです。
ALL_FIELDS - 属性に関係なく、すべてのフィールド。
これらの値をまとめて ORed にすることができ、 属性パラメーターに上記の値とそれに相当する下記の値の両方が含まれている場合は、 上記の値が下記の値より優先されます。
MODIFIED_FIELD - 変更フィールド
ALPHANUM_FIELD - 英数字のフィールド
HILIGHT_FIELD - 高輝度のフィールド
PROTECTED_FIELD - プロテクトされたフィールド
DISPLAYABLE_FIELD - 表示可能フィールド
PENDETECTABLE_FIELD - ペン検出可能フィールド
これらの値をまとめて ORed にすることができ、 属性パラメーターに上記の値とそれに相当する下記の値の両方が含まれている場合は、 上記の値が下記の値を上書きします。
UNMODIFIED_FIELD - 変更されていないフィールド
NUMERIC_FIELD - 数値専用フィールド
LOLIGHT_FIELD - 高輝度でないフィールド
UNPROTECTED_FIELD - プロテクトされていないフィールド
NON_DISPLAYABLE_FIELD - 表示不能フィールド
NON_PENDETECTABLE_FIELD - ペン検出不能フィールド
戻り値:
指定された属性を持つ最初のフィールド (一致するフィールドがない場合ヌル)。
関連項目:
GetNextField
 o GetFirstField
 public ECLField GetFirstField()
フィールド・リストの最初のフィールドを戻します。

関連項目:
GetFirstField, GetNextField, GetNextField
 o GetNextField
 public ECLField GetNextField(ECLField afterThis,
                              int attr)
フィールド・リストの中の、指定された属性のある次のフィールドを戻します。 ECLField パラメーターで指定したフィールドから検索を開始します。 ECLField パラメーターがヌルの場合、 フィールド・リストの中の、 指定した属性を持つ最初のフィールドが戻されます。

パラメーター:
afterThis - その次から検索が開始されるフィールド。
attr - 希望するフィールド属性。 以下の値のいずれかを使用します。
ALL_FIELDS - 属性に関係なく、すべてのフィールド。
これらの値をまとめて ORed にすることができ、 属性パラメーターに上記の値とそれに相当する下記の値の両方が含まれている場合は、 上記の値が下記の値より優先されます。
MODIFIED_FIELD - 変更フィールド
ALPHANUM_FIELD - 英数字のフィールド
HILIGHT_FIELD - 高輝度のフィールド
PROTECTED_FIELD - プロテクトされたフィールド
DISPLAYABLE_FIELD - 表示可能フィールド
PENDETECTABLE_FIELD - ペン検出可能フィールド
これらの値をまとめて ORed にすることができ、 属性パラメーターに上記の値とそれに相当する下記の値の両方が含まれている場合は、 上記の値が下記の値を上書きします。
UNMODIFIED_FIELD - 変更されていないフィールド
NUMERIC_FIELD - 数値専用フィールド
LOLIGHT_FIELD - 高輝度でないフィールド
UNPROTECTED_FIELD - プロテクトされていないフィールド
NON_DISPLAYABLE_FIELD - 表示不能フィールド
NON_PENDETECTABLE_FIELD - ペン検出不能フィールド
関連項目:
GetFirstField, GetFirstField, GetNextField
 o GetNextField
 public ECLField GetNextField(ECLField afterThis)
フィールド・リストの中の、指定されたフィールドの次のフィールドを戻します。 ECLField パラメーターがヌルの場合、 フィールド・リストの中の最初のフィールドが戻されます。

パラメーター:
afterThis - その次から検索が開始されるフィールド。
関連項目:
GetFirstField, GetFirstField, GetNextField
 o FindField
 public ECLField FindField(int pos) throws ECLErr
指定された線形位置を含むフィールドを検出します。

パラメーター:
pos - 線形位置
戻り値:
指定した位置を含むフィールド。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
FindField
 o FindField
 public ECLField FindField(int row,
                           int col) throws ECLErr
指定した行および桁の座標を含むフィールドを検出します。

パラメーター:
row - 検出するフィールドの行。
col - 検出するフィールドの桁。
戻り値:
指定した座標を含むフィールド。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
FindField
 o FindField
 public ECLField FindField(String text,
                           int direction) throws ECLErr
指定の文字列を含むフィールドを検出します。 このメソッドは、前方向か後方向のいずれかで、 テキスト列を検索します。 前方向で検索するよう要求している場合、 検索はプレゼンテーション・スペースの最初から開始されます。 後方向で検索するよう要求している場合、 検索はプレゼンテーション・スペースの最後から開始されます。

検索文字列が複数のフィールドにまたがっている場合、 文字列の開始位置を含んでいるフィールドが戻されます。

パラメーター:
text - 検索する文字列。
direction - 検索する方向 (SEARCH_FORWARD か SEARCH_BACKWARD のいずれか)
戻り値:
指定した文字列を含むフィールド (フィールドが検出されない場合はヌル)。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
FindField, FindField
 o FindField
 public ECLField FindField(String text,
                           int pos,
                           int direction) throws ECLErr
指定の文字列を含むフィールドを検出します。 このメソッドは、指定した線形位置から、 前方向か後方向のいずれかで検索を行います。

検索文字列が複数のフィールドにまたがっている場合、 文字列の開始位置を含んでいるフィールドが戻されます。

パラメーター:
text - 検索する文字列。
pos - 検索を開始する位置。
direction - 検索する方向 (SEARCH_FORWARD か SEARCH_BACKWARD のいずれか)
戻り値:
指定した文字列を含むフィールド (フィールドが検出されない場合はヌル)。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
FindField, FindField
 o FindField
 public ECLField FindField(String text,
                           int row,
                           int col,
                           int direction) throws ECLErr
指定の文字列を含むフィールドを検出します。 このメソッドは、指定した行および桁の座標から、 前方向か後方向のいずれかで検索を行います。

検索文字列が複数のフィールドにまたがっている場合、 文字列の開始位置を含んでいるフィールドが戻されます。

パラメーター:
text - 検索する文字列。
row - 検索を開始する行。
col - 検索を開始する桁。
direction - 検索する方向 (SEARCH_FORWARD か SEARCH_BACKWARD のいずれか)
戻り値:
指定した文字列を含むフィールド (フィールドが検出されない場合はヌル)。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
FindFieldFindField

すべてのパッケージ  クラス階層  このパッケージ  前へ  次へ  索引