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

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

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

public class ECLPS
extends Object
implements ECLConstants, Observer
ECLPS は、ホストのプレゼンテーション・スペースをカプセル化します。 プレゼンテーション・スペースとは、 従来のエミュレーター画面で表示されたすべての文字および属性を含む、 仮想画面のことです。 プレゼンテーション・スペースは、 ホストとのテキスト・ベースの対話の際に使用する、 基本オブジェクトです。 このクラスには、 テキストの操作、検索の実行、ホストへのキーストロークの送信、 およびカーソルの処理を行うメソッドがあります。 ECLPS のインスタンスを取得するには、 ECLSession のインスタンスで GetPS() メソッドを使用する方法しかありません。

そのままのプレゼンテーション・スペース・データは、 このクラスにあるさまざまなメソッドで使用することが可能な 一連のプレーンで操作されます。 テキスト・プレーンには、 プレゼンテーション・スペースにある実際の文字が含まれています。 ECLPS にあるメソッドのほとんどは、 テキスト・プレーンを専用に処理します。

残りのプレーンには、 テキスト・プレーンにある文字ごとに対応する属性が含まれています。 カラー・プレーンには、 カラー特性が含まれています。 フィールド・プレーンには、 フィールド属性が含まれています。 拡張フィールド・プレーンには、 拡張フィールド属性が含まれています。 DBCS プレーンには、 2 バイト文字セット (DBCS) 文字およびフィールド属性が含まれています。 グリッド・プレーンには、 DBCS グリッド情報が含まれています。 カラー、フィールド、拡張フィールド、DBCS、 およびグリッドの各プレーンを解釈するメソッドは、 このクラスにはありません。

フィールド・リスト (ECLFieldList) を使えば、 プレゼンテーション・スペースをもっと活用することができます。 GetFieldList() メソッドを使用して、 現在のプレゼンテーション・スペースにあるすべてのフィールドのスナップショットを含んでいる、 ECLFieldList のインスタンスを取得することができます。 フィールドには、 テキスト以外のプレーンにあるデータを解釈するのに便利なメソッドがあります。

プレゼンテーション・スペースの構成可能な機能は、 サイズだけです。 サイズは、 ECLSession を構成する際に Properties パラメーターの SESSION_PS_SIZE キーワードの値で決定することができます。 有効なプレゼンテーション・スペースのサイズは、 24 x 80、32 x 80、43 x 80、27 x 132、および 24 x 132 ですが、 エミュレーションのタイプ (3270、5250、VT) によって制限される場合があります。 デフォルトのサイズは、 24 行 x 80 桁です。 プレゼンテーション・スペースのサイズは、GetSize()、GetSizeRows()、 および GetSizeCols() メソッドを使用して決定することができます。

いったん ECLPS のインスタンスを取得したら、 アプリケーションは RegisterPSEvent() メソッドを使用して、 PS イベントに登録することができます。 PS イベントによってホストまたはオペレーターが開始される場合、 プレゼンテーション・スペースが何らかの理由で変更されると、 必ず PS イベントは登録されたオブジェクトに送信されます。 この PS イベントは、 プレゼンテーション・スペースとの対話を始めるために、 アプリケーションが使用する主な機構です。

関連項目:
ECLSession, ECLFieldList, ECLField

変数索引

 o ALL_EVENTS
 o HOST_EVENTS
 o USER_EVENTS

メソッド索引

 o ConvertPosToCol(int)
ConvertPosToCol メソッドは、プレゼンテーション・スペースの線形位置を対応する桁に変換します。
 o ConvertPosToRow(int)
ConvertPosToRow メソッドは、プレゼンテーション・スペースの線形位置を対応する行に変換します。
 o ConvertRowColToPos(int, int)
ConvertRowColToPos メソッドは、行と桁の座標を対応する線形位置に変換します。
 o GetCursorCol()
現行カーソル位置の桁座標を戻します。
 o GetCursorPos()
カーソルの線形位置を戻します。
 o GetCursorRow()
現行カーソル位置の行座標を戻します。
 o GetFieldList()
GetFieldList は、現在の PS に基づいて ECLFieldList のインスタンスを戻します。
 o GetFieldList(int)
GetFieldList は、現在の PS に基づいて ECLFieldList のインスタンスを戻します。
 o GetParent()
ECLSession のインスタンスである、 その PS の親を取得します。
 o GetScreen(char[], int, int)
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。
 o GetScreen(char[], int, int, int, int)
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。
 o GetScreen(char[], int, int, int, int, int)
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。
 o GetScreen(int, int, int)
GetScreen は、プレゼンテーション・スペースから 1 つまたは複数のデータのプレーンを検索します。
 o GetScreenRect(char[], int, int, int, int)
GetScreenRect は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) からデータを検索します。
 o GetScreenRect(char[], int, int, int, int, int, int)
GetScreenRect は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) からデータを検索します。
 o GetSize()
線形値によるプレゼンテーション・スペースのサイズを戻します。
 o GetSizeCols()
プレゼンテーション・スペースにある桁の合計数を戻します。
 o GetSizeRows()
プレゼンテーション・スペースにある行の合計数を戻します。
 o GetString(char[], int)
GetString は、GetScreen と同様に TEXT_PLANE パラメーターを使用して、 プレゼンテーション・スペースからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。
 o GetString(char[], int, int, int)
GetString は、GetScreen と同様に TEXT_PLANE パラメーターを使用して、 プレゼンテーション・スペースからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。
 o GetString(char[], int, int, int, int)
GetString は、GetScreen と同様に TEXT_PLANE パラメーターを使用して、 プレゼンテーション・スペースからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。
 o RegisterPSEvent(ECLPSListener)
すべての PS イベントの PS Listener を登録します。
 o RegisterPSEvent(ECLPSListener, int)
ホスト生成イベントかユーザー生成イベントのいずれかの PS Listener を登録します。
 o RegisterPSEvent(ECLPSNotify)
ECLPS の単一インスタンスによってディスパッチされたイベントの通知オブジェクトを登録します。 Deprecated.
 o SearchString(String, int)
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。
 o SearchString(String, int, int)
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。
 o SearchString(String, int, int, int)
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。
 o SearchText(String, int)
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。
 o SearchText(String, int, int)
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。
 o SearchText(String, int, int, int)
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。
 o SendKeys(String)
