matlab.mixin.CustomDisplay Class

Namespace: matlab.mixin

Interface for customizing object display

Description

This class provides an interface for customizing the way MATLAB^® displays objects. To add the custom display functionality to your class, derive your class from matlab.mixin.CustomDisplay.

classdef MySubClass < matlab.mixin.CustomDisplay
    ....
end

matlab.mixin.CustomDisplay defines protected methods that you can override in your subclass to customize object display. By overriding specific methods, you can customize specific aspects of the object display. For more information on customizing object display, see Custom Display Interface.

matlab.mixin.CustomDisplay also implements three public, sealed, and hidden methods: disp, display, and details.

disp and display provide a simple object display. The details method provides the formal display of object information.

Note

You cannot use matlab.mixin.CustomDisplay to derive a custom display for enumeration classes. For an alternative approach, see Overloading the disp Function

Class Attributes

`Abstract`	`true`
`HandleCompatible`	`true`

For information on class attributes, see Class Attributes.

Methods

expand all

Protected Methods

Object Array Display

`displayEmptyObject`	Display format for empty object arrays
`displayNonScalarObject`	Display format for nonscalar objects
`displayScalarObject`	Display format for scalar objects
`displayScalarHandleToDeletedObject`	Display format for deleted scalar handles
`convertDimensionsToString`	Return array dimensions as text

Linked Text Display

`getHandleText`	Return text `'handle'` with link to documentation
`getDeletedHandleText`	Return text for handle to deleted object display

Property Display

`displayPropertyGroups`	Display property groups with titles
`getPropertyGroups`	Construct array of customized property groups

Header and Footer Display

`getClassNameForHeader`	Return class name for display
`getHeader`	Build customized display header text
`getSimpleHeader`	Return simple header for object display
`getDetailedHeader`	Return default detailed header for object display
`getFooter`	Build customized display footer text
`getDetailedFooter`	Return default detailed footer for object display

Examples

collapse all

Add Custom Footer

This class adds a custom footer by overriding the getFooter method.

classdef MyClass < matlab.mixin.CustomDisplay
    properties
        Prop1 = 10
        Prop2
    end
    methods (Access = protected)
        function s = getFooter(~)
            s = 'Here is my custom footer';
        end
    end
end
myObject = MyClass

myObject = 

  MyClass with properties:

    Prop1: 10
    Prop2: []

Here is my custom footer

The default implementation of getFooter returns an empty character vector. MyClass overrides the method to return the text, Here is my custom footer.

Tips

MATLAB displays objects in one of these formats:

Deleted scalar handle object
Empty object array
Scalar object
Nonscalar object array

Each format has three sections: a header, a list of properties, and a footer. All formats have default implementation, but classes can customize any of these formats.

Version History

Introduced in R2013b