небольшой рестайлинг

This commit is contained in:
Aleksey Chichenkov 2018-10-10 17:53:39 +03:00
parent 905b0f7cb5
commit 732efd2b3d
8 changed files with 177 additions and 13 deletions

View file

@ -1,10 +1,108 @@
/**
* Атрибут ноды
* #### Атрибут ноды
*
* @group manager
* @class Attribute
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
function Attribute() {
/**
* Возвращает имя атрибута
*
* @public
* @function name
* @returns {v2.string}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.name = function() {
};
/**
* Возвращает значение атрибута
*
* @public
* @function value
* @returns {v2}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.value = function() {
};
/**
* Возвращает тип атрибута
*
* @public
* @function type
* @returns {v2.type}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.type = function() {
};
/**
* Возвращает значение о том, является ли атрибут редактируемым
*
* @public
* @function editable
* @returns {v2.boolean}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.editable = function() {
};
/**
* Возвращает значение о том, может ли данный атрибут быть удален
*
* @public
* @function removable
* @returns {v2.boolean}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.removable = function() {
};
/**
* Возвращает значение о том, может ли данный атрибут быть отображен
*
* @public
* @function visible
* @returns {v2.boolean}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.visible = function() {
};
/**
* **Небезопасный метод**
*
* Возвращет значение по указанному атрибуту
*
* @public
* @function parameter
* @param {string} _name
* @returns {v2}
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.parameter = function(_name) {
};
/**
* Производит обновление атритбута
*
* @public
* @function update
* @param {v2} _value
* @memberof Trees.GlobalAttributeTree.Node.Attributes.Attribute
*/
this.update = function(_value) {
};
}

View file

@ -1,4 +1,5 @@
/** @typedef {Trees.GlobalAttributeTree.Node.Attributes} NodeAttributes */
/** @typedef {Trees.GlobalAttributeTree.Node.Attributes.Attribute} NodeAttribute */
/**
* Интерфейс позволяющей пользователю работать с атрибутами ноды

View file

@ -1,4 +1,46 @@
/**
* ### Атрибутная нода
* Предоставляет интерфейс доступа к содержимому атрибутной ноды
*
* Здесь создаются менеджер по работе с атрибутами нодами
*
* <br>
* Связанные объекты:
*
* - {@link Trees.GlobalTree.Node} - Здесь можно найти примеры, как работать с вложенными нодами
* - {@link Trees.GlobalAttributeTree} - Здесь можно найти примеры, как работать с глобальным деревом
* - {@link Trees.GlobalAttributeTree.Node.Attributes} - Здесь можно найти примеры, как работать с типами ноды
*
*
* @example
* // Пример: Как получить ноду дерева?
*
* // Пример взят для дерева пользовательских данных (т.к. у него есть атрибуты)
* var tree = null;
* var node = null;
*
* // Осуществляем запрос к менеджеру деревьев, на получение провайдера дерева
* ps.pl.tm.get(new v2.string("uat")).then(function(ref){
* // ref - это ссылка на объект
* // метод value возвращает целевой объект. В данном случае дерево Trees.UserAttributeTree
* tree = ref.value();
*
* // Доступ к ноде осуществляется похожим образом, но теперь вместо строки нужно указать v2.integer
* // Так как возвратится нативный проимс, мы можем вернуть его и обработать в следующем then
* return tree.get(v2.integer.from_number(0))
* }, function(err){
* // в случае неудачи придет ошибка.
* // обычно в ошибке содержится три переменные err - код ошибки, message - краткое описание, sub - если к этому
* // привела другая ошибка внутри системы.
* }).then(function(ref){
* // Вот мы и получили ноду.
* node = ref.value();
* }, function(err){
* // Отобразим ошибку
* console.warn(err);
* })
*
*
* @class Node
* @extends Trees.GlobalTree.Node
* @memberof Trees.GlobalAttributeTree

View file

@ -10,6 +10,7 @@
* - {@link Trees.GlobalTree} - Здесь можно найти примеры, как работать с глобальным деревом
* - {@link Trees.GlobalTree.Node.Children} - Здесь можно найти примеры, как работать с вложенными нодами
* - {@link Trees.GlobalTree.Node.NodeTypes} - Здесь можно найти примеры, как работать с типами ноды
* - {@link Trees.GlobalAttributeTree.Node} - Нода у которой присутствуют базовые и динамические атрибуты
*
*
* @example