API Docs for: TWaver HTML5 5.7.5
Show:

twaver.Property Class

Extends twaver.Data

属性项对象

属性项是一种基本元素，它是存在于属性容器中的（PropertyBox）。属性列是用来显示在属性页中的基本元素

Constructor

twaver.Property

(
  • id
)
twaver.Property

Parameters:

  • id Object

    ID为属性的唯一标识。如果为null，TWaver内部会按照一定的规则赋值。ID可以为string，number类型，也可以为Object类型。为string或number类型时指的是属性的ID，如果为Object类型，可以传入一个属性的对象，比如： var property = new twaver.Property({ name:'Name', horizontalAlign:'left', width:100});

Returns:

twaver.Property:

Item Index

Methods

Properties

Methods

twaver.Data.addChild

(
  • child
  • [index]
)
Boolean

Inherited from twaver.Data:

在父亲数据下添加孩子数据，index为添加的孩子数据的顺序号，树中同层下的孩子顺序可以通过这个参数来控制。默认为空，添加在最后一个位置

Parameters:

  • child twaver.Data

    添加的孩子数据

  • [index] Number optional

    添加的孩子数据的顺序，树中的同层下的孩子顺序是通过这个参数来控制的。默认为空，也就是添加在最后一个位置

Returns:

Boolean:

添加成功返回true，否则为false

twaver.Data.clearChildren

() Boolean

Inherited from twaver.Data:

清除这个数据下所有的孩子。注意，这个方法只是切断它们之间的父子关系，并不会从DataBox中将孩子数据删除

Returns:

Boolean:

true为操作成功，false为操作失败

twaver.Data.deserializeClientJson

(
  • serializer
  • json
  • clientProp
)

Inherited from twaver.Data:

反序列化JSON数据到数据对象的自定义属性

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • json String

    JSON数据

  • clientProp String

    自定义的属性名

twaver.Data.deserializeClientXml

(
  • serializer
  • clientXml
  • clientProp
)

Inherited from twaver.Data:

反序列化XML数据到数据对象的自定义属性值

Parameters:

  • serializer twaver.XmlSerializer

    XML的序列化对象

  • clientXml String

    XML数据片段

  • clientProp String

    自定义属性名

twaver.Data.deserializeJson

(
  • serializer
  • json
)

Inherited from twaver.Data:

将JSON数据反序列化为数据对象

Parameters:

twaver.Data.deserializePropertyJson

(
  • serializer
  • json
  • property
)

Inherited from twaver.Data:

反序列化JSON数据到数据对象的自身属性

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • json String

    JSON数据片段

  • property String

    数据自身属性名

twaver.Data.deserializePropertyXml

(
  • serializer
  • propertyXml
  • property
)

Inherited from twaver.Data:

反序列化XML数据到数据对象的自身属性

Parameters:

  • serializer twaver.XmlSerializer

    XML序列化对象

  • propertyXml String

    XML数据片段

  • property String

    数据自身属性名

twaver.Data.deserializeXml

(
  • serializer
  • xml
)

Inherited from twaver.Data:

将XML数据反序列化为数据对象

Parameters:

twaver.Data.getChildAt

(
  • index
)
twaver.Data

Inherited from twaver.Data:

获取某个序号值上的孩子对象

Parameters:

  • index Number

    数据的顺序值

Returns:

twaver.Data:

孩子数据对象

twaver.Data.getChildren

() twaver.List

Inherited from twaver.Data:

获取这个数据对象下的所有孩子对象

Returns:

twaver.List:

孩子对象的集合

twaver.Data.getChildrenSize

() Number

Inherited from twaver.Data:

获取数据对象下孩子的数量

Returns:

Number:

孩子数据的数量

twaver.Data.getClient

(
  • clientProp
)
Object

Inherited from twaver.Data:

获取自定义的属性，Client属性一般用于存放用户自定在数据对象上的属性

Parameters:

  • clientProp String

    自定义的属性名

Returns:

Object:

返回属性值

twaver.Data.getClientMap

() twaver.List

Inherited from twaver.Data:

获取所有的自定义属性

Returns:

twaver.List:

自定义属性的集合

twaver.Data.getClientProperties

() twaver.List

Inherited from twaver.Data:

获取所有自定义的属性名。Client属性一般用于存放用户自定在数据对象上的属性

Returns:

twaver.List:

自定义属性的集合

twaver.Data.getIcon

