getHeader

クラス: matlab.mixin.CustomDisplay
名前空間: matlab.mixin

カスタマイズした表示ヘッダー テキストの作成

構文

s = getHeader(obj)


説明

s = getHeader(obj) は、オブジェクト配列 obj を表示するときに、ヘッダーとして使用されるテキスト s を返します。このメソッドは、オブジェクト配列全体で一度だけ呼び出されます。

このメソッドをオーバーライドし、カスタム ヘッダーを作成します。このオーバーライド実装は、スカラー、非スカラー、空、削除済み (obj がハンドル クラスのインスタンスである場合) などの状態を含む、オブジェクトのすべての状態をサポートしなければなりません。

入力引数

obj — カスタム ヘッダーを適用するオブジェクト

オブジェクト配列

カスタム ヘッダーを適用するオブジェクト配列。obj のクラスは、matlab.mixin.CustomDisplay から取得しなければなりません。

出力引数

s — カスタム ヘッダー テキスト

char 配列

カスタム ヘッダー テキスト。char 配列として返されます。入力 obj に応じて、既定の実装は以下を返します。

• スカラー — 非名前空間修飾クラス名

• 非スカラー — 非名前空間修飾クラス名および次元

• 空 — 空の char

• 削除されたハンドル — テキスト "deleted classname handle"

クラス名は、クラスの MATLAB^® ドキュメンテーションにリンクされます。リンクを選択すると、helpPopup ウィンドウが表示されます。

このメソッドをオーバーライドする場合は、s を改行文字 (\n) で終了しなければならない場合があります。

属性

Access

protected

メソッドの属性の詳細については、メソッドの属性を参照してください。

例

スカラー オブジェクト用の既定のヘッダーをカスタマイズ

Tester クラスには、任意の型の値を取ることができる 1 つのプロパティ ObjectUnderTest があります。スカラー インスタンスの場合にプロパティ値のクラスを識別し、そのクラスの名前をヘッダーに追加する getHeader メソッドを追加します。

classdef Tester < matlab.mixin.CustomDisplay
    properties
        ObjectUnderTest
    end
    methods(Access = protected)
        function out = getHeader(obj)
            if ~isscalar(obj)
                out  = [e-mail](obj);
            else
                testerClass = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
                objectUnderTestClass = class(obj.ObjectUnderTest);
                headerStr = [testerClass ' for ' objectUnderTestClass];
                out =  sprintf('%s\n',headerStr);
            end
        end
    end
end

スカラー インスタンスを作成し、カスタマイズしたヘッダー テキストを確認します。

b = Tester;
b.ObjectUnderTest = int8(5)

b = 

Tester for int8

    ObjectUnderTest: 5

バージョン履歴

R2013b で導入

参考

getFooter | getPropertyGroups

トピック

• カスタム表示インターフェイス