SendKeys メソッドは、キーの文字列をプレゼンテーション・スペースに送信します。
 o SendKeys(String, int)
SendKeys のこのシグニチャーは、指定されたカーソル位置のテキスト列を送信します。
 o SendKeys(String, int, int)
SendKeys のこのシグニチャーは、指定されたカーソル位置のテキスト列を送信します。
 o SetCursorPos(int)
カーソル位置を指定された線形位置に設定する。
 o SetCursorPos(int, int)
カーソル位置を指定された行と桁に設定します。
 o SetString(String)
SetString メソッドは、SetText と同様に、 文字列を現行カーソル位置のプレゼンテーション・スペースに送信しますが、 DBCS 文字は異なる方法で処理します。
 o SetString(String, int)
SetString メソッドは、SetText と同様に、 文字列を現行カーソル位置のプレゼンテーション・スペースに送信しますが、 DBCS 文字は異なる方法で処理します。
 o SetString(String, int, int)
SetString メソッドは、SetText と同様に、 文字列を現行カーソル位置のプレゼンテーション・スペースに送信しますが、 DBCS 文字は異なる方法で処理します。
 o SetText(String)
SetText メソッドは、文字列を現行カーソル位置のプレゼンテーション・スペースに送信します。
 o SetText(String, int)
SetText メソッドは、文字列を指定された位置のプレゼンテーション・スペースに送信します。
 o SetText(String, int, int)
SetText メソッドは、文字列を指定された位置のプレゼンテーション・スペースに送信します。
 o UnregisterPSEvent(ECLPSListener)
以前に RegisterPSEvent() メソッドに登録された PS Listener の登録を解除します。
 o UnregisterPSEvent(ECLPSListener, int)
以前に RegisterPSEvent() メソッドに登録された PS Listener の登録を解除します。
 o UnregisterPSEvent(ECLPSNotify)
以前に RegisterPSEvent() メソッドに登録された通知オブジェクトの登録を解除します。 Deprecated.
 o WaitForAttrib(int, int, char, int)
属性が指定の行と桁の位置に表示されるまで同期待機します。
 o WaitForAttrib(int, int, char, int, long, boolean)
属性が指定の行と桁の位置に表示されるまで、 またはメソッドがタイムアウトになるまで同期待機します。
 o WaitForCursor(int, int)
カーソルが指定の行と桁の位置に表示されるまで同期待機します。
 o WaitForCursor(int, int, long, boolean)
カーソルが指定の行と桁の位置に表示されるまで、 またはメソッドがタイムアウトになるまで同期待機します。
 o WaitForScreen(ECLScreenDesc)
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されるまで同期待機します。
 o WaitForScreen(ECLScreenDesc, long)
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されるのを同期待機します。
 o WaitForString(String)
文字列がプレゼンテーション・スペースに表示されるまで同期待機します。
 o WaitForString(String, int, int)
文字列が指定位置に表示されるまで同期待機します。
 o WaitForString(String, int, int, long, boolean, boolean)
文字列が指定位置に表示されるまで同期待機します。
 o WaitForStringInRect(String, int, int, int, int)
文字列が指定の長方形に表示されるまで同期待機します。
 o WaitForStringInRect(String, int, int, int, int, long, boolean, boolean)
文字列が指定の長方形に表示されるまで同期待機します。
 o WaitWhileAttrib(int, int, char, int)
属性が指定の行と桁の位置に存在しなくなるまで同期待機します。
 o WaitWhileAttrib(int, int, char, int, long, boolean)
属性が指定の行と桁の位置に存在しなくなるまで同期待機します。
 o WaitWhileCursor(int, int)
カーソルが指定の行と桁の位置に表示されなくなるまで同期待機します。
 o WaitWhileCursor(int, int, long, boolean)
カーソルが指定の行と桁の位置に表示されなくなるまで、 またはメソッドがタイムアウトになるまで同期待機します。
 o WaitWhileScreen(ECLScreenDesc)
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されなくなるまで同期待機します。
 o WaitWhileScreen(ECLScreenDesc, long)
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されなくなるまで同期待機します。
 o WaitWhileString(String)
文字列がプレゼンテーション・スペースに表示されなくなるまで同期待機します。
 o WaitWhileString(String, int, int)
文字列が指定位置に存在しなくなるまで同期待機します。
 o WaitWhileString(String, int, int, long, boolean, boolean)
文字列が指定位置に存在しなくなるまで同期待機します。
 o WaitWhileStringInRect(String, int, int, int, int)
文字列が指定の長方形に存在しなくなるまで同期待機します。
 o WaitWhileStringInRect(String, int, int, int, int, long, boolean, boolean)
文字列が指定の長方形に存在しなくなるまで同期待機します。

変数

 o USER_EVENTS
 public static final int USER_EVENTS
 o HOST_EVENTS
 public static final int HOST_EVENTS
 o ALL_EVENTS
 public static final int ALL_EVENTS

メソッド

 o GetParent
 public ECLSession GetParent()
ECLSession のインスタンスである、 その PS の親を取得します。

戻り値:
親 ECLSession
 o GetSize
 public synchronized int GetSize()
線形値によるプレゼンテーション・スペースのサイズを戻します。 プレゼンテーション・スペースの線形サイズは、行数と桁数を乗算することにより 決まります。 たとえば、24 x 80 のプレゼンテーション・スペースのサイズは 1920 になります。

戻り値:
プレゼンテーション・スペースの線形サイズ。
 o GetSizeRows
 public synchronized int GetSizeRows()
プレゼンテーション・スペースにある行の合計数を戻します。

戻り値:
プレゼンテーション・スペースの行数。
関連項目:
GetSizeCols
 o GetSizeCols
 public synchronized int GetSizeCols()
プレゼンテーション・スペースにある桁の合計数を戻します。

戻り値:
プレゼンテーション・スペースの桁数。
関連項目:
GetSizeRows
 o GetCursorPos
 public synchronized int GetCursorPos()
カーソルの線形位置を戻します。 カーソルの線形位置は、 プレゼンテーション・スペースが 1 次元配列にマップされていると想定することにより決まります。 2 次元配列の座標は、公式 (y - 1) * numCol + x を使うことによって 1 次元配列にマップできます。 それで、24 x 80 のプレゼンテーション・スペース上の 10、15 のカーソルの線形位置は、 9*80+15=735 になります。

