ConsoleField プロパティーおよびフィールド

以下のプロパティーは、ConsoleField 型の変数で必須です。

名前」フィールドも必須ですが、定数 ConsoleField では必須ではありません。

ConsoleField のプロパティーは以下のとおりです。
fieldLen
求める最大値を表示するために必要な桁数を指定します。 定数 consoleFields の場合、このプロパティーは設定しません。fieldLen は、 value プロパティーに含まれるように、表示される値によって占有される文字数です。
  • : INT
  • : fieldLen = 20
  • デフォルト: なし
position
書式内でのコンソール・フィールドのロケーション。このプロパティーには、 行番号およびその後に列番号の 2 つの正整数の配列が含まれています。 行番号は、書式の先頭から計算されます。同様に、 列番号は書式の左から計算されます。
  • : INT[]
  • : position = [2, 3]
  • デフォルト: [1,1]
segments
フィールド・セグメント の行、列、欄を指定します。 これは、区切り文字を入れることが可能な consoleField サブセクションです。複数行テキスト・ボックスの外観を生成 する場合、同じ書式列の連続する行で 1 つのフィールド・セグメントを積み重ね、 セグメントのコレクションは 1 つのフィールドとして機能します。
  • : INT[3][]
  • : segments = [[5,1,10],[6,1,10]]
  • デフォルト: なし

値が segments に対して指定済みの場合、position の値は無視され、 fieldLen は、結合されたすべてのセグメントの長さに設定されます。

複数のセグメントを指定する場合、 ConsoleField の振る舞いも、 「lineWrap」フィールドの値による影響を受けます。

validValues
ユーザー入力に有効な値のリストを指定します。
  • : 1 つの値からなるエレメントおよび 2 つの値からなるエレメントの配列リテラル
  • : validValues = [ [1,3], 5, 12 ]
  • デフォルト: なし

詳細については、『validValues』を参照してください。

consoleField 配列のプロパティーには、前述のプロパティー (segments を除く) および以下が含まれます。
columns
ConsoleField 型の配列のエレメントを表示する 列数を指定します。配列に 5 つのエレメントがあり、 columns プロパティーの値が 2 である場合、例えば、書式の最初の行は 2 つのエレメントを、 2 行目は 2 つのエレメントを、3 行目は 1 つのエレメントをそれぞれ表示します。
  • : INT
  • : columns = 3
  • デフォルト: 1

このプロパティーは、ConsoleField 型の配列に対してのみ意味があります。 画面上の配列エレメントの配分 (横または上下) は、 プロパティー orientIndexAcross による影響を受けます。

linesBetweenRows
配列エレメントが含まれる各行の間のブランク行の数を指定します。
  • : INT
  • : linesBetweenRows = 3
  • デフォルト: 0

このプロパティーは、ConsoleField 型の配列に対してのみ意味があります。

orientIndexAcross
後述の例で示されるように、配列エレメントの配分が画面の横方向であるかどうかを指定します。
  • : ブール
  • : orientIndexAcross = yes
  • デフォルト: yes

このプロパティーは、consoleField 型の配列に対してのみ意味があります。

プロパティー orientIndexAcrossyes に設定される場合、連続する配列のエレメントは左から右へ 表示されます。以下の 2 列の例では、 連続する各エレメントは、エレメント指標と同等の整数を表示します。
  1   2
  3   4
  5
プロパティー orientIndexAcrossno に設定される場合、 連続するエレメントは上から下へ表示されます。
  1   4
  2   5
  3
spacesBetweenColumns
フィールドの各欄を分離するスペースの数を指定します。
  • : INT
  • : spacesBetweenColumns = 3
  • デフォルト: 1

このプロパティーは、consoleField 型の配列に対してのみ有効です。

ConsoleField のフィールドは以下のとおりです。
align
align」フィールドは、変数フィールドにおいてデータの長さがフィールドの長さより小さい場合に データの位置を指定します。
  • : AlignKind
  • : align = left
  • デフォルト: 文字またはタイム・スタンプ・データは左側、数値は右側
  • 実行時の更新可能性: あり
