Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

CheckBoxTree 属性

控制复选框树的外观和行为

复选框树是 UI 组件,用于显示 App 层次结构中的项目列表,其中每个项目都有一个关联的复选框。可通过属性控制复选框树的外观和行为。使用圆点表示法引用特定的对象和属性。

例如,以下代码创建一个具有两个嵌套节点的基本复选框树,将 CheckBoxTree 对象存储为 cbt,然后使用圆点表示法设置 CheckedNodes 属性。

fig = uifigure;
cbt = uitree(fig,'checkbox');
n1 = uitreenode(cbt);
n1.Text = 'Node 1';
n2 = uitreenode(n1);
n2.Text = 'Node 2';
cbt.CheckedNodes = [n1 n2];

有关如何创建和配置复选框树的更多示例,请参阅 uitree

节点

全部展开

选中的节点,指定为 TreeNode 对象或由 TreeNode 对象组成的数组。使用此属性以编程方式获取或设置复选框树中的选中节点。

如果 CheckedNodes 包含父节点,则父节点的所有子级都会自动添加到 CheckedNodes。如果 CheckedNodes 包含父节点的所有子级,则该父节点会自动添加到 CheckedNodes

选定节点,指定为 TreeNode 对象。使用此属性获取或设置复选框树中选定的节点。

在复选框树 UI 组件中,所选节点以蓝色高亮显示来表示。

字体和颜色

全部展开

字体名称,指定为系统支持的字体名称。默认字体取决于具体操作系统和区域设置。

如果指定的字体不可用,MATLAB® 将使用运行 App 的系统上的可用字体中的最佳匹配项。

示例: 'Arial'

字体大小,指定为正数。测量单位为像素。默认字体大小取决于具体操作系统和区域设置。

示例: 14

字体粗细,指定为下列值之一:

  • 'normal' - 特定字体定义的默认粗细

  • 'bold' - 字符轮廓比 'normal'

并非所有字体都有加粗字体。因此,指定加粗字体可能得到普通字体。

字体角度,指定为 'normal''italic'。将此属性设置为 italic 可选择字体的倾斜版本(如果 App 用户的系统上提供了该字体)。

字体颜色,指定为 RGB 三元组、十六进制颜色代码或下表中列出的选项之一。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 '#FF8800''#ff8800''#F80''#f80' 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
'red''r'[1 0 0]'#FF0000'

'green''g'[0 1 0]'#00FF00'

'blue''b'[0 0 1]'#0000FF'

'cyan' 'c'[0 1 1]'#00FFFF'

'magenta''m'[1 0 1]'#FF00FF'

'yellow''y'[1 1 0]'#FFFF00'

'black''k'[0 0 0]'#000000'

'white''w'[1 1 1]'#FFFFFF'

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]'#0072BD'

[0.8500 0.3250 0.0980]'#D95319'

[0.9290 0.6940 0.1250]'#EDB120'

[0.4940 0.1840 0.5560]'#7E2F8E'

[0.4660 0.6740 0.1880]'#77AC30'

[0.3010 0.7450 0.9330]'#4DBEEE'

[0.6350 0.0780 0.1840]'#A2142F'

背景颜色,指定为 RGB 三元组、十六进制颜色代码或下表中列出的颜色选项之一。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 '#FF8800''#ff8800''#F80''#f80' 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
'red''r'[1 0 0]'#FF0000'

'green''g'[0 1 0]'#00FF00'

'blue''b'[0 0 1]'#0000FF'

'cyan' 'c'[0 1 1]'#00FFFF'

'magenta''m'[1 0 1]'#FF00FF'

'yellow''y'[1 1 0]'#FFFF00'

'black''k'[0 0 0]'#000000'

'white''w'[1 1 1]'#FFFFFF'

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]'#0072BD'

[0.8500 0.3250 0.0980]'#D95319'

[0.9290 0.6940 0.1250]'#EDB120'

[0.4940 0.1840 0.5560]'#7E2F8E'

[0.4660 0.6740 0.1880]'#77AC30'

[0.3010 0.7450 0.9330]'#4DBEEE'

[0.6350 0.0780 0.1840]'#A2142F'

交互性

全部展开

可见性状态,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 'on' - 显示对象。

  • 'off' - 隐藏对象而不删除它。您仍然可以访问不可见 UI 组件的属性。

要使您的 App 更快地启动,请将不需要在启动时出现的所有 UI 组件的 Visible 属性设置为 'off'

