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` 窗口。如果您覆盖此方法，您可能需要用换行符 (`\n`) 终止 `s`。

示例

全部展开

将文本追加到默认头部末尾

将文本 '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 方法添加到类定义。