このオプションの値は、次のとおりです。
left
データをフィールドの左側に配置します。開始スペースは除去され、フィールドの末尾に置かれます。
none
データを位置調整しません。この設定は、文字データについてのみ有効です。
right
データをフィールドの右側に配置します。末尾スペースは除去され、フィールドの先頭に置かれます。
autonext
ユーザーが現在の ConsoleField を埋めた後、カーソルが次のフィールドに 移動するかどうかを指定します。
  • : ブール
  • : autonext = yes
  • デフォルト: なし
  • 実行時の更新可能性: あり

タブ順序は、『ConsoleUI パーツおよび関連する変数』で説明されているように、 どの ConsoleField が次に来るかを決定します。

binding
デフォルトで、ConsoleField をバインドする変数の名前を指定します。
  • : String
  • : binding = "myVar"
  • デフォルト: なし
  • 実行時の更新可能性: なし

バインディングの概要については、『ConsoleUI パーツおよび関連する変数』を参照してください。

caseFormat
大/小文字の区別に関して、入出力の扱い方を指定します。
  • : CaseFormatKind
  • : caseFormat = lowerCase
  • デフォルト: defaultCase
  • 実行時の更新可能性: あり
このオプションの値は、次のとおりです。
defaultCase (デフォルト)
大/小文字について影響を及ぼしません
lowerCase
可能な場合は、文字を小文字に変換します
upperCase
可能な場合は、文字を大文字に変換します
color
ConsoleField のテキストの色を指定します。
  • : ColorKind
  • : color = red
  • デフォルト: white
  • 実行時の更新可能性: 可能ですが、更新が視覚的に影響するのは、 フィールドが更新された後、ConsoleField が表示されている (またはフォーカスを取得する) 場合に限られます。
このオプションの値は、次のとおりです。
defaultColor または white (デフォルト)
black
blue
cyan
シアン
green
magenta
マジェンタ
red
yellow
黄色
comment
コメント を指定します。コメントは、カーソルが ConsoleField にある際に、 ウィンドウ固有のコメント行があればそのコメント行に表示されるテキストです。
  • : String
  • : 「従業員の名前」
  • デフォルト: 空ストリング
  • 実行時の更新可能性: なし
commentKey
コメント が含まれるリソース・バンドルを検索するために使用するキーを指定します。 コメントは、カーソルが ConsoleField にある際に、ウィンドウ固有のコメント行があれば そのコメント行に表示されるテキストです。commentcommentKey の両方を指定した場合、comment が 使用されます。
  • : String
  • : commentKey = "myKey"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: なし

リソース・バンドルは、messageResource で説明されているように、システム変数 ConsoleLib.messageResource によって指定されます。

dataType
データ型を識別するためのストリングを指定します。この値を使用して、 ユーザー入力 (= 1.5 など) が特定の種類の SQL 列と互換性があることを検証します。 このフィールドは、ConsoleField (または関連する ConsoleForm) の openUI 文が 文プロパティー isConstruct を含む場合にのみ意味があります。
  • : String
  • : dataType = "NUMBER"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: なし

数値入力に関して、ユーザーが浮動小数点値を指定できるようにする場合 (そのような場合、> 1.5 は有効なユーザー入力)、値 "NUMBER" を指定します。 その他の場合、例えば "INT" などの整数のストリング相当語句を指定します。

dateFormat
出力のフォーマット方法を示しますが、dateFormat は、 ConsoleField が日付を受諾する場合のみ指定します。
  • : String または日付に関連するシステム定数
  • : dateFormat = isoDateFormat
  • デフォルト: なし
  • 実行時の更新可能性: なし
有効な値は以下のとおりです。
"pattern"
pattern の値は、『日付、時刻、およびタイム・スタンプのフォーマット指定子』に示す 一連の文字から構成されます。