() String

Inherited from twaver.Data:

得到这个数据的图标，图标是用于在树上显示的。

Returns:

String:

返回图标的名称

twaver.Data.getId

() Object

Inherited from twaver.Data:

得到数据的ID，ID是用于唯一标识数据对象的，在同一个数据容器中的数据ID不能重复

Returns:

Object:

数据的ID编号

twaver.Data.getName

() String

Inherited from twaver.Data:

获取数据对象的名称

Returns:

String:

数据对象的名称值

twaver.Data.getName2

() String

Inherited from twaver.Data:

获取数据对象的名称2

Returns:

String:

返回数据对象的名称2

twaver.Data.getParent

() twaver.Data

Inherited from twaver.Data:

获取数据对象的父亲，每个数据对象只能有一个父亲节点

Returns:

twaver.Data:

父亲对象

twaver.Data.getToolTip

() String

Inherited from twaver.Data:

获取数据对象的悬浮标签，悬浮标签是用于在视图上显示的，比如network，tree，table。悬浮标签在视图上显示片刻便会消失。

Returns:

String:

数据对象的悬浮标签内容

twaver.Data.hasChildren

() Boolean

Inherited from twaver.Data:

判断这个数据对象下是否有孩子对象

Returns:

Boolean:

true为有孩子对象，否则为false

twaver.Data.isDescendantOf

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否是指定数据对象的子孙节点

Parameters:

Returns:

Boolean:

true为子孙节点，否则为false

twaver.Data.isParentOf

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否是指定数据对象的父亲

Parameters:

Returns:

Boolean:

true为指定数据对象的父亲，否则为false

twaver.Data.isRelatedTo

(
  • data
)
Boolean

Inherited from twaver.Data:

判断是否和指定数据对象有关联关系，如果这个数据是指定数据对象的子孙或者指定数据对象是这个数据的子孙都称为有关联关系

Parameters:

Returns:

Boolean:

true为有关联关系，否则为false

twaver.Data.newInstance

() twaver.Data

Inherited from twaver.Data:

实例化数据对象

Returns:

twaver.Data:

数据对象

twaver.Data.onChildAdded

(
  • child
  • index
)

Inherited from twaver.Data:

添加完孩子成功后会回调这个方法

Parameters:

  • child twaver.Data

    添加的孩子对象

  • index Number

    孩子添加的顺序

twaver.Data.onChildRemoved

(
  • child
  • index
)

Inherited from twaver.Data:

删除指定孩子对象时会回调这个方法

Parameters:

  • child twaver.Data

    删除的孩子对象

  • index Number

    删除的孩子对象的顺序序号

twaver.Data.onChildrenCleared

(
  • children
)

Inherited from twaver.Data:

清除所有指定孩子对象时会回调这个方法

Parameters:

twaver.Data.onClientChanged

(
  • clientProp
  • oldValue
  • newValue
)

Inherited from twaver.Data:

当数据对象的Client属性发生更改时会回调此方法

Parameters:

  • clientProp String

    属性名

  • oldValue String

    原值

  • newValue String

    新值

twaver.Data.onParentChanged

(
  • oldParent
  • parent
)

Inherited from twaver.Data:

当数据对象的父亲发生更改时回调此方法

Parameters:

  • oldParent twaver.Data

    数据对象原来的父亲节点

  • parent String

    数据对象新的父亲节点

twaver.Data.removeChild

(
  • child
)
Boolean

Inherited from twaver.Data:

删除指定的孩子对象

Parameters:

Returns:

Boolean:

返回true表示删除成功，false为删除失败

twaver.Data.serializeClientJson

