matlab.mixin.util.PropertyGroup class

Package: matlab.mixin.util

Custom property list for object display

Description

Use the PropertyGroup class to create custom property display lists for classes derived from matlab.mixin.CustomDisplay. You can change the order of properties displayed, specify which properties to display, and add a title to the list.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

P = matlab.mixin.util.PropertyGroup(propertyList) constructs a property group object with its PropertyList property set to propertyList.

P = matlab.mixin.util.PropertyGroup(propertyList,title) constructs a property group object with its TitleTitle property set to title. The title is displayed above the list of properties.

Properties

NumProperties — Number of properties in PropertyList

positive integer

The number of properties contained in the PropertyList property, specified as a positive integer.

Attributes:

Dependent	true
Transient	true
GetAccess	public
SetAccess	public
GetObservable	true

PropertyList — List of properties to include in group

cell array of character vectors | string array | struct

List of properties to include in the group, specified as a cell array of character vectors, a string array, or a struct that includes the properties as field names.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Title — Title for property group

'' (default) | character vector

Title for the custom property group. If not specified, the property group is displayed without a title.

Attributes:

GetAccess	public
SetAccess	public
GetObservable	true
SetObservable	true

Examples

Custom Property Groups

Create two property groups for class display.

The EmployeeInfo class has five properties describing an employee. Define a getPropertyGroups method that, for scalar objects, defines two PropertyGroup objects. The method returns two property groups with the titles Employee Bio and Contact Info.

classdef EmployeeInfo < matlab.mixin.CustomDisplay
    properties
        Name = "Alex Doe"
        Department = "Development"
        JobTitle = "Engineer"
        Email = "[e-mail]"
        Phone = "(555) 555-555"
    end

    methods (Access = protected)
        function propgrp = getPropertyGroups(obj)
            if ~isscalar(obj)
                propgrp = [e-mail](obj);
            else
                bioList = ["Name","Department","JobTitle"];
                bioTitle = "Employee Bio";
                bioGrp = matlab.mixin.util.PropertyGroup(bioList,bioTitle);
                contactList = ["Email","Phone"];
                contactTitle = "Contact Info";
                contactGrp = matlab.mixin.util.PropertyGroup(contactList,contactTitle);
                propgrp = [bioGrp,contactGrp];
            end
        end
    end
end

Create a scalar instance to see how the properties are displayed.

a = EmployeeInfo

a = 

  EmployeeInfo with properties:

   Employee Bio
          Name: "Alex Doe"
    Department: "Development"
      JobTitle: "Engineer"

   Contact Info
         Email: "[e-mail]"
         Phone: "(555) 555-555"

Version History

Introduced in R2013b