节点文本可编辑性,指定为 'off''on',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

将此属性设置为 'on' 可允许用户在运行时编辑节点文本。Enable 属性也必须设置为 'on' 才能使文本可编辑。

树的工作状态,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 如果您将此属性设置为 'on',则 App 用户可以与树及其节点进行交互。

  • 如果您将此属性设置为 'off',组件将灰显,指示 App 用户无法与该组件或其节点交互,并且它不会触发回调。

将此属性设置为 'off' 可使树及其节点灰显,表示用户不能与树或其节点进行交互。

工具提示,指定为字符向量、字符向量元胞数组、字符串数组或一维分类数组。如果使用此属性,则在运行时当用户将指针悬停在组件上时,将显示消息。即使禁用组件,工具提示也会显示。要显示多行文本,请指定字符向量元胞数组或字符串数组。数组中的每个元素变为一行文本。如果将此属性指定为分类数组,MATLAB 将使用数组中的值,而不是完整的类别集。

上下文菜单,指定为使用 uicontextmenu 函数创建的 ContextMenu 对象。使用此属性可在您右键点击组件时显示上下文菜单。

位置

全部展开

位置和大小,指定为 [left bottom width height] 形式的四元素向量。此表介绍该向量中的每个元素。所有测量值都以像素为单位。

元素说明
left从父容器的内侧左边缘到树的边界框的左边缘之间的距离
bottom从父容器的内侧底边缘到围绕树的边界框的底边缘之间的距离
width边界框的左右边缘之间的距离
height边界框的上下边缘之间的距离

位置和大小,指定为 [left bottom width height] 形式的四元素向量。向量中的值相对于父容器。所有测量值都以像素为单位。此属性值等同于 Position 属性值。

此属性为只读

位置和大小,返回 [left bottom width height] 形式的四元素向量。向量中的值相对于父容器。所有测量值都以像素为单位。此属性值等同于 Position 属性值。

布局选项,指定为 GridLayoutOptions 对象。此属性为网格布局容器的子级组件指定选项。如果组件不是网格布局容器的子级(例如,它是图窗或面板的子级),则此属性为空且不起作用。但是,如果组件是网格布局容器的子级,则可以通过在 GridLayoutOptions 对象上设置 RowColumn 属性,将组件放置在网格的所需行和列中。

例如,以下代码将一个复选框树放置在其父网格的第三行第二列中。

g = uigridlayout([4 3]);
cbt = uitree(g,'checkbox');
cbt.Layout.Row = 3;
cbt.Layout.Column = 2;

要使该树跨多个行或列,请将 RowColumn 属性指定为二元素向量。例如,此树跨列 23

cbt.Layout.Column = [2 3];

回调

全部展开

更改选定节点后执行的回调,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

使用此回调函数可在用户选中或取消选中树中的节点时执行命令。

此回调函数可以访问有关用户与树交互(例如以前选中的节点)的特定信息。MATLAB 在 CheckedNodesChangedData 对象中将此信息作为第二个参数传递给回调函数。在 App 设计工具中,该参数名为 event。您可以使用圆点表示法查询对象属性。例如,event.CheckedNodes 返回选中的 TreeNode 对象。CheckedNodesChangedData 对象不可用于指定为字符向量的回调函数。

下表说明了 CheckedNodesChangedData 对象的属性。

属性

说明

CheckedNodes

当前选中的 TreeNode 对象

PreviousCheckedNodes

先前选中的 TreeNode 对象

IndeterminateCheckedNodes

当前同时包含选中和未选中子级的父 TreeNode 对象

PreviousIndeterminateCheckedNodes

先前同时包含选中和未选中子级的父 TreeNode 对象

LeafCheckedNodes

当前选中的不包含子节点的 TreeNode 对象

PreviousLeafCheckedNodes

先前选中的不包含子节点的 TreeNode 对象

ParentCheckedNodes

当前选中的包含子节点的 TreeNode 对象

PreviousParentCheckedNodes

先前选中的包含子节点的 TreeNode 对象

Source

执行回调的组件

EventName

'CheckedNodesChanged'

返回节点列表的属性按层次结构顺序返回节点。例如,CheckedNodes 属性首先按节点在树组件中出现的顺序列出树的第一个层级中所有选中的节点。然后,同样按节点的出现顺序列出树的第二个层级中所有选中的节点。这种模式一直持续到列出树的最后一个层级中的节点为止。这与 findall 函数返回节点的顺序相匹配。

