フック一覧　BrightOnOff (画面フック) 前の画面フック 次の画面フック

VB C# ALL プログラミング言語によるフィルタ (ここで選んだ言語で選別された説明や図だけが表示されます)

BrightOnOff (ブライト処理) 画面フックメソッド

◇ 役割 (この画面フックメソッドに委託されている処理)

メソッド StartBrightCaption で開始した見出し欄ブライト処理に関する補助をする。 たとえば、イメージを配置した見出しボタンがある場合に、ブライト処理の一環としてイメージの色などを変更するというような標準ではない処理をすることができる。

◇ 配置 (ツーピーススタイルの場合にこの画面フックメソッドをどこに配置できるか)

ローカルピースに配置するか、または配置しない。セントラルピースに配置することは禁止されている。

◇ 代表的な書き方 (詳しい構文はフックメソッドの書き方を参照)

VB での書き方:
　Friend Function BrightOnOff(パラメタ宣言列) As Boolean
　または
　Friend Function 画面略称_BrightOnOff(パラメタ宣言列) As Boolean

C# での書き方:
　internal bool BrightOnOff(パラメタ宣言列)
　または
　internal bool 画面略称_BrightOnOff(パラメタ宣言列)

Java での書き方:
　boolean BrightOnOff(パラメタ宣言列)
　または
　boolean 画面略称_BrightOnOff(パラメタ宣言列)

なお、フック名としては、BrightOnOff の他にブライト処理を用いることができる。

◇ 呼び出される契機 (以下が切っ掛けとなりこのフックメソッドが呼び出される)

標準の見出し欄ブライト処理がなされた直後に呼び出される。これは各項目ごとにブライト状態にする処理と非ブライト状態に戻す処理がなされる。

◇ 戻り値の意味とデフォルト動作 (戻り値による FormBase への伝言)

(戻り値に意味なし)

◇ 代行メッセージ (処理の流れに応じて発せられるメッセージ; カスタマイズ可能)

(関係する代行メッセージなし)

◇ 使用上のヒントと注意事項

画面オプション「ブライト処理」がオンでないと、このフックメソッドは呼び出されない。

メソッド StartBrightCaption を呼び出さないと、このフックメソッドは呼び出されない。

標準の見出し欄ブライト処理でよい場合には、このフックメソッドを記述する必要はない。

このフックメソッドの中では、以下の変数を参照することができる。

(ただし fB は、クラス FormBase のインスタンスであり、このフックメソッドのパラメタとして指定したもの)

◇ 関連事項

◇ 使用例

' ブライト処理の補助 (イメージに関する処理) を行う (BrightOnOff)。
Friend Function BrightOnOff(ByVal fB As FormBase) As Boolean
    If fB.ItemAbbreviation.ToUpper().Equals("TYPENAME") Then
        Dim friForm As Fr_Form = CType(fB.myForm, Fr_Form)
        If fB.BrightOn Then
            CType(fB.CsButton, Button).Image = friForm.Im_TypeName11.Image
        Else
            CType(fB.CsButton, Button).Image = friForm.Im_TypeName00.Image
        End If
    End If
    ' 
    Return True
End Function ' BrightOnOff

// ブライト処理の補助 (イメージに関する処理) を行う (BrightOnOff)。
internal bool BrightOnOff( FormBase fB ) {
    if (fB.ItemAbbreviation.ToUpper().Equals("TYPENAME")) {
        Fr_Form friForm = (Fr_Form)fB.myForm;
        if (fB.BrightOn) {
            ((Button)fB.CsButton).Image = friForm.Im_TypeName11.Image;
        }
        else {
            ((Button)fB.CsButton).Image = friForm.Im_TypeName00.Image;
        }
    }
    // 
    return true;
} // BrightOnOff

// ブライト処理の補助 (イメージに関する処理) を行う (BrightOnOff)。
boolean BrightOnOff( FormBase fB ) {
    if (fB.ItemAbbreviation.toUpperCase().equals("TYPENAME")) {
        Fr_Form friForm = (Fr_Form) fB.myForm;
        if (fB.BrightOn) {
            ((JButton) fB.CsButton).setIcon(friForm.Im_TypeName11.getIcon());
        } else {
            ((JButton) fB.CsButton).setIcon(friForm.Im_TypeName00.getIcon());
        }
    }
    // 
    return true;
} // BrightOnOff