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

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

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.ECLField

public class ECLField
extends Object
implements ECLConstants, Observer
フィールドは、プレゼンテーション・スペースの基本要素です。 フィールドには、内容と属性が含まれています。 ECLField クラスはプレゼンテーション・スペースのフィールドをカプセル化します。 また、このクラスにはフィールドの属性と内容へのアクセスおよび操作を行うためのメソッドがあります。

3270、5250、CICS セッションの場合、 ECLField はそれぞれのデータ・ストリームで定義されたフィールドと相関関係があります。 VT エミュレーションの場合、 1 つのフィールドにプレゼンテーション・スペース全体が表示されます。

ECLField オブジェクトにアクセスするには、 ECLFieldList オブジェクトを使用します。

関連項目:
ECLFieldList

メソッド索引

 o GetAttribute()
フィールドのそのままの属性バイトを取得します。
 o GetEnd()
フィールドの終了線形位置を取得します。
 o GetEndCol()
フィールドの終了桁を取得します。
 o GetEndRow()
フィールドの終了行を取得します。
 o GetLength()
フィールドの長さを取得します。
 o GetScreen(char[], int, int)
フィールドに関連した種々のプレーン (テキスト、カラー、拡張属性、DBCS、 およびグリッド) から情報を検索します。
 o GetStart()
フィールドの開始線形位置を取得します。
 o GetStartCol()
フィールドの開始桁を取得します。
 o GetStartRow()
フィールドの開始行を取得します。
 o GetString(char[], int)
GetScreen と同様に、TEXT_PLANE パラメーターを使用して、 フィールドからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。
 o IsDisplay()
フィールドが表示可能かどうかを判別します。
 o IsHighIntensity()
フィールドが高輝度かどうかを判別します。
 o IsModified()
フィールドが変更されたかどうかを判別します。
 o IsNumeric()
フィールドが数字専用かどうかを判別します。
 o IsPenDetectable()
フィールドがペン検出可能かどうかを判別します。
 o IsProtected()
フィールドがプロテクトされているかどうかを判別します。
 o SetString(String)
SetText と同様に、フィールドのテキスト・プレーンを指定された文字列に設定しますが、 DBCS 文字は異なる方法で処理します。
 o SetText(String)
フィールドのテキスト・プレーンを指定された文字列に設定します。

メソッド

 o GetStart
 public int GetStart()
フィールドの開始線形位置を取得します。 線形位置の可能な範囲は、1 からプレゼンテーション・スペースのサイズまでです。 フィールドの開始線形位置とは、フィールドの先頭文字の位置のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの線形位置が戻されます。

戻り値:
フィールドの開始線形位置。
関連項目:
GetEnd
 o GetStartRow
 public int GetStartRow()
フィールドの開始行を取得します。 行の可能な範囲は、1 からプレゼンテーション・スペースの行数までです。 フィールドの開始行とは、フィールドの先頭文字が含まれている行のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの行が戻されます。

戻り値:
PS 内のフィールドの開始行。
関連項目:
GetEndRowGetStartCol
 o GetStartCol
 public int GetStartCol()
フィールドの開始桁を取得します。 桁の可能な範囲は、1 からプレゼンテーション・スペースの桁数までです。 フィールドの開始桁とは、フィールドの先頭文字が含まれている桁のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの桁が戻されます。

戻り値:
PS 内のフィールドの開始桁。
関連項目:
GetEndColGetStartRow
 o GetEnd
 public int GetEnd()
フィールドの終了線形位置を取得します。 線形位置の可能な範囲は、1 からプレゼンテーション・スペースのサイズまでです。 フィールドの終了線形位置とは、フィールドの最後の文字の位置のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの線形位置が戻されます。

戻り値:
フィールドの終了線形位置。
関連項目:
GetStart
 o GetEndRow
 public int GetEndRow()
フィールドの終了行を取得します。 行の可能な範囲は、1 からプレゼンテーション・スペースの行数までです。 フィールドの終了行とは、フィールドの最後の文字が含まれている行のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの行が戻されます。

戻り値:
PS 内のフィールドの終了行。
関連項目:
GetStartRowGetEndCol
 o GetEndCol
 public int GetEndCol()
フィールドの終了桁を取得します。 桁の可能な範囲は、1 からプレゼンテーション・スペースの桁数までです。 フィールドの終了桁とは、フィールドの最後の文字が含まれている桁のことです。 フィールドの長さが 0 の場合、 フィールドの属性バイトの桁が戻されます。

戻り値:
PS 内のフィールドの終了桁。
関連項目:
GetStartColGetEndRow
 o GetLength
 public final int GetLength()
フィールドの長さを取得します。 フィールドの長さの可能な範囲は、 ゼロからプレゼンテーション・スペースのサイズまでです。

戻り値:
フィールドの長さ。
 o GetScreen
 public int GetScreen(char buffer[],
                      int length,
                      int plane) throws ECLErr
