Drawer

Drawer - 抽屉 是一个可折叠的面板,用户可以展开/折叠内容。典型场景是用在 SideMenu 组件中作为布局容器。

drawer

组件的 XML 名称:drawer

基本用法

在界面描述中定义的抽屉需要有以下结构:由 CssLayout 包含 drawer 以及界面其他布局(例如,workArea),且 CSS 布局带有 jmix-drawer-layout 样式。

drawer 本身需要包含下列元素,它们表示:

  • Drawer 的 header 是 CssLayout,且有 jmix-drawer-header 样式。

    • header 图标有 app-icon 样式。

    • header 标题有 app-title 样式。

  • Drawer 内容,例如 SideMenu,要有 jmix-drawer-content 样式。

  • Drawer footer,要有 jmix-drawer-footer 样式。

    • Drawer footer 中要有一个 button,作为 Drawer 折叠的切换。

状态切换

toggle() 方法根据当前状态可以对 drawer 展开或折叠。例如,如果 drawer 已经是折叠状态,则调用该方法后会展开,反之亦然。

可以用 isCollapsed() 方法检查抽屉当前的状态。

悬停展开

expandOnHover 属性可以设置鼠标悬停时,drawer 自动展开。注意,折叠状态不受影响。默认为 false

用例

drawer 最常见的用法是用在应用程序的 主界面 中。

示例:

<layout>
    <cssLayout stylename="jmix-drawer-layout">
        <drawer id="drawer" expandOnHover="true">
            <cssLayout stylename="jmix-drawer-header"
                       width="100%">
                <hbox spacing="true">
                    <image id="logoImage"
                           stylename="app-icon"
                           scaleMode="SCALE_DOWN">
                        <resource>
                            <theme path="branding/app-icon-menu.svg"/>
                        </resource>
                    </image>
                    <label id="appTitleLabel"
                           stylename="app-title"
                           value="Application"/>
                </hbox>
            </cssLayout>
            <sideMenu id="sideMenu"
                      width="100%"
                      stylename="jmix-drawer-content"/>
            <cssLayout stylename="jmix-drawer-footer"
                       width="100%">
                <hbox align="BOTTOM_RIGHT">
                    <button id="collapseDrawerButton"
                            icon="CHEVRON_LEFT"
                            stylename="jmix-drawer-collapse-button"
                            description="mainMsg://sideMenuCollapse"/>
                </hbox>
            </cssLayout>
        </drawer>
        <hbox spacing="true" margin="true">
            <textArea height="300px"
                      width="125px"
                      caption="Text area #1"/>
            <textArea height="300px"
                      width="125px"
                      caption="Text area #2"/>
        </hbox>
    </cssLayout>
</layout>
@Autowired
private Drawer drawer;
@Autowired
private Button collapseDrawerButton;

@Subscribe("collapseDrawerButton")
public void onCollapseDrawerButtonClick(Button.ClickEvent event) {
    drawer.toggle(); (1)
    if (drawer.isCollapsed()) { (2)
        collapseDrawerButton.setIconFromSet(JmixIcon.CHEVRON_RIGHT);
    } else {
        collapseDrawerButton.setIconFromSet(JmixIcon.CHEVRON_LEFT);
    }
}
1 按钮点击时切换状态。
2 根据抽屉的状态切换按钮图标。