有关编写回调的详细信息,请参阅在 App 设计工具中编写回调

所选内容改变时的回调,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

使用此回调函数可在用户在树中选择不同的节点时执行命令。

此回调函数可以访问有关用户与树交互(例如选择的节点)的特定信息。MATLAB 在 SelectedNodesChangedData 对象中将此信息作为第二个参数传递给回调函数。在 App 设计工具中,该参数名为 event。您可以使用圆点表示法查询对象属性。例如,event.SelectedNodes 返回选定的 TreeNode 对象。SelectedNodesChangedData 对象不可用于指定为字符向量的回调函数。

下表说明了 SelectedNodesChangedData 对象的属性。

属性

说明

SelectedNodes

最近选择的 TreeNode 对象

PreviousSelectedNodes

之前选定的 TreeNode 对象

Source

执行回调的组件

EventName

'SelectionChanged'

有关编写回调的详细信息,请参阅在 App 设计工具中编写回调

节点展开时的回调,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

使用此回调函数可在用户展开树中的节点时执行命令。

此回调函数可以访问有关用户与节点交互的特定信息。MATLAB 将 NodeExpandedData 对象中的此信息作为第二个参数传递给回调函数。在 App 设计工具中,该参数名为 event。您可以使用圆点表示法查询对象属性。例如,event.Node 返回用户折叠的 TreeNode 对象。NodeExpandedData 对象不可用于指定为字符向量的回调函数。

下表说明了 NodeExpandedData 对象的属性。

属性

说明

Node

用户展开的 TreeNode 对象

Source

执行回调的组件

EventName

'NodeExpanded'

有关编写回调的详细信息,请参阅在 App 设计工具中编写回调

节点折叠时的回调,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

使用此回调函数以在用户折叠树中的节点时执行命令。

此回调函数可以访问有关用户与节点交互的特定信息。MATLAB 将 NodeCollapsedData 对象中的此信息作为第二个参数传递给回调函数。在 App 设计工具中,该参数名为 event。您可以使用圆点表示法查询对象属性。例如,event.Node 返回用户折叠的 TreeNode 对象。NodeCollapsedData 对象不可用于指定为字符向量的回调函数。

下表说明了 NodeCollapsedData 对象的属性。

属性

说明

Node

用户折叠的 TreeNode 对象

Source

执行回调的组件

EventName

'NodeCollapsed'

有关编写回调的详细信息,请参阅在 App 设计工具中编写回调

节点文本更改回调,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

使用此回调函数可在用户更改树中节点的文本时执行命令。

此回调函数可以访问有关用户与树节点交互的特定信息。MATLAB 将 NodeTextChangedData 对象中的此信息作为第二个参数传递给回调函数。在 App 设计工具中,该参数名为 event。您可以使用圆点表示法查询对象属性。例如,event.PreviousText 返回原先的节点文本。NodeTextChangedData 对象不可用于指定为字符向量的回调函数。

下表说明了 NodeTextChangedData 对象的属性。

属性

说明

Node

已更改文本的 TreeNode 对象

Text

新节点文本

PreviousText

原先的节点文本

Source

执行回调的组件

EventName

'NodeTextChanged'

有关编写回调的详细信息,请参阅在 App 设计工具中编写回调

对象创建函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅在 App 设计工具中编写回调

此属性指定要在 MATLAB 创建对象时执行的回调函数。MATLAB 将在执行 CreateFcn 回调之前初始化所有属性值。如果不指定 CreateFcn 属性,则 MATLAB 执行默认的创建函数。

对现有组件设置 CreateFcn 属性没有任何作用。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参数访问正在创建的对象。否则,使用 gcbo 函数访问该对象。

对象删除函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅在 App 设计工具中编写回调

此属性指定在 MATLAB 删除对象时要执行的回调函数。MATLAB 在销毁对象的属性之前执行 DeleteFcn 回调。如果不指定 DeleteFcn 属性,则 MATLAB 执行默认的删除函数。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参数访问要删除的对象。否则,使用 gcbo 函数访问该对象。

回调执行控件

全部展开

回调中断,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

此属性确定是否可以中断运行中回调。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

