[Blockly开发攻略3] 创建工具栏ToolBox

1. 创建ToolBox

要创建一个ToolBox非常简单,只需要在定义workspace的时候进行设置即可。

var workspace = Blockly.inject(blocklyDiv, {
    media: 'blockly/media/',
    toolbox: document.getElementById('toolbox'),  // 定义ToolBox
});

但在此之前,需要先定义ToolBox。ToolBox由<xml></xml>标签定义。下面的代码展示了如何定义一个toolbox,其中id属性用于查找该xml元素。

// 定义toolbox
<xml id="toolbox" style="display: none;">
    <block type="controls_if"></block>
</xml>

2. 嵌套目录

<category>标签可以进行嵌套实现多级目录。

<xml id="toolbox" style="display: none;">
    <category name="一级目录1">
        <block type="controls_if"></block>
    </category>
    <category name="一级目录2">
        <category name="二级目录1">
            <block type="controls_if"></block>
        </category>
        <category name="二级目录2">
            <block type="controls_if"></block>
        </category>
    </category>
</xml>

多级目录的ToolBox

要注意,在根目录中,不能同时存在<category>标签和<block>标签。

// 以下是错误的ToolBox定义
<xml id="toolbox" style="display: none;">
    <block type="controls_if"></block>
    <category name="一级目录1">
        <block type="controls_if"></block>
    </category>
</xml>

3.分割线

<sep></sep>标签对可以在ToolBox目录之间加入分割线,效果如下:

<xml id="toolbox" style="display: none;">
    <category name="一级目录1">
        <block type="controls_if"></block>
    </category>
    <sep></sep>
    <category name="一级目录2">
        <category name="二级目录1">
            <block type="controls_if"></block>
        </category>
        <category name="二级目录2">
            <block type="controls_if"></block>
        </category>
    </category>
</xml>

分割线

如果将<sep></sep>放在<block>标签之间,则可以通过gap属性定义两个block之间的间隔,单位为px,默认情况下这个值为24,下面的代码将间隔分别改为40和5。

<xml id="toolbox" style="display: none;">
    <category name="一级目录1">
        <block type="controls_if"></block>
        <sep gap="40"></sep>
        <block type="controls_if"></block>
        <sep gap="5"></sep>
        <block type="controls_if"></block>
    </category>
</xml>
改变模块间隔

4.在ToolBox中加入模块组

在ToolBox定义中,可以通过<field><value>在模块中嵌入其他模块,形成模块组,用这个功能可以将经常组合使用的模块直接放在ToolBox中。至于在下面的代码中,什么时候用value标签,什么时候用field标签,为什么name叫"IF0","A","B",这与模块的定义有关,我会在后面关于模块定义的部分讲解。

<xml id="toolbox" style="display: none;">
    <block type="controls_if">
        <value name="IF0">
            <block type="logic_operation">
                <value name="A">
                    <block type="logic_boolean">
                        <field name="BOOL">TRUE</field>
                    </block>
                </value>
                <value name="B">
                    <block type="logic_boolean">
                        <field name="BOOL">FALSE</field>
                    </block>
                </value>
            </block>
        </value>
    </block>
</xml>
模块组

5. 在ToolBox中加入文字和按键

labelbutton标签可以给ToolBox添加文字和按键,通过text属性,可以设置他们显示的文字内容,通过web-class属性,你还可以自定义他们的样式。下面代码展示了如何使用它们:

<xml id="toolbox" style="display: none;">
    <label text="a label" web-class="labelStyle"></label>
    <button text="a button" web-class="buttonStyle"></button>
</xml>
<style>
    .labelStyle>.blocklyFlyoutLabelText {
        font-style: italic;
        fill: blue;
    }
    .buttonStyle {
        font-style: italic;
        fill: red;
    }
</style>
自定义文字和按键

另外,按键需要指定一个回调函数。button标签的callbackKey属性可以定义点击按键时的回调函数。同时,需要用registerButtonCallback函数将callbackKey和回调函数关联起来。

<xml id="toolbox" style="display: none;">
    <button text="a button" callbackKey="buttonKey"></button>
</xml>
<script>
    //生成模块列表区域
    var blocklyDiv = document.getElementById('blocklyDiv');
    var workspace = Blockly.inject(blocklyDiv, {
        media: 'blockly/media/',
        toolbox: document.getElementById('toolbox'),
    });

    //调整工作区域大小
    var onresize = function (e) {
        Blockly.svgResize(workspace);
    };
    //注册resize处理函数
    window.addEventListener('resize', onresize, false);
    Blockly.svgResize(workspace);
    // 注册回调函数
    workspace.registerButtonCallback("buttonKey", callback);
    // 定义回调函数
    function callback() {
        console.log("a button pressed");
    }
</script>

点击button时,将调用callback函数。

6. 改变ToolBox

workspace的ToolBox属性可以通过workspace.updateToolbox()函数动态改变。它接受一个参数,可以是节点树或者合法的定义字符串。
当更新ToolBox时,有一个限制必须要注意。我们之前说过,在第一级中,目录和模块是不能共存的。如果旧的ToolBox第一级是目录,那么新的ToolBox也必须是目录,反之亦然。

7. 动态目录

之前我们定义的目录都是静态的,每个目录下面的元素,在最开始就已经确定了。为了使ToolBox更加灵活,Blockly提供了动态改变目录的功能,最典型的比如变量和函数这两个目录,里面的模块数量和类型会根据当前已经定义的变量和函数动态变化。

 <!-- 变量与函数目录 -->
<category name="Variables" custom="VARIABLE"></category>
<category name="Functions" custom="PROCEDURE"></category>

要定义一个动态的目录只需要3步:
a. 在ToolBox中定义一个目录,并用custom属性设置一个名字。

<category name="myCategory" custom="MY_CATEGORY"></category>

b. 定义一个函数用于动态生成目录下的内容。这个函数在每次目录被点击展开时调用,它必须接收一个workspace参数,并且返回一个模块/目录节点树列表,Blockly会将列表中的模块/目录按照顺序放在目录下。

myCategoryFlyoutCallback = function(workspace) {
  // 通过workspace,你可以访问到当前工作空间下的所有数据,你也可以修改workspace。
  var xmlList = [];
  // 根据workspace中的数据,生成模块/目录节点并填充xmlList
  return xmlList;  // 返回xmlList
};

c. 注册目录生成函数,将前两步中定义的内容关联起来。

workspace.registerToolboxCategoryCallback('MY_CATEGORY', myCategoryFlyoutCallback);
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,504评论 4 365
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,898评论 1 300
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,218评论 0 248
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,322评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,693评论 3 290
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,812评论 1 223
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,010评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,747评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,476评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,700评论 2 251
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,190评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,541评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,206评论 3 240
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,129评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,903评论 0 199
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,894评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,748评论 2 274

推荐阅读更多精彩内容