注: カーソル位置システムは、0 ベースではなく 1 ベース です。 24 x 80 のプレゼンテーション・スペースの正しいカーソル位置は、 1 と 1920 の間 (境界を含む) です。

戻り値:
カーソルの線形位置。
 o GetCursorRow
 public synchronized int GetCursorRow()
現行カーソル位置の行座標を戻します。

注: カーソル位置システムは、0 ベースではなく 1 ベース です。 24 x 80 のプレゼンテーション・スペースの正しいカーソル行位置は、 1 と 24 の間 (境界を含む) です。

戻り値:
現行カーソル位置の行座標。
関連項目:
GetCursorCol
 o GetCursorCol
 public synchronized int GetCursorCol()
現行カーソル位置の桁座標を戻します。

注: カーソル位置システムは、0 ベースではなく 1 ベース です。 24 x 80 のプレゼンテーション・スペースの正しいカーソル桁位置は、 1 と 80 の間 (境界を含む) です。

戻り値:
現行カーソル位置の桁座標。
関連項目:
GetCursorRow
 o SetCursorPos
 public synchronized void SetCursorPos(int pos) throws ECLErr
カーソル位置を指定された線形位置に設定する。

パラメーター:
pos - カーソルの新しい線形位置。 この数値は、1 とプレゼンテーション・スペースのサイズとの間 (境界を含む) です。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
SetCursorPos
 o SetCursorPos
 public synchronized void SetCursorPos(int row,
                                       int col) throws ECLErr
カーソル位置を指定された行と桁に設定します。

パラメーター:
row - カーソル位置の新しい行座標。 この数値は、1 とプレゼンテーション・スペースの行数との間 (境界を含む) です。
column - カーソル位置の新しい桁座標。 この数値は、1 とプレゼンテーション・スペースの桁数との間 (境界を含む) です。
Throw (例外) : ECLErr
指定した座標が範囲外の場合、throw されます。
関連項目:
SetCursorPos
 o SendKeys
 public synchronized void SendKeys(String text) throws ECLErr
SendKeys メソッドは、キーの文字列をプレゼンテーション・スペースに送信します。 この文字列は、テキスト文字および特殊なキーストローク (Enter キー、Tab キー、Page Up キーなど) の両方を含む、 キーボードからのキーストロークとみなすことができます。 これらの特殊キーは、角括弧で区切られたキーワードによって表され、 略号と呼ばれます。 たとえば、Enter キーの略号キーワードは [enter] です。

テキスト文字列には、任意の数字または文字と略号の組み合わせが 含まれます。 たとえば、文字 "userID[tab]password[enter]" は、ユーザー ID を送信、 次のフィールドに移って、ユーザーのパスワードを送信、Enter キーを送信して、 ホストにログオンするのに使用できます。

左または右角括弧を送信するには、括弧を 2 つ重ねて使わなければなりません。 左角括弧を送信するには、"[[" を使います。 右角括弧を送信するには、"]]" を使います。

SendKeys のこのシグニチャーは、現在のカーソル位置のテキスト列を送信します。

パラメーター:
text - 送信する文字および補助キー略号の文字列。
関連項目:
SendKeys, SendKeys
 o SendKeys
 public synchronized void SendKeys(String text,
                                   int pos) throws ECLErr
SendKeys のこのシグニチャーは、指定されたカーソル位置のテキスト列を送信します。 カーソルが指定した位置に移動してから、 テキスト列が送信されます。

パラメーター:
text - 送信する文字および略号キーワードの文字列。
pos - キーが送信される線形位置。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
SendKeys, SendKeys
 o SendKeys
 public synchronized void SendKeys(String text,
                                   int row,
                                   int col) throws ECLErr
SendKeys のこのシグニチャーは、指定されたカーソル位置のテキスト列を送信します。 カーソルが指定した座標に移動してから、 テキスト列が送信されます。

パラメーター:
text - 送信する文字および略号キーワードの文字列。
row - キーが送信される開始行。
column - キーが送信される開始桁。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
SendKeys, SendKeys
 o SearchText
 public synchronized int SearchText(String text,
                                    int direction)
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。 このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索はプレゼンテーション・スペースの最初から開始されます。 後方向で検索するよう指定している場合、 検索はプレゼンテーション・スペースの最後から開始されます。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

パラメーター:
text - 検索する文字列。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字列の線形位置 (見つからなかった場合はゼロ)。
関連項目:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int direction)
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。 SearchText は指定したとおりの文字列を検索しますが、 SearchString は、 検索を試みる前に、 検索文字列にある DBCS 文字を自動的に複製します。

このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索はプレゼンテーション・スペースの最初から開始されます。 後方向で検索するよう指定している場合、 検索はプレゼンテーション・スペースの最後から開始されます。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

注: 指定された検索文字列に DBCS 文字がない場合、 SearchString は SearchText と同じように機能します。

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

パラメーター:
text - 検索する文字列。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字列の線形位置 (見つからなかった場合はゼロ)。
関連項目:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o SearchText
 public synchronized int SearchText(String text,
                                    int row,
                                    int column,
                                    int direction) throws ECLErr
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。 このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索は指定された座標 (その数値の座標も含まれる) から開始され、 プレゼンテーション・スペースの最後で終了します。 後方向で検索するよう指定している場合、 検索は指定された座標 (その数値の座標も含まれる) から開始され、 プレゼンテーション・スペースの最初で終了します。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

パラメーター:
text - 検索する文字列。
row - 開始行。
column - 開始桁。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字桁の線形位置 (見つからなかった場合はゼロ)。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int row,
                                      int column,
                                      int direction) throws ECLErr
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。 SearchText は指定したとおりの文字列を検索しますが、 SearchString は、 検索を試みる前に、 検索文字列にある DBCS 文字を自動的に複製します。

このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索は指定された座標 (その数値の座標も含まれる) から開始され、 プレゼンテーション・スペースの最後で終了します。 後方向で検索するよう指定している場合、 検索は指定された座標 (その数値の座標も含まれる) から開始され、 プレゼンテーション・スペースの最初で終了します。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

注: 指定された検索文字列に DBCS 文字がない場合、 SearchString は SearchText と同じように機能します。

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