每当 MATLAB 调用回调时,回调都会试图中断正在运行的回调(如果存在)。运行中回调所属对象的 Interruptible 属性决定着是否允许中断。

  • 'on' 允许其他回调中断对象的回调。中断发生在 MATLAB 处理队列的下一个位置,例如当存在 drawnowfigureuifiguregetframewaitforpause 命令时。

    • 如果运行中回调包含以上命令之一,则 MATLAB 将在该时刻停止执行回调并执行中断回调。当中断回调完成时,MATLAB 将恢复执行运行中回调。

    • 如果运行中回调不包含以上命令之一,则 MATLAB 执行完当前回调,不会出现任何中断。

  • 'off' 阻止所有中断尝试。由中断回调所属的对象的 BusyAction 属性决定是放弃该中断回调还是将其放入队列中。

注意

回调的中断和执行在以下情况下会有不同的表现:

  • 如果中断回调是 DeleteFcnCloseRequestFcnSizeChangedFcn 回调,则无论是否存在 Interruptible 属性值都会发生中断。

  • 如果运行中回调当前正在执行 waitfor 函数,则无论是否存在 Interruptible 属性值都会发生中断。

  • Timer 对象根据排定时间执行,而不管 Interruptible 属性值如何。

发生中断时,MATLAB 不保存属性状态或显示内容。例如,gcagcf 命令返回的对象可能会在另一个回调执行时发生改变。

回调排队,指定为 'queue''cancel'BusyAction 属性决定 MATLAB 如何处理中断回调的执行。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

无论何时 MATLAB 调用回调,该回调都会试图中断运行中回调。运行中回调所属对象的 Interruptible 属性决定着是否允许中断。如果不允许中断,则中断回调所属对象的属性 BusyAction 将决定是放弃该回调还是将回调放入队列中。以下是 BusyAction 属性的可能值:

  • 'queue' - 将中断回调放入队列中,以便在运行中回调执行完毕后进行处理。

  • 'cancel' - 不执行中断回调。

此属性为只读

删除状态,以 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值形式返回。

DeleteFcn 回调开始执行时,MATLAB 会将 BeingDeleted 属性设置为 'on'BeingDeleted 属性将一直保持 'on' 设置状态,直到组件对象不再存在为止。

在查询或修改对象之前,请先检查其 BeingDeleted 属性的值,以确认它不是待删除项。

父级/子级

全部展开

父容器,指定为使用 uifigure 函数创建的 Figure 对象或其子容器之一:TabPanelButtonGroupGridLayout。如果未指定容器,MATLAB 将调用 uifigure 函数以创建一个新 Figure 对象来充当父容器。

子级,以 TreeNode 对象数组形式返回。

不能使用 Children 属性添加或删除子级,但可以使用此属性查看子级列表。子级的顺序反映了显示在屏幕上的子级节点的顺序。要向该列表中添加子级,请将子组件的 Parent 属性设置为 Tree 对象。

要重新排序子级,请使用 move 函数。

HandleVisibility 属性设置为 'off' 的对象不会列在 Children 属性中。

对象句柄的可见性,指定为 'on''callback''off'

此属性控制对象在其父级的子级列表中的可见性。当对象未显示在其父级的子级列表中时,通过搜索对象层次结构或查询属性来获取对象的函数不会返回该对象。这些函数包括 getfindobjclfclose。对象即使在不可见时也有效。如果可以访问某个对象,则可以设置和获取其属性,并将其传递给针对对象进行运算的任意函数。

HandleVisibility 值说明
'on'对象始终可见。
'callback'对象对于回调或回调调用的函数可见,但对于命令行调用的函数不可见。此选项阻止通过命令行访问对象,但允许回调函数访问它。
'off'对象始终不可见。该选项用于防止另一函数无意中对 UI 进行更改。将 HandleVisibility 设置为 'off' 可在执行该函数时暂时隐藏对象。

标识符

全部展开

此属性为只读

图形对象的类型,以 'uicheckboxtree' 形式返回。

对象标识符,指定为字符向量或字符串标量。您可以指定唯一的 Tag 值作为对象的标识符。如果需要访问您代码中其他位置的对象,可以使用 findobj 函数基于 Tag 值搜索对象。

用户数据,指定为任何 MATLAB 数组。例如,您可以指定标量、向量、矩阵、元胞数组、字符数组、表或结构体。使用此属性存储对象上的任意数据。

如果您在 App 设计工具中工作,请在该 App 中创建公共或私有属性以共享数据,而不是使用 UserData 属性。有关详细信息,请参阅在用 App 设计工具创建的 App 内共享数据

另请参阅

函数

在 R2021a 中推出