/** * AccessibleBlockly * * Copyright 2016 Google Inc. * https://developers.google.com/blockly/ * * Licensed under the Apache License, Version 2.0 (the 'License'); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an 'AS IS' BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @fileoverview Angular2 Component that details how Blockly.Block's are * rendered in the workspace in AccessibleBlockly. Also handles any * interactions with the blocks. * @author madeeha@google.com (Madeeha Ghori) */ blocklyApp.WorkspaceTreeComponent = ng.core .Component({ selector: 'blockly-workspace-tree', template: `
  • `, directives: [blocklyApp.FieldComponent, ng.core.forwardRef(function() { return blocklyApp.WorkspaceTreeComponent; })], inputs: ['block', 'level', 'tree', 'isTopLevel'], pipes: [blocklyApp.TranslatePipe] }) .Class({ constructor: [ blocklyApp.ClipboardService, blocklyApp.NotificationsService, blocklyApp.TreeService, blocklyApp.UtilsService, blocklyApp.AudioService, function( _clipboardService, _notificationsService, _treeService, _utilsService, _audioService) { this.clipboardService = _clipboardService; this.notificationsService = _notificationsService; this.treeService = _treeService; this.utilsService = _utilsService; this.audioService = _audioService; }], getBlockDescription: function() { return this.utilsService.getBlockDescription(this.block); }, isIsolatedTopLevelBlock_: function(block) { // Returns whether the given block is at the top level, and has no // siblings. var blockIsAtTopLevel = !block.getParent(); var blockHasNoSiblings = ( (!block.nextConnection || !block.nextConnection.targetConnection) && (!block.previousConnection || !block.previousConnection.targetConnection)); return blockIsAtTopLevel && blockHasNoSiblings; }, removeBlockAndSetFocus_: function(block, deleteBlockFunc) { // This method runs the given function and then does one of two things: // - If the block is an isolated top-level block, it shifts the tree // focus. // - Otherwise, it sets the correct new active desc for the current tree. if (this.isIsolatedTopLevelBlock_(block)) { var nextNodeToFocusOn = this.treeService.getNodeToFocusOnWhenTreeIsDeleted(this.tree.id); this.treeService.clearActiveDesc(this.tree.id); deleteBlockFunc(); // Invoke a digest cycle, so that the DOM settles. setTimeout(function() { nextNodeToFocusOn.focus(); }); } else { var blockRootNode = document.getElementById(this.idMap['blockRoot']); var nextActiveDesc = this.treeService.getNextActiveDescWhenBlockIsDeleted( blockRootNode); this.treeService.runWhilePreservingFocus( deleteBlockFunc, this.tree.id, nextActiveDesc.id); } }, cutBlock_: function() { var blockDescription = this.getBlockDescription(); var that = this; this.removeBlockAndSetFocus_(this.block, function() { that.clipboardService.cut(that.block); }); setTimeout(function() { if (that.utilsService.isWorkspaceEmpty()) { that.notificationsService.setStatusMessage( blockDescription + ' cut. Workspace is empty.'); } else { that.notificationsService.setStatusMessage( blockDescription + ' cut. Now on workspace.'); } }); }, deleteBlock_: function() { var blockDescription = this.getBlockDescription(); var that = this; this.removeBlockAndSetFocus_(this.block, function() { that.block.dispose(true); that.audioService.playDeleteSound(); }); setTimeout(function() { if (that.utilsService.isWorkspaceEmpty()) { that.notificationsService.setStatusMessage( blockDescription + ' deleted. Workspace is empty.'); } else { that.notificationsService.setStatusMessage( blockDescription + ' deleted. Now on workspace.'); } }); }, pasteToConnection_: function(connection) { var destinationTreeId = this.treeService.getTreeIdForBlock( connection.getSourceBlock().id); this.treeService.clearActiveDesc(destinationTreeId); var newBlockId = this.clipboardService.pasteFromClipboard(connection); // Invoke a digest cycle, so that the DOM settles. var that = this; setTimeout(function() { that.treeService.focusOnBlock(newBlockId); }); }, moveToMarkedSpot_: function() { var blockDescription = this.getBlockDescription(); var oldDestinationTreeId = this.treeService.getTreeIdForBlock( this.clipboardService.getMarkedConnectionBlock().id); this.treeService.clearActiveDesc(oldDestinationTreeId); var newBlockId = this.clipboardService.pasteToMarkedConnection( this.block); var that = this; this.removeBlockAndSetFocus_(this.block, function() { that.block.dispose(true); }); // Invoke a digest cycle, so that the DOM settles. setTimeout(function() { that.treeService.focusOnBlock(newBlockId); var newDestinationTreeId = that.treeService.getTreeIdForBlock( newBlockId); if (newDestinationTreeId != oldDestinationTreeId) { // It is possible for the tree ID for the pasted block to change // after the paste operation, e.g. when inserting a block between two // existing blocks that are joined together. In this case, we need to // also reset the active desc for the old destination tree. that.treeService.initActiveDesc(oldDestinationTreeId); } that.notificationsService.setStatusMessage( blockDescription + ' ' + Blockly.Msg.PASTED_BLOCK_TO_MARKED_SPOT_MSG + '. Now on moved block in workspace.'); }); }, copyBlock_: function() { this.clipboardService.copy(this.block); this.notificationsService.setStatusMessage( this.getBlockDescription() + ' ' + Blockly.Msg.COPIED_BLOCK_MSG); }, markSpotBefore_: function() { this.clipboardService.markConnection(this.block.previousConnection); }, markSpotAfter_: function() { this.clipboardService.markConnection(this.block.nextConnection); }, pasteToNextConnection_: function() { this.pasteToConnection_(this.block.nextConnection); }, pasteToPreviousConnection_: function() { this.pasteToConnection_(this.block.previousConnection); }, ngOnInit: function() { var that = this; // Generate a list of action buttons. this.actionButtonsInfo = [{ baseIdKey: 'cut', translationIdForText: 'CUT_BLOCK', action: that.cutBlock_.bind(that), isDisabled: function() { return false; } }, { baseIdKey: 'copy', translationIdForText: 'COPY_BLOCK', action: that.copyBlock_.bind(that), isDisabled: function() { return false; } }, { baseIdKey: 'pasteBefore', translationIdForText: 'PASTE_BEFORE', action: that.pasteToPreviousConnection_.bind(that), isDisabled: function() { return Boolean( !that.block.previousConnection || !that.isCompatibleWithClipboard(that.block.previousConnection)); } }, { baseIdKey: 'pasteAfter', translationIdForText: 'PASTE_AFTER', action: that.pasteToNextConnection_.bind(that), isDisabled: function() { return Boolean( !that.block.nextConnection || !that.isCompatibleWithClipboard(that.block.nextConnection)); } }, { baseIdKey: 'markBefore', translationIdForText: 'MARK_SPOT_BEFORE', action: that.markSpotBefore_.bind(that), isDisabled: function() { return !that.block.previousConnection; } }, { baseIdKey: 'markAfter', translationIdForText: 'MARK_SPOT_AFTER', action: that.markSpotAfter_.bind(that), isDisabled: function() { return !that.block.nextConnection; } }, { baseIdKey: 'moveToMarkedSpot', translationIdForText: 'MOVE_TO_MARKED_SPOT', action: that.moveToMarkedSpot_.bind(that), isDisabled: function() { return !that.clipboardService.isMovableToMarkedConnection( that.block); } }, { baseIdKey: 'delete', translationIdForText: 'DELETE', action: that.deleteBlock_.bind(that), isDisabled: function() { return false; } }]; // Generate a list of action buttons. this.fieldButtonsInfo = [{ baseIdKey: 'markSpot', translationIdForText: 'MARK_THIS_SPOT', action: function(connection) { that.clipboardService.markConnection(connection); }, isDisabled: function() { return false; } }, { baseIdKey: 'paste', translationIdForText: 'PASTE', action: function(connection) { that.pasteToConnection_(connection); }, isDisabled: function(connection) { return !that.isCompatibleWithClipboard(connection); } }]; // Make a list of all the id keys. this.idKeys = ['blockRoot', 'blockSummary', 'listItem', 'label']; this.actionButtonsInfo.forEach(function(buttonInfo) { that.idKeys.push(buttonInfo.baseIdKey, buttonInfo.baseIdKey + 'Button'); }); this.fieldButtonsInfo.forEach(function(buttonInfo) { for (var i = 0; i < that.block.inputList.length; i++) { that.idKeys.push( buttonInfo.baseIdKey + i, buttonInfo.baseIdKey + 'Button' + i); } }); for (var i = 0; i < this.block.inputList.length; i++) { var inputBlock = this.block.inputList[i]; that.idKeys.push( 'inputList' + i, 'inputMenuLabel' + i, 'listItem' + i, 'fieldLabel' + i); } }, ngDoCheck: function() { // Generate a unique id for each id key. This needs to be done every time // changes happen, but after the first ng-init, in order to force the // element ids to change in cases where, e.g., a block is inserted in the // middle of a sequence of blocks. this.idMap = {}; for (var i = 0; i < this.idKeys.length; i++) { this.idMap[this.idKeys[i]] = this.block.id + this.idKeys[i]; } }, ngAfterViewInit: function() { // If this is a top-level tree in the workspace, set its id and active // descendant. (Note that a timeout is needed here in order to trigger // Angular change detection.) var that = this; setTimeout(function() { if (that.tree && that.isTopLevel && !that.tree.id) { that.tree.id = that.utilsService.generateUniqueId(); } if (that.tree && that.isTopLevel && !that.treeService.getActiveDescId(that.tree.id)) { that.treeService.setActiveDesc(that.idMap['blockRoot'], that.tree.id); } }); }, generateAriaLabelledByAttr: function(mainLabel, secondLabel, isDisabled) { return this.utilsService.generateAriaLabelledByAttr( mainLabel, secondLabel, isDisabled); }, isCompatibleWithClipboard: function(connection) { return this.clipboardService.isCompatibleWithClipboard(connection); } });