文字は、完全な日付指定の先頭または末尾から除去することができますが、 中央から除去することはできません。

defaultDateFormat
ランタイム Java™ ロケールで指定された日付形式。
isoDateFormat
「yyyy-MM-dd」パターン (International Standards Organization (ISO) により指定された日付形式)
usaDateFormat
「MM/dd/yyyy」パターン (IBM® USA 標準規格の日付形式)。
eurDateFormat
「dd.MM.yyyy」パターン (IBM 欧州標準規格の日付形式)。
jisDateFormat
「yyyy-MM-dd」パターン (日本工業規格 (JIS) 日付形式)。
systemGregorianDateFormat
dd (その月の日数)、MM (月数)、および yy か yyyy (年数) を、 d、M、y、または数字以外の、区切り文字として使用される文字と共に含む、 8 または 10 文字のパターン。
この書式は、次の Java ランタイム・プロパティーにあります。
  vgj.datemask.gregorian.long.NLS
NLS
Java ランタイム・プロパティー vgj.nls.code に指定されている NLS (各国語サポート) コード。このコードは、『targetNLS』にリストされているコードの 1 つです。大文字の英語 (コード ENP) はサポートされていません。

vgj.nls.code の詳細については、『Java ランタイム・プロパティー (詳細)』を参照してください。

systemJulianDateFormat
DDD (その年の日数) および yy か yyyy (年数) を、 D、y、または数字以外の、区切り文字として使用される文字と共に含む、 6 または 8 文字のパターン。
この書式は、次の Java ランタイム・プロパティーにあります。
  vgj.datemask.julian.long.NLS
NLS
Java ランタイム・プロパティー vgj.nls.code に指定されている NLS (各国語サポート) コード。このコードは、『targetNLS』にリストされているコードの 1 つです。大文字の英語 (コード ENP) はサポートされていません。

vgj.nls.code の詳細については、『Java ランタイム・プロパティー (詳細)』を参照してください。

editor
ユーザーのデータとの対話用のプログラムを指定しますが、 ConsoleField が LOB タイプの変数にバインドされる場合のみ意味があります。
  • : String
  • : editor = "/bin/vi"
  • デフォルト: なし
  • 実行時の更新可能性: あり

PATH または LIBPATH で検出される実行可能ファイルの名前を指定することができます。 別の方法として、その実行可能ファイルの完全修飾パスを指定することができます。

help
以下の状態が有効であるときに表示するテキストを指定します。
  • カーソルが ConsoleField にある。さらに、
  • ユーザーが、ConsoleLib.key_help で識別されるキーを押す。
  • : String
  • : help = "Update the value"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: あり
helpKey
以下の状況がいつ有効かを表示するためのテキストが含まれるリソース・バンドルを検索するための アクセス・キーを指定します。
  • カーソルが ConsoleField にある。さらに、
  • ユーザーが、ConsoleLib.key_help で識別されるキーを押す。
helphelpKey の両方を指定した場合、help が使用されます。
  • : String
  • : helpKey = "myKey"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: あり

リソース・バンドルは、messageResource で説明されているように、システム変数 ConsoleLib.messageResource によって指定されます。

highlight
ConsoleField が表示されている際に使用される特殊効果がある場合は、 これを指定します。
  • : HighlightKind[]
  • : highlight = [reverse, underline]
  • デフォルト: [noHighLight]
  • 実行時の更新可能性: 可能ですが、更新が視覚的に影響するのは、 highlight フィールドが更新された後、ConsoleField が表示されている (またはフォーカスを取得する) 場合に限られます。
このオプションの値は、次のとおりです。
noHighlight (デフォルト)
特殊効果は起こりません。この値を使用すると、他をオーバーライドします。
blink
効果はありません。
reverse
テキストおよび背景色を反転し、 (例えば) 黒の背景色に淡色文字を表示した場合に背景色は白で、テキストは黒になります。
アンダーライン
影響される領域の下部にアンダーラインを配置します。アンダーラインの色は、 値 reverse が指定済みの場合でもテキストの色になります。
initialValue
表示の初期値を指定します。initialValueinitialValueKey の両方を指定する場合、initialValue が使用されます。
  • : String
  • : initialValue = "200"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: あり