(
  • serializer
  • clientPrope
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

序列化数据元素的自定义属性到JSON片段

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • clientPrope String

    数据对象的自定义属性名

  • newInstance twaver.Data

    序列化的数据对象

  • dataObject Object

    JSON数据对象

twaver.Data.serializeClientXml

(
  • serializer
  • clientPrope
  • newInstance
)

Inherited from twaver.Data:

序列化数据元素的自定义属性到XML片段

Parameters:

twaver.Data.serializeJson

(
  • serializer
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

将数据元素序列化成JSON片段

Parameters:

twaver.Data.serializePropertyJson

(
  • serializer
  • property
  • newInstance
  • dataObject
)

Inherited from twaver.Data:

序列化数据元素属性到JSON片段

Parameters:

  • serializer twaver.JsonSerializer

    JSON序列化对象

  • property String

    序列化的属性名称

  • newInstance twaver.Data

    序列化的实例对象

  • dataObject Object

    JSON数据对象

twaver.Data.serializePropertyXml

(
  • serializer
  • property
  • newInstance
)

Inherited from twaver.Data:

序列化数据元素属性到XML片段

Parameters:

twaver.Data.serializeXml

(
  • serializer
  • newInstance
)

Inherited from twaver.Data:

将数据元素序列化成XML片段

Parameters:

twaver.Data.setClient

(
  • clientProp
  • newValue
)
twaver.Data

Inherited from twaver.Data:

设置自定义的属性的值

Parameters:

  • clientProp String

    自定义属性的名称

  • newValue Object

    自定义属性的值

Returns:

twaver.Data:

数据对象本身

twaver.Data.setIcon

(
  • v
)

Inherited from twaver.Data:

设置数据元素的Icon。Icon和Image是类似的，但需要注意，Icon一般是在树上显示的，而Image是在network上显示的。

Parameters:

  • v String

    数据元素的Icon名称

twaver.Data.setName

(
  • v
)

Inherited from twaver.Data:

设置数据元素的名称

Parameters:

  • v String

    数据元素的名称

twaver.Data.setName2

(
  • v
)

Inherited from twaver.Data:

设置数据对象的名称2

Parameters:

  • v String

    数据对象的名称2

twaver.Data.setParent

(
  • parent
)

Inherited from twaver.Data:

设置数据元素的父亲，每个数据元素只能设置一个父亲

Parameters:

twaver.Data.setToolTip

(
  • v
)

Inherited from twaver.Data:

设置悬浮标签的显示内容。当鼠标移至数据元素时，视图上就会显示这个悬浮标签一段时间。

Parameters:

  • v String

    悬浮标签显示的内容

twaver.Data.toChildren

(
  • matchFunction
  • scope
)
String

Inherited from twaver.Data:

根据指定的函数，将数据元素的孩子转换成List集合

Parameters:

  • matchFunction Function

    指定的函数

  • scope String

    函数的作用域，为空时指的是window

Returns:

String:

孩子数据的集合

twaver.Property.getCategoryName

() String

获取属性项所属的Category的名称

Returns:

String:

Category的名称

twaver.Property.getEnumInfo

() Object

获取编辑属性项时显示的内容。如果属性项中设置了多个值，编辑时会以combobox的样式来呈现。 例如：{map:{1:'male', 2:'female'}, values:[1, 2]} 或 ['male', 'female']。

Returns:

Object:

编辑属性项时显示的内容

twaver.Property.getHorizontalAlign

() String

获取属性项的水平对齐方式。可选值： left：左对齐。 right：右对齐。
center：中间对齐。
justify: 填充对齐，使得一行上每个文字的间隔相同。
inherit：继承于父亲的对齐方式。 更多的可以参考CSS中的text-align样式

Returns:

String:

水平对齐方式

twaver.Property.getPropertyName

() String

获取属性表的属性项所对应的网元属性名

Returns:

String:

属性表的属性项所对应网元的属性名

twaver.Property.getPropertyType

() String

获取网元属性的类型。可选值有 'field'：网元的自身变量属性， 'accessor', 网元get/set方法的属性， 'style'：网元样式属性, 'client'：网元自定义属性

Returns:

String:

网元属性类型

twaver.Property.getValue

(
  • data
  • view
)
Object

从Data中获取对应的属性项的值，TWaver内部使用

Parameters:

Returns:

Object:

返回属性项的值

twaver.Property.getValueType

() String

获取属性项中值的类型。可选值有： 'string'：字符串类型， 'boolean'：布尔类型， 'color'：颜色类型， 'int'：整型， 'number'：数字类型

Returns:

String:

属性项中值的类型

twaver.Property.isEditable

() Boolean

判断属性表的属性项是否可编辑

Returns:

Boolean:

true为可编辑，false不可编辑

twaver.Property.isInnerText

() Boolean

获取属性页列内容是否为纯文本

Returns:

Boolean:

返回属性页列内容是否为纯文本

twaver.Property.setCategoryName

(
  • v
)

设置属性项所属的Category的名称

Parameters:

  • v String

    Category的名称

twaver.Property.setEditable

(
  • v
)

设置属性表的属性项是否可编辑

Parameters:

  • v Boolean

    true为可编辑，false不可编辑

twaver.Property.setEnumInfo

(
  • v
)

设置编辑属性项时显示的内容。如果属性项中设置了多个值，编辑时会以combobox的样式来呈现。 例如：{map:{1:'male', 2:'female'}, values:[1, 2]} 或 ['male', 'female']

Parameters:

  • v Object

    编辑属性项时显示的内容

twaver.Property.setHorizontalAlign

(
  • v
)

设置属性项的水平对齐方式。可选值： left：左对齐。 right：右对齐。
center：中间对齐。
justify: 填充对齐，使得一行上每个文字的间隔相同。
inherit：继承于父亲的对齐方式。 更多的可以参考CSS中的text-align样式

Parameters:

  • v String

    水平对齐方式

twaver.Property.setInnerText

(
  • v
)

设置属性页列内容是否为纯文本

Parameters:

  • v Boolean

    属性页列内容是否为纯文本

twaver.Property.setPropertyName

(
  • value
)

设置属性表的属性项所对应的网元属性名

Parameters:

  • value String

    属性表的属性项所对应网元的属性名

twaver.Property.setPropertyType

(
  • value
)

设置网元属性的类型。可选值有 'field'：网元的自身变量属性， 'accessor', 网元get/set方法的属性， 'style'：网元样式属性, 'client'：网元自定义属性

Parameters:

  • value String

    网元属性的类型

twaver.Property.setValue

(
  • data
  • value
  • view
)
twaver.Data

设置属性页上的值回写到data中，TWaver内部使用

Parameters:

Returns:

twaver.Data:

twaver.Property.setValueType

(
  • v
)

得到属性项中值的类型。可选值有： 'string'：字符串类型， 'boolean'：布尔类型， 'color'：颜色类型， 'int'：整型， 'number'：数字类型

Parameters:

  • v String

    属性项中值的类型

twaver.PropertyChangeDispatcher.addPropertyChangeListener

(
  • listener
  • [scope]
  • [ahead]
)

Inherited from twaver.PropertyChangeDispatcher:

添加属性变化监听器，用于监听属性变化

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    可选，属性变化监听器的作用域，默认为null，即全局

  • [ahead] Boolean optional

    可选，是否将此监听放在最前面，默认为false

Example:

var dispatcher = new twaver.PropertyChangeDispatcher(); dispatcher.addPropertyChangeListener(function (e) { console.log(e.property, e.newValue, e.oldValue); });

twaver.PropertyChangeDispatcher.firePropertyChange

(
  • property
  • oldValue
  • newValue
)
Boolean

Inherited from twaver.PropertyChangeDispatcher:

派发属性变化事件，属性变化时调用此方法

Parameters:

  • property String

    发生变化的属性

  • oldValue Object

    和此属性相关的旧值

  • newValue Object

    和此属性相关的新值

Returns:

Boolean:

如果新值和旧值相等则返回false，否则返回true

twaver.PropertyChangeDispatcher.getClassName

() String

Inherited from twaver.PropertyChangeDispatcher:

获取此类的字符串类名

Returns:

String:

返回此类的字符串类名

twaver.PropertyChangeDispatcher.onPropertyChanged

(
  • e
)

Inherited from twaver.PropertyChangeDispatcher:

属性变化时（firePropertyChange）触发的动作，不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • e Object

    属性变化事件，包含property、oldValue和newValue的Object对象

twaver.PropertyChangeDispatcher.removePropertyChangeListener

(
  • listener
  • [scope]
)

Inherited from twaver.PropertyChangeDispatcher:

删除指定作用域的属性变化监听器，作用域必须和添加监听器时的作用域一致，相同的作用域的相同监听器只能成功添加一次

Parameters:

  • listener Function

    属性变化监听器

  • [scope] Object optional

    属性变化监听器的作用域，可选，默认为null，代表全局

Properties

IClient

Boolean

Inherited from twaver.Data:

IClient标志，默认为true，表明这个对象是IClient类型。

IData

Boolean

Inherited from twaver.Data:

IData属性标志，默认为true，表明这个对象是IData的类型

IProperty

Boolean

是否是属性项的标志

isVisible

Boolean

true表示属性项显示，false不显示

renderEditor

Object

这个属性项所对应的render的Editor

renderName

String

这个属性项所对应的render的名称

renderValue

Object

这个属性项所对应的render的值