パラメーター:
text - 検索する文字列。
row - 開始行。
column - 開始桁。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字列の線形位置 (見つからなかった場合はゼロ)。
Throw (例外) : ECLErr
指定した位置が範囲外の場合、throw されます。
関連項目:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o SearchText
 public synchronized int SearchText(String text,
                                    int position,
                                    int direction)
SearchText メソッドは、プレゼンテーション・スペース内で指定のテキスト列を検索します。 このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索は指定された線形位置 (その数値の線形位置も含まれる) から開始され、 プレゼンテーション・スペースの最後で終了します。 後方向で検索するよう指定している場合、 検索は指定された線形位置 (その数値の線形位置も含まれる) から開始され、 プレゼンテーション・スペースの最初で終了します。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

パラメーター:
text - 検索する文字列。
position - 開始線形位置。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字列の線形位置 (見つからなかった場合はゼロ)。
関連項目:
SearchText, SearchText, ConvertPosToRow, ConvertPosToCol
 o SearchString
 public synchronized int SearchString(String text,
                                      int position,
                                      int direction)
SearchString メソッドは、SearchText と同様に、 プレゼンテーション・スペース内で指定のテキスト列を検索しますが、 DBCS 文字は異なる方法で処理します。 SearchText は指定したとおりの文字列を検索しますが、 SearchString は、 検索を試みる前に、 検索文字列にある DBCS 文字を自動的に複製します。

このメソッドは、前方向と後方向の両方で、 検索を行うことができます。 前方向で検索するよう指定している場合、 検索は指定された線形位置 (その数値の線形位置も含まれる) から開始され、 プレゼンテーション・スペースの最後で終了します。 後方向で検索するよう指定している場合、 検索は指定された線形位置 (その数値の線形位置も含まれる) から開始され、 プレゼンテーション・スペースの最初で終了します。

このメソッドは、文字列が見つかった線形位置を戻しますが、 テキストが見つからない場合はゼロを戻します。 ConvertPosToRow() および ConvertPosToCol() メソッドを使用して、 線形位置を行と桁の座標に変換できます。

注: 指定された検索文字列に DBCS 文字がない場合、 SearchString は SearchText と同じように機能します。

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

パラメーター:
text - 検索する文字列。
position - 開始線形位置。
direction - 検索の開始位置から、 前方向と後方向のどちらで検索するか指定します。 前方向で検索するには、SEARCH_FORWARD 定数を使用します。 後方向で検索するには、SEARCH_BACKWARD 定数を指定します。
戻り値:
指定した文字列の線形位置 (見つからなかった場合はゼロ)。
関連項目:
SearchString, SearchString, ConvertPosToRow, ConvertPosToCol
 o GetScreen
 public synchronized ECLPSUpdate GetScreen(int position,
                                           int length,
                                           int planes) throws ECLErr
GetScreen は、プレゼンテーション・スペースから 1 つまたは複数のデータのプレーンを検索します。 データは ECLPSUpdate オブジェクトに戻されます。 このメソッドは通常、 開始位置および長さ (終了位置 - 開始位置 + 1) を使用する ECLPSEvent への応答で呼び出され、 プレゼンテーション・スペースの変更された領域を取得します。

パラメーター:
position - 開始位置。
length - 複写する文字数。
planes - 検索するプレーン。 有効な値は以下のとおりです。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または表示不能ではない文字が含まれます。
FIELD_PLANE - プレーン内のフィールドごとのフィールド属性。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
戻り値:
要求された領域を含んでいる ECLPSUpdate オブジェクト。
Throw (例外) : ECLErr
開始位置または長さが範囲外の場合、 または plane パラメーターが正しくない場合、出されます。
関連項目:
ECLPSUpdate, ECLPSEvent
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int plane) throws ECLErr
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。 データは、 指定した配列にある文字値の線形配列として戻されます。 データがテキスト・プレーンから取り出された(その場合、 単一のヌル文字が付加されます)のでない限り、 配列がヌル文字で終了することはありません。

アプリケーションは、 戻されるデータ用のバッファーとそのバッファーの長さを提供しなければなりません。 データの戻りは、 プレゼンテーション・スペースの先頭から始められ、 バッファーがいっぱいになるか、 あるいはプレーンが複写されるまで続行されます。 テキスト・プレーン・データの場合、 バッファーには、終了ヌル文字用に位置を 1 つ余分に含めなければなりません。

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

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

注: テキスト・プレーンに DBCS 文字がない場合、 GetString は GetScreen(char[], int, TEXT_PLANE) と同じように機能します。

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

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
戻り値:
バッファーに複写される文字数。 ただし、終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルの場合、throw されます。
関連項目:
GetString, GetString
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int row,
                                   int col,
                                   int length,
                                   int plane) throws ECLErr
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。 データは、 指定した配列にある文字値の線形配列として戻されます。 データがテキスト・プレーンから取り出された(その場合、 単一のヌル文字が付加されます)のでない限り、 配列がヌル文字で終了することはありません。

アプリケーションは、 戻されるデータ用のバッファーとそのバッファーの長さを提供しなければなりません。 データの戻りは、 指定された座標から始められ、 指定された文字数が複写されるか、 バッファーがいっぱいになるか、 あるいはプレーン全体が複写されるまで続行されます。 テキスト・プレーン・データの場合、 バッファーには、終了ヌル文字用に位置を 1 つ余分に含めなければなりません。

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
row - 開始行。
column - 開始桁。
length - 複写する文字数。
plane - 検索するプレーン。 有効な値は以下のとおりです。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または表示不能ではない文字が含まれます。
FIELD_PLANE - プレーン内のフィールドごとのフィールド属性。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
戻り値:
バッファーに複写される文字数。 ただし、テキスト・プレーン・データの終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、 plane パラメーターが正しくないか、 あるいは指定した位置が範囲外の場合、throw されます。
関連項目:
GetScreen, GetScreen
 o GetString
 public synchronized int GetString(char buffer[],
                                   int bufferLength,
                                   int row,
                                   int col,
                                   int length) throws ECLErr
GetString は、GetScreen と同様に TEXT_PLANE パラメーターを使用して、 プレゼンテーション・スペースからテキスト・プレーン情報を検索しますが、 DBCS 文字は異なる方法で処理します。 GetScreen はそのままのテキスト・プレーン・データを戻しますが、 GetString は重複する DBCS 文字を除去してから、 テキスト・プレーン・データを戻します。

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

