[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閱讀 228,412評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,514評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,373評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,975評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,743評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,199評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,262評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,414評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,951評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,780評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,527評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,218評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,649評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,889評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,673評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,967評論 2 374

推薦閱讀更多精彩內容