openUI 文の setInitial プロパティーが true に設定されている場合、 consoleField の initialValue プロパティーの値が使用されます。 ただし、openUI プロパティーが false である場合、バインド済み変数の現行値が代わりに表示され、 initialValue プロパティーの値は無視されます。

initialValueKey
表示の初期値が含まれるリソース・バンドルを検索するためのアクセス・キーを指定します。 initialValueinitialValueKey の両方を指定する場合、initialValue が使用されます。
  • : String
  • : initialValueKey = "myKey"
  • デフォルト: 空ストリング
  • 実行時の更新可能性: あり

リソース・バンドルは、messageResource で説明されているように、システム変数 ConsoleLib.messageResource によって指定されます。

inputRequired
ユーザーが、値を入力しないでフィールドからナビゲートできないようにするかどうかを 示します。
  • : ブール
  • : inputRequired = yes
  • デフォルト: no
  • 実行時の更新可能性: なし
intensity
表示フォントを強調する度合いを指定します。
  • : IntensityKind[]
  • : intensity = [bold]
  • デフォルト: [normalIntensity]
  • 実行時の更新可能性: 可能ですが、更新が視覚的に影響するのは、 「intensity」フィールドが更新された後、ConsoleField が表示されている (またはフォーカスを取得する) 場合に限られます。
このオプションの値は、次のとおりです。
normalIntensity (デフォルト)
特殊効果は起こりません。この値を使用すると、他をオーバーライドします。
bold
テキストを太字フォントで表示します。
dim
この時点では効果はありません。将来、入力フィールドが使用不可になる場合や強調解除する場合に、 必要に応じて、テキストが小さい輝度で表示される場合があります。
invisible
書式上にフィールドがあることを示さないようにします。
isBoolean
ConsoleField がブール値を表すかどうかを示します。「isBoolean」フィールドは 有効な ConsoleField 値を制限し、入力または出力に役立ちます。

数値フィールドの値は 0 (false) または 1 (true)。

文字フィールドの 値は、各国後に依存した語または語のサブセットにより示され、固有値はロケールによって決定されます。 例えば英語では、3 つ以上の文字のブール値フィールドは、値 yes (true) または no (false) をとり、1 文字のブール値フィールドは y または n のように値が切り捨てられます。
  • : ブール
  • : isBoolean = yes
  • デフォルト: no
  • 実行時の更新可能性: なし
lineWrap
テキストの切り捨てを回避するために折り返しが必要な場合に、 新規行にテキストを折り返す方法を示します。
  • : LineWrapType
  • : value = compress
  • デフォルト: 文字
  • 実行時の更新可能性: あり
このオプションの値は、次のとおりです。
character (デフォルト)
フィールド内のテキストは、ホワイト・スペースで分割されませんが、フィールド・セグメントの境界がある文字位置で 分割されます。
compress
可能な場合、テキストはホワイト・スペースで分割されます。ユーザーが (別の consoleField に移動するか、Esc キーを押すことにより) consoleField から離れると、 その値がバインド済みの変数に割り当てられ、テキストの折り返しに使用される余分なスペースはすべて除去されます。
word
可能な場合、フィールド内のテキストはホワイト・スペースで分割されます。 値がバインド済みの変数に割り当てられる場合、 ワード境界で折り返しをするために値を埋め込んだ方法を反映するために、余分なスペースが含まれます。

lineWrap」フィールドは、 segments プロパティーによって制御済みであり、複数セグメントを持つ ConsoleField に対してのみ意味があります。