注: テキスト・プレーンに DBCS 文字がない場合、 GetString は GetScreen(char[], int, int, int, int, TEXT_PLANE) と同じように機能します。

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

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
row - 開始行。
column - 開始桁。
length - 複写する文字数。
戻り値:
バッファーに複写される文字数。 ただし、終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、 または指定した位置が範囲外の場合、throw されます。
関連項目:
GetString, GetString
 o GetScreen
 public synchronized int GetScreen(char buffer[],
                                   int bufferLength,
                                   int position,
                                   int length,
                                   int plane) throws ECLErr
GetScreen は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) を検索します。 データは、 指定した配列にある文字値の線形配列として戻されます。 データがテキスト・プレーンから取り出された(その場合、 単一のヌル文字が付加されます)のでない限り、 配列がヌル文字で終了することはありません。

アプリケーションは、 戻されるデータ用のバッファーとそのバッファーの長さを提供しなければなりません。 データの戻りは、 指定された位置から始められ、 指定された文字数が複写されるか、 バッファーがいっぱいになるか、 あるいはプレーン全体が複写されるまで続行されます。 テキスト・プレーン・データの場合、 バッファーには、終了ヌル文字用に位置を 1 つ余分に含めなければなりません。

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

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

注: テキスト・プレーンに DBCS 文字がない場合、 GetString は GetScreen(char[], int, int, int, TEXT_PLANE) と同じように機能します。

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

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
position - 開始位置。
length - 複写する文字数。
戻り値:
バッファーに複写される文字数。 ただし、終了ヌル文字は含まれません。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、 または指定した位置が範囲外の場合、throw されます。
関連項目:
GetString, GetString
 o GetScreenRect
 public synchronized int GetScreenRect(char buffer[],
                                       int bufferLength,
                                       int startPos,
                                       int endPos,
                                       int plane) throws ECLErr
GetScreenRect は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) からデータを検索します。 データは、 指定したバッファーに入っている文字値の線形配列として戻されます。

アプリケーションは、 プレゼンテーション・スペース内にある長方形の対角にある隅を表す 2 つの位置を提供します。 開始位置と終了位置は、 任意の相関関係にすることができます。 データの戻りは、 上端の点を含んだ行から下端の点を含んだ行へ向かって、 また、左端の桁から右端の桁に向かって開始するよう定義されます。

提供するバッファーは、最低限、 長方形内の文字数を含めるのに十分な大きさでなければなりません。 バッファーが小さすぎると、 データは複写されず、メソッドがゼロを戻します。 それ以外の場合、複写された文字数をメソッドが戻します。

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
startPos - 長方形の片方の隅。
endPos - 長方形の反対の隅。
plane - 検索するプレーン。 有効な値は以下のとおりです。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または表示不能ではない文字が含まれます。
FIELD_PLANE - プレーン内のフィールドごとのフィールド属性。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
戻り値:
バッファーに複写される文字数。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、 plane パラメーターが正しくないか、 指定した位置のどちらかプレーン内でない場合、throw されます。
関連項目:
GetScreenRect
 o GetScreenRect
 public synchronized int GetScreenRect(char buffer[],
                                       int bufferLength,
                                       int startRow,
                                       int startCol,
                                       int endRow,
                                       int endCol,
                                       int plane) throws ECLErr
GetScreenRect は、プレゼンテーション・スペースに関連したさまざまなプレーン (テキスト、 カラー、属性、拡張属性) からデータを検索します。 データは、 指定したバッファーに入っている文字値の線形配列として戻されます。 バッファーは、ヌル文字終了することはありません。

アプリケーションは、 プレゼンテーション・スペース内にある長方形の対角にある隅を表す 2 つの座標を提供します。 開始座標と終了座標は、 任意の相関関係にすることができます。 データの戻りは、 上端の点を含んだ行から下端の点を含んだ行へ向かって、 また、左端の桁から右端の桁に向かって開始するよう定義されます。

提供するバッファーは、最低限、 長方形内の文字数を含めるのに十分な大きさでなければなりません。 バッファーが小さすぎると、 データは複写されず、メソッドがゼロを戻します。 それ以外の場合、複写された文字数をメソッドが戻します。

パラメーター:
buffer - 戻されたデータを含んでいる文字の配列。
bufferLength - バッファーの長さ。
startRow - 長方形の開始行。
startCol - 長方形の開始桁。
endRow - 長方形の終了行。
endCol - 長方形の終了桁。
plane - 検索するプレーン。 有効な値は以下のとおりです。
TEXT_PLANE - フィールドの文字内容。 テキスト・プレーンには、ヌルでない、または表示不能ではない文字が含まれます。
FIELD_PLANE - プレーン内のフィールドごとのフィールド属性。
COLOR_PLANE - プレーン内の文字ごとのカラー属性。
EXFIELD_PLANE - プレーン内の文字ごとの拡張フィールド属性。
DBCS_PLANE - 2 バイト文字セット (DBCS) 文字、 およびフィールド属性データ。
GRID_PLANE - DBCS グリッド情報。
戻り値:
バッファーに複写される文字数。
Throw (例外) : ECLErr
buffer パラメーターがヌルか、 plane パラメーターが正しくないか、 指定した位置のどちらかプレーン内でない場合、throw されます。
関連項目:
GetScreenRect
 o SetText
 public synchronized void SetText(String text) throws ECLErr
SetText メソッドは、文字桁を現行カーソル位置のプレゼンテーション・スペースに送信します。 文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

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

修正した文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

注: テキスト・プレーンに DBCS 文字がない場合、 SetString は SetText と同じように機能します。

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

パラメーター:
text - プレゼンテーション・スペースに置かれる文字列。
Throw (例外) : ECLErr
現在のカーソル位置にフィールドがない場合、 throw されます。
関連項目:
SetString, SetString
 o SetText
 public synchronized void SetText(String text,
                                  int pos) throws ECLErr
SetText メソッドは、文字列を指定された位置のプレゼンテーション・スペースに送信します。 文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