フィールドに関連した種々のプレーン (テキスト、カラー、拡張属性、DBCS、 およびグリッド) から情報を検索します。 アプリケーションは、 戻されるデータ用のバッファーとそのバッファーの長さを提供しなければなりません。 データの戻りは、 フィールドの先頭から始められ、 バッファーがいっぱいになるか、 あるいはフィールド全体の内容が複写し終わるまで続行されます。 バッファーは位置を 1 つ余分に含めなければなりません。 これは終了ヌル文字を追加するためです。

パラメーター:
buffer - 戻り値を保管するのに使用する、文字の配列。
length - バッファーに複写する文字数。
plane - 検索するプレーン。有効な値は以下のとおりです。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または印刷不能ではない文字が含まれます。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
戻り値:
バッファーに複写される文字数。 ただし、テキスト・プレーンが複写される際の終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、または plane パラメーターが正しくない場合、出されます。
 o GetString
 public synchronized int GetString(char buffer[],
                                   int length) throws ECLErr
GetScreen と同様に、TEXT_PLANE パラメーターを使用して、 フィールドからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。 GetScreen はそのままのテキスト・プレーン・データを戻しますが、 GetString は重複する DBCS 文字を除去してから、 テキスト・プレーン・データを戻します。

アプリケーションは、 戻されるデータ用のバッファーとそのバッファーの長さを提供しなければなりません。 データの戻りは、 フィールドの先頭から始められ、 バッファーがいっぱいになるか、 あるいはフィールド全体の内容が複写し終わるまで続行されます。 バッファーは位置を 1 つ余分に含めなければなりません。 これは終了ヌル文字を追加するためです。

注: フィールドのテキスト・プレーンに DBCS 文字がない場合、 GetString は GetScreen と同じように機能します。

テキスト・プレーンに含まれている DBCS 文字の表示については、 付録 B. ホスト・アクセス・ライブラリー・プレーン -- 形式および内容にあるテキスト・プレーンを参照してください。

パラメーター:
buffer - 戻されたデータを含む文字の配列。
length - バッファーの長さ。
戻り値:
バッファーに複写される文字数。 ただし、終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルの場合、出されます。
 o SetText
 public void SetText(String text) throws ECLErr
フィールドのテキスト・プレーンを指定された文字列で設定します。 文字列がフィールドの長さより短い場合、 フィールドの残りは消去されます。 文字列がフィールドより長い場合、 テキストは切り捨てられます。

パラメーター:
text - フィールドの現在のテキスト・プレーンを置換するのに使用するテキスト。
Throw (例外) : ECLErr
フィールドがプロテクトされている場合、 ECLErr が throw されます。
関連項目:
SetString
 o SetString
 public void SetString(String text) throws ECLErr
SetText と同様に、フィールドのテキスト・プレーンを指定された文字列で設定しますが、 DBCS 文字は異なる方法で処理します。 SetText は指定された文字列をフィールドのテキスト・プレーンに直接複写しますが、 SetString は DBCS 文字を自動的に複製してから、 その文字列をテキスト・プレーンに複写します。

文字列がフィールドの長さより短い場合、 フィールドの残りは消去されます。 文字列がフィールドより長い場合、 テキストは切り捨てられます。

注: 指定されたテキスト列に DBCS 文字がない場合、 SetString は SetText と同じように機能します。

テキスト・プレーンに含まれている DBCS 文字の表示については、 付録 B. ホスト・アクセス・ライブラリー・プレーン -- 形式および内容にあるテキスト・プレーンを参照してください。

パラメーター:
text - フィールドの現在のテキスト・プレーンを置換するのに使用するテキスト。
Throw (例外) : ECLErr
フィールドがプロテクトされている場合、 ECLErr が出されます。
関連項目:
SetText
 o IsModified
 public final boolean IsModified()
フィールドが変更されたかどうかを判別します。

戻り値:
フィールドが変更されていない場合は True、それ以外の場合は False。
 o IsProtected
 public final boolean IsProtected()
フィールドがプロテクトされているかどうかを判別します。

戻り値:
フィールドがプロテクトされている場合は True、それ以外の場合は False。
 o IsNumeric
 public boolean IsNumeric()
フィールドが数字専用かどうかを判別します。

戻り値:
フィールドが数値専用の場合は True、それ以外の場合は False。
 o IsHighIntensity
 public boolean IsHighIntensity()
フィールドが高輝度かどうかを判別します。

戻り値:
フィールドが高輝度の場合は True、それ以外の場合は False。
 o IsPenDetectable
 public final boolean IsPenDetectable()
フィールドがペン検出可能かどうかを判別します。

戻り値:
フィールドがペン検出可能の場合は True、それ以外の場合は False。
 o IsDisplay
 public final boolean IsDisplay()
フィールドが表示可能かどうかを判別します。

戻り値:
フィールドが表示可能の場合は True、それ以外の場合は False。
 o GetAttribute
 public final short GetAttribute()
フィールドのそのままの属性バイトを取得します。 フィールド属性バイトのフォーマットについては、 フィールド・プレーンを参照してください。

戻り値:
フィールドのそのままの属性バイト。

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