Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

getHeader

クラス: matlab.mixin.CustomDisplay
パッケージ: matlab.mixin

表示ヘッダー テキストを作成して返す

このページをすべて展開する

構文

s = getHeader(obj)

説明

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

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

入力引数

obj

matlab.mixin.CustomDisplay から派生したクラスのオブジェクト配列

出力引数

s

ヘッダー文字列。char 配列として返されます。

既定の実装は次の結果を返します。

  • obj がスカラーの場合、簡単なクラス名 (非パッケージ修飾名) である classname を返します。

  • obj が非スカラーの場合、classname と次元を返します。

  • obj が空の場合、空の char を返します。

  • obj が削除されたハンドルの場合、文字列 deleted classname handle を返します。

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

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

例

すべて展開する

テキスト 'with Customized Display' をヘッダー テキストに追加します。

getHeader メソッドを記述します。

methods (Access = protected)
   function header = getHeader(obj)
      if ~isscalar(obj)
         header = getHeader@matlab.mixin.CustomDisplay(obj);
      else
         headerStr = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
         headerStr = [headerStr,' with Customized Display'];
         header = sprintf('%s\n',headerStr);
      end
   end
end

クラス定義に getHeader メソッドを追加します。

属性

Accessprotected

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

参考

|

トピック