パラメーター:
text - プレゼンテーション・スペースに置かれる文字列。
pos - 文字列が書き込まれる線形位置。
Throw (例外) : ECLErr
位置が無効の場合、throw されます。
関連項目:
SetText, SetText
 o SetString
 public synchronized void SetString(String text,
                                    int pos) throws ECLErr
SetString メソッドは、SetText と同様に、 文字列を現行カーソル位置のプレゼンテーション・スペースに送信しますが、 DBCS 文字は異なる方法で処理します。 SetText は指定された文字列をフィールドのテキスト・プレーンに直接複写しますが、 SetString は DBCS 文字を自動的に複製してから、 その文字列をテキスト・プレーンに複写します。

修正した文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

注: テキスト・プレーンに DBCS 文字がない場合、 SetString は SetText と同じように機能します。

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

パラメーター:
text - プレゼンテーション・スペースに置かれる文字列。
pos - 文字列が書き込まれる線形位置。
Throw (例外) : ECLErr
位置が無効の場合、throw されます。
関連項目:
SetString, SetString
 o SetText
 public synchronized void SetText(String text,
                                  int row,
                                  int column) throws ECLErr
SetText メソッドは、文字列を指定された位置のプレゼンテーション・スペースに送信します。 文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

パラメーター:
text - プレゼンテーション・スペースに置かれる文字列。
row - 文字列が書き込まれる開始行。
column - 文字列が書き込まれる開始桁。
Throw (例外) : ECLErr
座標が無効な場合、throw されます。
関連項目:
SetText, SetText
 o SetString
 public synchronized void SetString(String text,
                                    int row,
                                    int column) throws ECLErr
SetString メソッドは、SetText と同様に、 文字列を現行カーソル位置のプレゼンテーション・スペースに送信しますが、 DBCS 文字は異なる方法で処理します。 SetText は指定された文字列をフィールドのテキスト・プレーンに直接複写しますが、 SetString は DBCS 文字を自動的に複製してから、 その文字列をテキスト・プレーンに複写します。

修正した文字列がオーバーレーを行うのは非プロテクト・フィールドだけであり、 プロテクト・フィールドの部分に当たる文字列の部分は、 廃棄されます。

注: テキスト・プレーンに DBCS 文字がない場合、 SetString は SetText と同じように機能します。

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

パラメーター:
text - プレゼンテーション・スペースに置かれる文字列。
row - 文字列が書き込まれる開始行。
column - 文字列が書き込まれる開始桁。
Throw (例外) : ECLErr
座標が無効な場合、throw されます。
関連項目:
SetString, SetString
 o ConvertPosToRow
 public synchronized int ConvertPosToRow(int pos) throws ECLErr
ConvertPosToRow メソッドは、プレゼンテーション・スペースの線形位置を対応する行に変換します。

パラメーター:
pos - 変換される位置。
戻り値:
指定した位置に対応する行。
Throw (例外) : ECLErr
位置が 0 より小さいか、 プレゼンテーション・スペースのサイズより小さい場合、 throw されます。
関連項目:
ConvertPosToCol, ConvertRowColToPos
 o ConvertPosToCol
 public synchronized int ConvertPosToCol(int pos) throws ECLErr
ConvertPosToCol メソッドは、プレゼンテーション・スペースの線形位置を対応する桁に変換します。

パラメーター:
pos - 変換される位置。
戻り値:
指定した位置に対応する桁。
Throw (例外) : ECLErr
位置が 0 より小さいか、 プレゼンテーション・スペースのサイズより小さい場合、 throw されます。
関連項目:
ConvertPosToRow, ConvertRowColToPos
 o ConvertRowColToPos
 public synchronized int ConvertRowColToPos(int row,
                                            int col) throws ECLErr
ConvertRowColToPos メソッドは、行と桁の座標を対応する線形位置に変換します。

パラメーター:
row - 座標の行。
col - 座標の桁。
戻り値:
指定した座標に対応する線形位置。
Throw (例外) : ECLErr
座標がプレゼンテーション・スペースの境界内にない場合、 throw されます。
関連項目:
ConvertPosToRow, ConvertPosToCol
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSNotify notify) throws ECLErr
注: RegisterPSEvent() は使用すべきではありません。

ECLPS の単一インスタンスによってディスパッチされたイベントの通知オブジェクトを登録します。 通知オブジェクトは、 ECLPSNotify インターフェースをインプリメントしていなければなりません。 このインターフェースは、それぞれの条件下で ECLPS クラスが呼び出す、 3 つのコールバック・メソッドを定義しています。

ECLPSNotify オブジェクトは、 UnregisterPSEvent() メソッドを使用して登録を解除することができます。

パラメーター:
notify - イベントの発生時に通知を受ける ECLPSNotify オブジェクト。
Throw (例外) : ECLErr
notify パラメーターがヌルの場合、throw されます。
関連項目:
UnregisterPSEvent, ECLPSNotify
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSListener listener)
すべての PS イベントの PS Listener を登録します。

パラメーター:
listener - イベントの発生時に通知を受ける ECLPSListener オブジェクト。
関連項目:
UnregisterPSEvent, ECLPSListener
 o RegisterPSEvent
 public void RegisterPSEvent(ECLPSListener listener,
                             int type)
ホスト生成イベントかユーザー生成イベントのいずれかの PS Listener を登録します。

パラメーター:
listener - イベントの発生時に通知を受ける ECLPSListener オブジェクト。
type - 通知イベント・タイプ。 有効な値は、 ホスト生成イベントの通知の場合は HOST_EVENTS、 ユーザー (または API) 生成イベントの通知の場合は USER_EVENTS、 USER_EVENTS と HOST_EVENTS の両方の通知の場合は ALL_EVENTS です。
関連項目:
UnregisterPSEvent, ECLPSListener
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSNotify notify)
注: UnregisterPSEvent() は使用すべきではありません。

以前に RegisterPSEvent() メソッドに登録された通知オブジェクトの登録を解除します。 現在登録されている通知オブジェクトがなければ、 このメソッドは何もしません。

パラメーター:
notify - 登録が解除される ECLPSNotify オブジェクト。
関連項目:
RegisterPSEvent, ECLPSNotify
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSListener listener)
以前に RegisterPSEvent() メソッドに登録された PS Listener の登録を解除します。 現在登録されている listener がなければ、このメソッドは何もしません、

