dragonbones-runtime
Version:
the tools to build dragonbones file for diffrent framework
127 lines (125 loc) • 6.29 kB
text/typescript
//////////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2014-present, Egret Technology.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of the Egret nor the
// names of its contributors may be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY EGRET AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL EGRET AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////////////
namespace eui {
/**
* Register a property for a class definition in running,
* so that the EUI can get type of property accurate when parsing a EXML.
* This need not be called directly in most of time. Only when you have a custom UI
* component need to be described in EXML, you may invoke this method explicitly.
*
* Contains no following：
* When the property is the basic data type(boolean, number, string or Array), you only need set a correct initial value
* for he custom property then the EXML parser can get the correct property type in running.
*
* If you can not set the correct initial value (such as <code>null</code>), the EXML parser will treat this property as
* <code>string</code>. If there is no inital value, EUI will throw an error. But you can invoked this method to register
* a property in this case.
*
*
* @param classDefinition The class definition need to be registered.
* @param property The property need to be registered. Note that the property
* name cannot start with "_" or "$".
* @param type The type need to be registered,
* such as “boolean","number","string","Array","egret.Rectangle" and so on.
* @param asDefault Whether register this property as a default property of component.
* One component can register only on default property. And the default property can be spare in an EXML.
*
* @example：
* <pre>
* <s:Scroller>
* <s:viewport>
* <s:Group/>
* </e:viewport>
* </e:Scroller>
* </pre>
* Cuz <code>viewport</code> is the default property of Scroller. So you can write as follow:
* <pre>
* <s:Scroller>
* <s:Group/>
* </e:Scroller>
* </pre>
* @version Egret 2.4
* @version eui 1.0
* @platform Web,Native
* @language en_US
*/
/**
* 为一个类定义注册运行时属性类型，以便运行时的EXML文件解析过程能获取准确的属性类型。大多数情况下，您都不需要手动调用此方法显式注册属性类型。
* 仅当您有一个自定义的 UI 组件，需要在EXML中用标签描述时可能需要显式注册，但以下情况除外：
* 当属性类型为基本数据类型：boolean,number,string,Array这四种其中之一时，您只需要为自定义的属性赋值上正确的初始值，
* 运行时EXML解析器就能通过初始值自动分析出正确的属性类型。
* 若您无法为属性赋值上正确的初始值时(有初始值，比如null),运行时EXML解析器会把此属性当做string来处理，若完全没有初始值，将会报错找不到节点属性，
* 这种情况下可以手动调用此方法显式注册属性类型。
*
* @param classDefinition 要注册的类定义。
* @param property 要注册的属性,注意属性名不能以 _ 或 $ 符开头。
* @param type 要注册的类型,例如：“boolean","number","string","Array","egret.Rectangle"
* @param asDefault 是否将此属性注册为组件的默认属性,一个组件只可以设置一个默认属性。注册了组件默认属性后，在EXML中可以使用省略属性节点的写法，
* @example：
* <pre>
* <s:Scroller>
* <s:viewport>
* <s:Group/>
* </e:viewport>
* </e:Scroller>
* </pre>
* 因为 viewport 已经注册为 Scroller 的默认属性，上面的例子可以等效为：
* <pre>
* <s:Scroller>
* <s:Group/>
* </e:Scroller>
* </pre>
* @version Egret 2.4
* @version eui 1.0
* @platform Web,Native
* @language zh_CN
*/
export function registerProperty(classDefinition:any,property:string,type:string,asDefault?:boolean):void{
if (DEBUG) {
if(!classDefinition){
egret.$error(1003, "classDefinition");
}
if(!classDefinition.prototype){
egret.$error(1012,"classDefinition")
}
if(!property){
egret.$error(1003, "property");
}
if(!type){
egret.$error(1003, "type");
}
}
let prototype: any = classDefinition.prototype;
prototype.__meta__ = prototype.__meta__||{};
prototype.__meta__[property] = type;
if(asDefault){
prototype.__defaultProperty__ = property;
}
}
}