matrix/models/treenode.js

  1. /*
  2.  * This file is part of AUX.
  3.  *
  4.  * AUX is free software; you can redistribute it and/or
  5.  * modify it under the terms of the GNU General Public
  6.  * License as published by the Free Software Foundation; either
  7.  * version 3 of the License, or (at your option) any later version.
  8.  *
  9.  * AUX is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12.  * General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU General
  15.  * Public License along with this program; if not, write to the
  16.  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17.  * Boston, MA  02110-1301  USA
  18.  */
  20. /**
  21.  * @module matrix
  22.  */
  24. import { MatrixDatum } from './matrixdatum.js';
  26. /**
  27.  * Base class for matrix tree objects, e.g. groups and ports.
  28.  */
  29. export class TreeNodeData extends MatrixDatum {
  30.   /**
  31.    * Is true if this object is a group.
  32.    */
  33.   get isGroup() {
  34.     return false;
  35.   }
  37.   constructor(matrix, o) {
  38.     super(matrix, o);
  39.     this.parent = null;
  40.   }
  42.   /**
  43.    * The tree node label.
  44.    */
  45.   set label(value) {
  46.     return this.set('label', value);
  47.   }
  48.   get label() {
  49.     return this.get('label');
  50.   }
  52.   /**
  53.    * The tree node icon.
  54.    */
  55.   set icon(value) {
  56.     return this.set('icon', value);
  57.   }
  58.   get icon() {
  59.     return this.get('icon');
  60.   }
  62.   /**
  63.    * The tree node id.
  64.    */
  65.   get id() {
  66.     return this.get('id');
  67.   }
  69.   setParent(parent) {
  70.     if (parent !== null && this.parent !== null) {
  71.       throw new Error('Node already has a parent.');
  72.     }
  74.     if (parent !== null && !parent.isGroup)
  75.       throw new TypeError('Parent node must be a group.');
  77.     this.parent = parent;
  78.   }
  80.   /**
  81.    * Returns true if this node is a child of the given node.
  82.    *
  83.    * @param {TreeNodeData} node
  84.    */
  85.   isChildOf(node) {
  86.     for (let _node = this.parent; _node; _node = _node.parent) {
  87.       if (_node === node) return true;
  88.     }
  90.     return false;
  91.   }
  93.   getPath() {
  94.     const parent = this.parent;
  96.     if (!parent) return [];
  98.     return parent.getPath().concat([parent]);
  99.   }
  100. }