パラメーター:
listener - 登録が解除される ECLPSListener オブジェクト。
関連項目:
RegisterPSEvent, ECLPSListener
 o UnregisterPSEvent
 public void UnregisterPSEvent(ECLPSListener listener,
                               int type)
以前に RegisterPSEvent() メソッドに登録された PS Listener の登録を解除します。 現在登録されている listener がなければ、このメソッドは何もしません、

パラメーター:
listener - 登録が解除される ECLPSListener オブジェクト。
type - 通知イベント・タイプ。 有効な値は、 ホスト生成イベントの通知の場合は HOST_EVENTS、 ユーザー (または API) 生成イベントの通知の場合は USER_EVENTS、 USER_EVENTS と HOST_EVENTS の両方の通知の場合は ALL_EVENTS です。
関連項目:
UnregisterPSEvent, ECLPSListener
 o WaitForAttrib
 public boolean WaitForAttrib(int row,
                              int col,
                              char attrib,
                              int plane) throws ECLErr, InterruptedException
属性が指定の行と桁の位置に表示されるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
attrib - 属性値
plane - 属性のプレーン 有効な定数の値は以下のとおりです。
FIELD_PLANE - 属性はフィールド属性
EXFIELD_PLANE - 属性は拡張フィールド属性
COLOR_PLANE - 属性はカラー属性
関連項目:
WaitForAttrib
 o WaitForAttrib
 public boolean WaitForAttrib(int row,
                              int col,
                              char attrib,
                              int plane,
                              long timeOut,
                              boolean waitForInput) throws ECLErr, InterruptedException
属性が指定の行と桁の位置に表示されるまで、 またはメソッドがタイムアウトになるまで同期待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
attrib - 属性値。
plane - 属性のプレーン。 有効な定数の値は以下のとおりです。
FIELD_PLANE - 属性はフィールド属性
EXFIELD_PLANE - 属性は拡張フィールド属性
COLOR_PLANE - 属性はカラー属性
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
関連項目:
WaitForAttrib
 o WaitForCursor
 public boolean WaitForCursor(int row,
                              int col) throws InterruptedException
カーソルが指定の行と桁の位置に表示されるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
関連項目:
WaitForCursor
 o WaitForCursor
 public boolean WaitForCursor(int row,
                              int col,
                              long timeOut,
                              boolean waitForInput) throws InterruptedException
カーソルが指定の行と桁の位置に表示されるまで、 またはメソッドがタイムアウトになるまで同期待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
関連項目:
WaitForCursor
 o WaitForScreen
 public boolean WaitForScreen(ECLScreenDesc screenDesc) throws ECLErr, InterruptedException
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されるまで同期待機します。 注: OIA フラグの待機は ECLScreenDesc オブジェクトで設定します。 パラメーターとして待機メソッドに渡されることはありません。

パラメーター:
screenDesc - 画面を説明するオブジェクト。
関連項目:
WaitForScreen, ECLScreenDesc
 o WaitForScreen
 public boolean WaitForScreen(ECLScreenDesc screenDesc,
                              long timeOut) throws ECLErr, InterruptedException
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されるのを同期待機します。 注: OIA フラグの待機は ECLScreenDesc オブジェクトで設定します。 パラメーターとして待機メソッドに渡されることはありません。

パラメーター:
screenDesc - 画面を説明するオブジェクト。
timeOut - 待ち時間 (ミリ秒) を示します
関連項目:
WaitForScreen, ECLScreenDesc
 o WaitForString
 public boolean WaitForString(String str) throws InterruptedException
文字列がプレゼンテーション・スペースに表示されるまで同期待機します。 また、OIA の入力が有効になるまで待機します。 文字列の待機には、大文字小文字の区別があります。

パラメーター:
str - 待機する文字列
関連項目:
WaitForString, WaitForString
 o WaitForString
 public boolean WaitForString(String str,
                              int row,
                              int col) throws InterruptedException
文字列が指定位置に表示されるまで同期待機します。 また、OIA の入力が有効になるまで待機します。 文字列の待機には、大文字小文字の区別があります。

パラメーター:
str - 待機する文字列
row - 開始行の位置
col - 開始桁の位置
関連項目:
WaitForString, WaitForString
 o WaitForString
 public boolean WaitForString(String str,
                              int row,
                              int col,
                              long timeOut,
                              boolean waitForInput,
                              boolean caseSensitive) throws InterruptedException
文字列が指定位置に表示されるまで同期待機します。

パラメーター:
str - 待機する文字列
row - 開始行の位置
col - 開始桁の位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
caseSensitive - true の場合、 文字列の待機には、大文字小文字の区別があります
関連項目:
WaitForString, WaitForString
 o WaitForStringInRect
 public boolean WaitForStringInRect(String str,
                                    int sRow,
                                    int sCol,
                                    int eRow,
                                    int eCol) throws InterruptedException
文字列が指定の長方形に表示されるまで同期待機します。 また、OIA の入力が有効になるまで待機します。 文字列の待機には、大文字小文字の区別があります。

パラメーター:
str - 待機する文字列
sRow - 長方形の左上隅の行位置
sCol - 長方形の左上隅の桁位置
eRow - 長方形の右下隅の行位置
eCol - 長方形の右下隅の桁位置
関連項目:
WaitForStringInRect
 o WaitForStringInRect
 public boolean WaitForStringInRect(String str,
                                    int sRow,
                                    int sCol,
                                    int eRow,
                                    int eCol,
                                    long timeOut,
                                    boolean waitForInput,
                                    boolean caseSensitive) throws InterruptedException
文字列が指定の長方形に表示されるまで同期待機します。

パラメーター:
str - 待機する文字列
sRow - 長方形の左上隅の行位置
sCol - 長方形の左上隅の桁位置
eRow - 長方形の右下隅の行位置
eCol - 長方形の右下隅の桁位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
caseSensitive - true の場合、 文字列の待機には、大文字小文字の区別があります
関連項目:
WaitForStringInRect
 o WaitWhileAttrib
 public boolean WaitWhileAttrib(int row,
                                int col,
                                char attrib,
                                int plane) throws ECLErr, InterruptedException
属性が指定の行と桁の位置に存在しなくなるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
attrib - 属性値
plane - 属性のプレーン
関連項目:
WaitWhileAttrib
 o WaitWhileAttrib
 public boolean WaitWhileAttrib(int row,
                                int col,
                                char attrib,
                                int plane,
                                long timeOut,
                                boolean waitForInput) throws ECLErr, InterruptedException