masked
ユーザーがパスワードを入力する場合に、ConsoleField の各文字を アスタリスク (*) で表示するかどうかを示します。
  • : ブール
  • : masked = yes
  • デフォルト: no
  • 実行時の更新可能性: あり
minimumInput
有効な入力の最小文字数を示します。
  • : INT
  • : minimumInput = 4
  • デフォルト: no
  • 実行時の更新可能性: なし
name
ConsoleField 名で、実行時に名前が解決されるプログラミング・コンテキストで使用されます。 名前フィールドの値を変数の名前と同じにすることを特にお勧めします。
  • : String
  • : name = "myField"
  • デフォルト: なし
  • 実行時の更新可能性: なし
numericFormat
出力のフォーマット方法を示しますが、numericFormat は、 ConsoleField が数値を受諾する場合のみ指定します。
  • : String
  • : numericFormat = "-###@"
  • デフォルト: なし
  • 実行時の更新可能性: なし
有効な文字は以下のとおりです。
#
数字のプレースホルダー。
*
先行ゼロの充てん文字としてアスタリスク (*) を使用します。
&
先行ゼロの充てん文字としてゼロを使用します。
#
先行ゼロの充てん文字としてスペースを使用します。
<
数値の左揃え。
,
位置に先行ゼロが含まれない限り、ロケール依存の数字分離記号を使用します。
.
ロケール依存の小数点を使用します。
-
0 より小さい値には負符号 (-) を使用し、 0 より大または等しい値にはスペースを使用します。
+
0 より小さい値には負符号 (-) を使用し、0 より大または等しい値には正符号 (+) を使用します。
(
会計では必要に応じて、負の値の先頭に左括弧を置きます。
)
会計では必要に応じて、負の値の後に右括弧を置きます。
$
値の先頭にロケール依存の通貨記号を配置します。
@
値の後にロケール依存の通貨記号を置きます。
pattern
ConsoleField の内容が文字タイプである場合、入出力フォーマットの パターンを指定します。
  • : String
  • : pattern = "(###) ###-####"
  • デフォルト: なし
  • 実行時の更新可能性: なし
以下の制御文字が使用可能です。
  • A は文字のプレースホルダーで、文字と見なされる文字のサブセットは ロケールに依存します
  • # は数字のプレースホルダーです
  • X は任意の種類の必須文字のプレースホルダーです
