Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

getHeader

类: matlab.mixin.CustomDisplay
命名空间: matlab.mixin

构建自定义显示头部文本

全页展开

语法

s = getHeader(obj)

说明

s = getHeader(obj) 返回显示对象数组 obj 时用作头部的文本 s。对整个对象数组调用一次此方法。

覆盖此方法以创建自定义头部。覆盖实现必须支持该对象的所有状态，包括标量、非标量、空和已删除（如果 obj 是句柄类的实例）。

输入参数

全部展开

要对其应用自定义头部的对象数组。obj 的类必须从 matlab.mixin.CustomDisplay 派生。

输出参数

全部展开

自定义头部文本，以 char 数组形式返回。根据输入 obj，默认实现返回：

  • 标量 - 非包限定的类名称

  • 非标量 - 非包限定的类名称和维度

  • 空 - 空 char

  • 已删除的句柄 - 文本 "deleted classname handle"

类名称链接到该类的 MATLAB® 文档。选择链接会显示 helpPopup 窗口。

如果您覆盖此方法，您可能需要用换行符 (\n) 终止 s。

属性

Accessprotected

要了解方法的属性，请参阅方法属性。

示例

全部展开

Tester 类有一个属性 ObjectUnderTest，它可以接受任何类型的值。添加 getHeader 方法，对于标量实例，该方法标识属性值的类，然后将该类的名称附加到头部。

classdef Tester < matlab.mixin.CustomDisplay
    properties
        ObjectUnderTest
    end
    methods(Access = protected)
        function out = getHeader(obj)
            if ~isscalar(obj)
                out  = getHeader@matlab.mixin.CustomDisplay(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 中推出

另请参阅

|

主题