属性が指定の行と桁の位置に存在しなくなるまで同期待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
attrib - 属性値
plane - 属性のプレーン。 有効な定数の値は以下のとおりです。
FIELD_PLANE - 属性はフィールド属性
EXFIELD_PLANE - 属性は拡張フィールド属性
COLOR_PLANE - 属性はカラー属性
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
関連項目:
WaitWhileAttrib
 o WaitWhileCursor
 public boolean WaitWhileCursor(int row,
                                int col) throws InterruptedException
カーソルが指定の行と桁の位置に表示されなくなるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
関連項目:
WaitWhileCursor
 o WaitWhileCursor
 public boolean WaitWhileCursor(int row,
                                int col,
                                long timeOut,
                                boolean waitForInput) throws InterruptedException
カーソルが指定の行と桁の位置に表示されなくなるまで、 またはメソッドがタイムアウトになるまで同期待機します。

パラメーター:
row - カーソルの行位置
col - カーソルの桁位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
関連項目:
WaitWhileCursor
 o WaitWhileScreen
 public boolean WaitWhileScreen(ECLScreenDesc screenDesc) throws ECLErr, InterruptedException
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されなくなるまで同期待機します。 注: OIA フラグの待機は ECLScreenDesc オブジェクトで設定します。 パラメーターとして待機メソッドに渡されることはありません。

パラメーター:
screenDesc - 画面を説明するオブジェクト。
関連項目:
WaitWhileScreen, ECLScreenDesc
 o WaitWhileScreen
 public boolean WaitWhileScreen(ECLScreenDesc screenDesc,
                                long timeOut) throws ECLErr, InterruptedException
ECLScreenDesc によって記述されているとおり、 画面がプレゼンテーション・スペースに表示されなくなるまで同期待機します。 注: OIA フラグの待機は ECLScreenDesc で設定します。 パラメーターとして待機メソッドに渡されることはありません。

パラメーター:
screenDesc - 画面を説明するオブジェクト。
timeOut - 待ち時間 (ミリ秒) を示します
関連項目:
WaitWhileScreen, ECLScreenDesc
 o WaitWhileString
 public boolean WaitWhileString(String str) throws InterruptedException
文字列がプレゼンテーション・スペースに表示されなくなるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
str - 待機する文字列
関連項目:
WaitWhileString, WaitWhileString
 o WaitWhileString
 public boolean WaitWhileString(String str,
                                int row,
                                int col) throws InterruptedException
文字列が指定位置に存在しなくなるまで同期待機します。 また、OIA の入力が有効になるまで待機します。 文字列の待機には、大文字小文字の区別があります。

パラメーター:
str - 待機する文字列
row - 開始行の位置
col - 開始桁の位置
関連項目:
WaitWhileString, WaitWhileString
 o WaitWhileString
 public boolean WaitWhileString(String str,
                                int row,
                                int col,
                                long timeOut,
                                boolean waitForInput,
                                boolean caseSensitive) throws InterruptedException
文字列が指定位置に存在しなくなるまで同期待機します。

パラメーター:
str - 待機する文字列
row - 開始行の位置
col - 開始桁の位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
caseSensitive - true の場合、 文字列の待機には、大文字小文字の区別があります
関連項目:
WaitWhileString, WaitWhileString
 o WaitWhileStringInRect
 public boolean WaitWhileStringInRect(String str,
                                      int sRow,
                                      int sCol,
                                      int eRow,
                                      int eCol) throws InterruptedException
文字列が指定の長方形に存在しなくなるまで同期待機します。 また、OIA の入力が有効になるまで待機します。

パラメーター:
str - 待機する文字桁
sRow - 長方形の左上隅の行位置
sCol - 長方形の左上隅の桁位置
eRow - 長方形の右下隅の行位置
eCol - 長方形の右下隅の桁位置
関連項目:
WaitWhileStringInRect
 o WaitWhileStringInRect
 public boolean WaitWhileStringInRect(String str,
                                      int sRow,
                                      int sCol,
                                      int eRow,
                                      int eCol,
                                      long timeOut,
                                      boolean waitForInput,
                                      boolean caseSensitive) throws InterruptedException
文字列が指定の長方形に存在しなくなるまで同期待機します。

パラメーター:
str - 待機する文字列
sRow - 長方形の左上隅の行位置
sCol - 長方形の左上隅の桁位置
eRow - 長方形の右下隅の行位置
eCol - 長方形の右下隅の桁位置
timeOut - 待ち時間 (ミリ秒) を示します
waitForInput - true の場合、 PS の入力準備が整ったことを OIA が示すまで待機します。
caseSensitive - true の場合、 文字列の待機には、大文字小文字の区別があります
関連項目:
WaitWhileStringInRect
 o GetFieldList
 public ECLFieldList GetFieldList() throws ECLErr
GetFieldList は、現在の PS に基づいて ECLFieldList のインスタンスを戻します。 フィールド・リストには、 プレゼンテーション・スペース内のフィールドの集合が入っています。 このクラスには、フィールド間を反復して、 位置に基づくフィールドの検索、 および指定した文字列を含むフィールドの検索を行うためのメソッドがあります。 このリストの各要素が ECLField のインスタンスです。

この形式のメソッドでは、 各フィールド・オブジェクトにテキスト・プレーン情報だけが含まれているフィールド・リストが作成されます。

Throw (例外) : ECLErr
プレーンのパラメーターが無効か、 またはフィールド・リストを作成する際にエラーが発生した場合に throw されます。
関連項目:
GetFieldList, ECLFieldList
 o GetFieldList
 public ECLFieldList GetFieldList(int planes) throws ECLErr
GetFieldList は、現在の PS に基づいて ECLFieldList のインスタンスを戻します。 フィールド・リストには、 プレゼンテーション・スペース内のフィールドの集合が入っています。 このクラスには、フィールド間を反復して、 位置に基づくフィールドの検索、 および指定した文字列を含むフィールドの検索を行うためのメソッドがあります。 このリストの各要素が ECLField のインスタンスです。

この形式のメソッドでは、 プレーンだけが指定されているフィールド・リストが作成されます。

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

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