前述の 3 種類以外の文字が入力または出力に含まれますが、 出力の場合、オーバーレイした文字は失われます。
  • 出力パターンが「(###) ###-####」である場合、値「6219655561212」は以下のように表示されます。
      (219) 555-1212

    オリジナルの値の 6 は、 ユーザーに対して使用不可で、データ・ストアが更新される場合に失われます。

  • 入力の場合、カーソルはリテラル文字をスキップし、プレースホルダー文字が発生する場所でのみ入力が許可されます。 現在の例では、ユーザーが 2195551212 を入力すると、 ストリング「(219) 555-1212」は ConsoleField 内で値になり、 バインド済みの変数で置かれた値です。
protect
ConsoleField がユーザー更新から保護されるかどうかを指定します。
  • : ブール
  • : protect = yes
  • デフォルト: no
  • 実行時の更新可能性: なし
このオプションの値は、次のとおりです。
No (デフォルト)
ユーザーがフィールドの値を上書きできるよう設定します。
Yes
ユーザーが値を上書きできないように consoleField を設定します。 また、次のいずれかの場合には、ユーザーがナビゲートを試行する際に カーソルは consoleField をスキップします。
  • ユーザーがタブ順序の直前の consoleField を操作しているときに、 (a) Tab を押したか、(b) フィールド autonext が yes に設定される場合に 直前の consoleField に内容を充てんした場合。
  • ユーザーがタブ順序の次の consoleField を操作していて、Shift + Tab を押した場合。
  • ユーザーは矢印キーを使用して、次または直前の consoleField に移動します。

保護されている、または保護されていない consoleField に変数をバインドすることができます。 openUI プロパティー setInitial の設定は、バインド済みの変数の値が表示されるかどうかを決定します。

プログラムが consoleField に移動しようとすると、保護されているランタイム・エラーが発生します。

SQLColumnName
ConsoleField に関連付けられているデータベース・テーブルの列の名前を指定します。 この名前は、ConsoleField (または関連した ConsoleForm) の openUI 文に 文プロパティー isConstruct が含まれる場合に、検索基準を生成するために使用されます。
  • : String
  • : SQLColumnName = "ID"
  • デフォルト: なし
  • 実行時の更新可能性: あり
timeFormat
出力のフォーマット方法を示しますが、timeFormat は、 ConsoleField が時刻を受諾する場合のみ指定します。
  • : String または時刻に関連するシステム定数
  • : timeFormat = isoTimeFormat
  • デフォルト: なし
  • 実行時の更新可能性: なし
有効な値は以下のとおりです。
"pattern"
pattern の値は、『日付、時刻、およびタイム・スタンプのフォーマット指定子』に示す 一連の文字から構成されます。

文字は、完全な時刻指定の先頭または末尾から除去することができますが、 中央から除去することはできません。

defaultTimeFormat
ランタイム Java ロケールで指定された時刻形式。
isoTimeFormat
「HH.mm.ss」パターン (International Standards Organization (ISO)) により指定された時刻形式。
usaTimeFormat
「hh:mm AM」パターン (IBM USA 標準規格の時刻形式)。
eurTimeFormat
「HH.mm.ss」パターン (IBM 欧州標準規格の時刻形式)。
jisTimeFormat
「HH:mm:ss」パターン (日本工業規格の時刻形式)。
timestampFormat
出力のフォーマット方法を示しますが、timestampFormat は、ConsoleField がタイム・スタンプを受諾する場合のみ指定します。
  • : String またはタイム・スタンプに関連するシステム定数
  • : timestampFormat = odbcTimestampFormat
  • デフォルト: なし
  • 実行時の更新可能性: なし
有効な値は以下のとおりです。
"pattern"
pattern の値は、『日付、時刻、およびタイム・スタンプのフォーマット指定子』に示す 一連の文字から構成されます。

文字は、完全なタイム・スタンプ指定の先頭または末尾から除去することができますが、 中央から除去することはできません。

defaultTimestampFormat
ランタイム Java ロケールで指定されたタイム・スタンプ・フォーマット。
db2TimeStampFormat
「yyyy-MM-dd-HH.mm.ss.ffffff」パターン (IBM DB2® のデフォルトのタイム・スタンプ・フォーマット)。
odbcTimestampFormat
「yyyy-MM-dd HH:mm:ss.ffffff」パターン (ODBC のタイム・スタンプ・フォーマット)。
value
consoleField に表示される現行値。ご使用のコードは、 ConsoleLib.displayForm を呼び出して consoleField に指定済みの値を表示するように、この値を設定することができます。
  • : String
  • : value = "View"
  • デフォルト: なし
  • 実行時の更新可能性: あり
verify
ユーザーが ConsoleField を終了しようとした後、 同じ値を再入力するようにプロンプトを出すかどうかを示します。
  • : ブール
  • : verify = yes
  • デフォルト: no
  • 実行時の更新可能性: なし
このオプションの値は、次のとおりです。
No (デフォルト)
EGL ランタイムは特殊プロンプトを発行しません。
Yes
ユーザーが ConsoleField を離れようとすると、EGL ランタイムは次のように機能します。
  • カーソルを残したまま、consoleField をクリアする
  • ユーザーが入力を繰り返すようにメッセージを表示する
  • ユーザーが consoleField を離れようとする場合、2 つの入力値を比較する

値が一致する場合、バインド済みの変数はその値を受け取り、処理が通常通り続行します。 値が一致しない場合、consoleField の内容は 2 つのユーザー入力のうち最初のものの先頭の値に戻り、 カーソルはフィールドに残ります。

フィードバック
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.