API Docs for: TWaver HTML5 5.7.5
Show:

twaver.controls.PropertySheet Class

Extends twaver.controls.View

属性表视图

属性表是TWaver视图组件中的一种，它和数据容器绑定，并显示数据容器中当前选中的网元属性。 属性表是只有两列的表格，以键、值这样的对应关系来显示属性，并可以对属性进行分组

Constructor

twaver.controls.PropertySheet

(
  • dataBox
)
twaver.controls.PropertySheet

Parameters:

Returns:

twaver.controls.PropertySheet:

Item Index

Methods

Methods

twaver.controls.ControlBase.addPool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

添加HTML元素缓存池

Parameters:

twaver.controls.ControlBase.adjustBounds

(
  • rect
)

Inherited from twaver.controls.ControlBase:

设置组件新的位置以及大小，twaver布局管理器（twaver.controls.SplitPane等）在大小变化时会调用此方法

Parameters:

  • rect Object

    新的位置以及大小，值为包含x、y、width和height属性的Object对象

twaver.controls.ControlBase.getView

() HTMLDivElement

Inherited from twaver.controls.ControlBase:

获取组件的HTML元素

Returns:

HTMLDivElement:

返回组件的HTML元素

twaver.controls.ControlBase.invalidate

(
  • [delay]
)

Inherited from twaver.controls.ControlBase:

无效组件，在等待指定毫秒数后，刷新组件（调用validate方法）,当组件属性更改后，须调用此方法，让组件重画

Parameters:

  • [delay] Number optional

    延迟刷新等待的毫秒数，可选，默认为twaver.Defaults.CALL_LATER_DELAY

twaver.controls.ControlBase.isAutoAdjustBounds

() Boolean

Inherited from twaver.controls.ControlBase:

获取视图是否自动计算Bounds（边界）

Returns:

Boolean:

是否自动调整Bounds

twaver.controls.ControlBase.removePool

(
  • pool
)

Inherited from twaver.controls.ControlBase:

删除HTML元素缓存池

Parameters:

twaver.controls.ControlBase.setAutoAdjustBounds

(
  • autoAdjustBounds
)

Inherited from twaver.controls.ControlBase:

设置视图是否自动计算Bounds

Parameters:

  • autoAdjustBounds Boolean

    是否自动计算Bounds

twaver.controls.ControlBase.validate

()

Inherited from twaver.controls.ControlBase:

重画组件，调用invalidate后，此方法会被调用

twaver.controls.ControlBase.validateImpl

()

Inherited from twaver.controls.ControlBase:

调用validate方法后，此方法会被调用，子类须重载此方法以重画组件

twaver.controls.PropertySheet.adjustWidth

()

调整属性表的宽度

twaver.controls.PropertySheet.cancelEditing

()

取消当前编辑器的编辑状态

twaver.controls.PropertySheet.collapse

(
  • categoryName
)

合并属性表上的指定的类别

Parameters:

  • categoryName String

    类别的名称

twaver.controls.PropertySheet.collapseAll

()

合并属性表上所有的类别

twaver.controls.PropertySheet.commitEditValue

(
  • editInfo
  • target
)

提交单元格中编辑的值，将这个值回写到Data的属性中

Parameters:

  • editInfo Object

    指定的单元格编辑器的信息，它是一个包含column和data的对象

  • target Object

    编辑器所对应的对象，它是一个包含type的对象，用于判断编辑器的类型

twaver.controls.PropertySheet.expand

(
  • categoryName
)

展开属性表上的指定的类别

Parameters:

  • categoryName String

    类别的名称

twaver.controls.PropertySheet.expandAll

()

展开属性表上所有的类别

twaver.controls.PropertySheet.getBorderColor

() String

获取属性表所有边框的颜色，默认为 twaver.Defaults.PROPERTYSHEET_BORDER_COLOR

Returns:

String:

边框的颜色

twaver.controls.PropertySheet.getCategoryName

(
  • property
)
String

获取指定属性的类别名称

Parameters:

Returns:

String:

属性所对应的类别名称

twaver.controls.PropertySheet.getCollapseIcon

() String

获取类别合并时的图标，默认为twaver.Defaults.PROPERTYSHEET_COLLAPSE_ICON

Returns:

String:

合并的图标

twaver.controls.PropertySheet.getColumnLineWidth

() Number

获取属性表上列的线宽，默认为 twaver.Defaults.PROPERTYSHEET_COLUMN_LINE_WIDTH

Returns:

Number:

列的线宽

twaver.controls.PropertySheet.getCurrentData

() twaver.Data

获取属性表上当前显示的数据，默认为数据容器中最后一个选中的数据

Returns:

twaver.Data:

当前显示的数据

twaver.controls.PropertySheet.getDataBox

() twaver.DataBox

获取绑定的数据容器

Returns:

twaver.DataBox:

指定的数据容器

twaver.controls.PropertySheet.getDataDiv

() HTMLDivElement

获取属性表上数据所在的DIV

Returns:

HTMLDivElement:

包含数据的DIV

twaver.controls.PropertySheet.getExpandIcon

() String

获取属性表的类别展开的图标，默认为twaver.Defaults.TREE_EXPAND_ICON

Returns:

String:

属性表的类别展开时的图标

twaver.controls.PropertySheet.getIndent

() Number

获取属性表上父亲和孩子之间的缩进，默认为twaver.Defaults.PROPERTYSHEET_INDENT

Returns:

Number:

属性表上父亲和孩子之间的缩进值

twaver.controls.PropertySheet.getPropertyBox

() twaver.PropertyBox

获取属性数据容器

Returns:

twaver.PropertyBox:

包含属性的容器

twaver.controls.PropertySheet.getPropertyNameHorizontalAlign

() String

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

Returns:

String:

属性名的水平对齐方式

twaver.controls.PropertySheet.getPropertyNameWidth

() Number

获取属性名所在的列所占的宽度，默认为twaver.Defaults.PROPERTYSHEET_PROPERTY_NAME_WIDTH

Returns:

Number:

属性名所在的列所占的宽度

twaver.controls.PropertySheet.getResizeTolerance

() Number

获取当鼠标靠近分隔条时可以改变列宽的像素数。默认为twaver.Defaults.PROPERTYSHEET_RESIZE_TOLERANCE

Returns:

Number:

当鼠标靠近分隔条时可以改变列宽的像素数

twaver.controls.PropertySheet.getRowHeight

() Number

获取属性表的行高。默认为 twaver.Defaults.PROPERTYSHEET_ROW_HEIGHT

Returns:

Number:

属性表的行高

twaver.controls.PropertySheet.getRowIndexAt

(
  • e
)
Number

获取鼠标下的数据在属性表上的行数

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Number:

数据的行数

twaver.controls.PropertySheet.getRowLineWidth

() Number

设置属性表每行线的宽度，默认为twaver.Defaults.PROPERTYSHEET_ROW_LINE_WIDTH

Returns:

Number:

行之间线的宽度

twaver.controls.PropertySheet.getSortFunction

() Function

获取属性表排序的函数

Returns:

Function:

排序的函数

twaver.controls.PropertySheet.getSumWidth

() Number

获取属性表的总宽度，默认为twaver.Defaults.PROPERTYSHEET_SUM_WIDTH

Returns:

Number:

属性表的宽度

twaver.controls.PropertySheet.getValue

(
  • data
  • property
)
Object

获取属性表上指定的属性所对应的数据值

Parameters:

Returns:

Object:

数据的属性值

twaver.controls.PropertySheet.getVisibleFunction

() Boolean

获取属性表上可见过滤器，用于过滤某个属性获取某些网元在属性表上是否可见

Returns:

Boolean:

true为可见，否则为false

Example:

sheet.setVisibleFunction(function (property) { return box.getSelectionModel().getLastData() instanceof twaver.Link; });

twaver.controls.PropertySheet.handleChange

(
  • e
)

处理更新

Parameters:

  • e Event

    更新事件

twaver.controls.PropertySheet.handlePropertyChange

(
  • e
)

当数据容器中数据的属性发生变化时调用此方法，用于更新属性表的显示内容。用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    数据容器的属性更改事件

twaver.controls.PropertySheet.handleSelectionChange

(
  • e
)

当数据容器中数据的选择状态发生变化时调用此方法，用于刷新属性表显示的内容，用户不需要调用此方法，但可以重写此方式实现自己的逻辑

Parameters:

  • e Object

    数据选择状态更改的事件

twaver.controls.PropertySheet.invalidatePropertyBox

()

无效属性容器，当属性容器中的数据或数据的属性发生变化时，调用此方法。在等待指定的毫秒数后刷新属性表界面，让属性表重画

twaver.controls.PropertySheet.isAutoAdjustable

() Boolean

判断是否需要自动调整属性表的宽度 默认为twaver.Defaults.PROPERTYSHEET_AUTO_ADJUSTABLE

Returns:

Boolean:

true为自动调整，否则为false

twaver.controls.PropertySheet.isCategorizable

() Boolean

判断是否显示类别分组。默认为twaver.Defaults.PROPERTYSHEET_CATEGORIZABLE

Returns:

Boolean:

true为显示，否则为false

twaver.controls.PropertySheet.isCellEditable

(
  • data
  • property
)
Boolean

获取数据中指定的属性单元格是否可编辑

Parameters:

Returns:

Boolean:

true为可编辑，否则为false

twaver.controls.PropertySheet.isEditable

() Boolean

属性表是否可编辑

Returns:

Boolean:

true为可编辑，否则为false

twaver.controls.PropertySheet.isExpanded

(
  • categoryName
)
Boolean

判断指定的类别是否是展开状态

Parameters:

  • categoryName String

    指定的类别名称

Returns:

Boolean:

true为展开，否则为false

twaver.controls.PropertySheet.isVisible

(
  • property
)
Boolean

判断指定的属性是否可见

Parameters:

  • property String

    指定的属性

Returns:

Boolean:

true为可见，否则为false

twaver.controls.PropertySheet.onCategoryRendered

(
  • div
  • categoryName
)

当绘制属性表的类别时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • div HTMLDivElement

    类别对应的Div元素

  • categoryName String

    类别名

twaver.controls.PropertySheet.onEditorRendered

(
  • params
)

当结束编辑状态时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params String

twaver.controls.PropertySheet.onNameRendered

(
  • params
)

当调用绘制属性表的属性名称时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params Object

    行信息的对象，它是一个包含view,data,property,value的对象

twaver.controls.PropertySheet.onValueRendered

(
  • params
)

当绘制属性表的属性值时，调用此方法。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params Object

    行信息的对象，它是一个包含view,data,property,value的对象

twaver.controls.PropertySheet.renderCategory

(
  • div
  • categoryName
)

绘制属性表的类别。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • div HTMLDivElement

    包含指定的类别的DIV

  • categoryName String

    指定的类别名称

twaver.controls.PropertySheet.renderEditor

(
  • params
)

绘制属性表的编辑状态。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params String

    编辑状态

twaver.controls.PropertySheet.renderName

(
  • params
)

绘制属性表的属性名称。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params Object

    它是一个包含view,data,property,value和nameRender div的对象

twaver.controls.PropertySheet.renderValue

(
  • params
)

绘制属性表的属性值。用户不需要自己调用此方法，但可以重载此方法，添加自定义的逻辑

Parameters:

  • params Object

    它是一个包含view,data,property,value和nameRender div的对象

twaver.controls.PropertySheet.setAutoAdjustable

(
  • v
)

是否需要自动调整属性表的大小，默认为twaver.Defaults.PROPERTYSHEET_AUTO_ADJUSTABLE

Parameters:

  • v Boolean

    是否自动调整

twaver.controls.PropertySheet.setBorderColor

(
  • v
)

设置属性表所有边框的颜色，默认为 twaver.Defaults.PROPERTYSHEET_BORDER_COLOR

Parameters:

  • v String

    边框的颜色

twaver.controls.PropertySheet.setCategorizable

(
  • v
)

设置是否显示类别分组。默认为twaver.Defaults.PROPERTYSHEET_CATEGORIZABLE

Parameters:

  • v Boolean

    true为显示，否则为false

twaver.controls.PropertySheet.setCollapseIcon

(
  • v
)

设置类别合并时的图标，默认为twaver.Defaults.PROPERTYSHEET_COLLAPSE_ICON

Parameters:

  • v String

    合并的图标

twaver.controls.PropertySheet.setColumnLineWidth

(
  • v
)

设置属性表上列的线宽，默认为 twaver.Defaults.PROPERTYSHEET_COLUMN_LINE_WIDTH

Parameters:

  • v Number

    列的线宽

twaver.controls.PropertySheet.setDataBox

(
  • dataBox
)

设置绑定的数据容器

Parameters:

twaver.controls.PropertySheet.setEditable

(
  • v
)

设置属性表是否可编辑，默认为twaver.Defaults.PROPERTYSHEET_EDITABLE

Parameters:

  • v Boolean

    true为可编辑，否则为false

twaver.controls.PropertySheet.setExpandIcon

(
  • v
)

设置属性表的Category展开的图标，默认为twaver.Defaults.TREE_EXPAND_ICON

Parameters:

  • v String

    属性表的Category展开时的图标

twaver.controls.PropertySheet.setIndent

(
  • v
)

设置属性表上父亲和孩子之间的缩进，默认为twaver.Defaults.PROPERTYSHEET_INDENT

Parameters:

  • v Number

    属性表上父亲和孩子之间的缩进值

twaver.controls.PropertySheet.setPropertyNameHorizontalAlign

(
  • v
)

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

Parameters:

  • v String

    属性名的水平对齐方式

twaver.controls.PropertySheet.setPropertyNameWidth

(
  • v
)

设置属性名所在的列所占的宽度，默认为twaver.Defaults.PROPERTYSHEET_PROPERTY_NAME_WIDTH

Parameters:

  • v Number

    属性名所在的列所占的宽度

twaver.controls.PropertySheet.setResizeTolerance

(
  • v
)

设置当鼠标靠近分隔条多少像素时即可以改变列宽。默认为twaver.Defaults.PROPERTYSHEET_RESIZE_TOLERANCE

Parameters:

  • v Number

    当鼠标靠近分隔条多少像素时可以改变列宽的像素数

twaver.controls.PropertySheet.setRowHeight

(
  • v
)

设置属性表的行高。默认为 twaver.Defaults.PROPERTYSHEET_ROW_HEIGHT

Parameters:

  • v Number

    属性表的行高

twaver.controls.PropertySheet.setRowLineWidth

(
  • v
)

设置属性表每行线的宽度，默认为twaver.Defaults.PROPERTYSHEET_ROW_LINE_WIDTH

Parameters:

  • v Number

    行之间线的宽度

twaver.controls.PropertySheet.setSelectColor

(
  • v
)

设置选中属性表上的行的颜色，默认为 twaver.Defaults.SELECT_COLOR

Parameters:

  • v String

    选中行的颜色

twaver.controls.PropertySheet.setSortFunction

(
  • v
)

设置属性表排序的函数

Parameters:

  • v Object

    排序的函数

twaver.controls.PropertySheet.setSumWidth

(
  • v
)

设置属性表的总宽度，默认为twaver.Defaults.PROPERTYSHEET_SUM_WIDTH

Parameters:

  • v Number

    属性表的宽度

twaver.controls.PropertySheet.setValue

(
  • data
  • property
  • value
)

将属性页上指定的属性值设置到数据对象上，TWaver内部使用

Parameters:

twaver.controls.PropertySheet.setVisibleFunction

(
  • v
)

设置属性表上可见过滤器，用于过滤某个属性获取某些网元在属性表上是否可见

Parameters:

  • v Boolean

    true为可见，否则为false

Example:

sheet.setVisibleFunction(function (property) { return box.getSelectionModel().getLastData() instanceof twaver.Link; });

twaver.controls.PropertySheet.updateCurrentData

()

更新属性表中当前显示的数据，默认显示的是最后一个选中的网元

twaver.controls.PropertySheet.updateCurrentRowIndex

(
  • newIndex
)

更新当前的行号

Parameters:

  • newIndex Number

    指定的行号

twaver.controls.PropertySheet.validateDisplay

()

当属性表发生变化时，调用此方法，让属性表重画

twaver.controls.PropertySheet.validateModel

()

当属性表中的数据发生变化时，调用此方法，让属性面板重画

twaver.controls.View.centerByLogicalPoint

(
  • x
  • y
  • [animate]
)

Inherited from twaver.controls.View:

将视图的中心点滚动到指定的逻辑坐标

Parameters:

  • x Number

    视图中心点x坐标

  • y Number

    视图中心点y坐标

  • [animate] Boolean optional

    可选，如果为true，则有动画效果，否者没有，默认为false

twaver.controls.View.checkZoom

(
  • value
)
Number

Inherited from twaver.controls.View:

核查缩放级别，如果缩放级别大于maxZoom，则返回maxZoom；如果小于minZoom，则返回minZoom

Parameters:

  • value Number

    缩放级别

Returns:

Number:

返回修正后的缩放级别

twaver.controls.View.getAlarmFillColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的告警填充色，默认如果数据元是网元，则返回网元的最高新发告警颜色，否则返回null

Parameters:

Returns:

String:

返回指定数据元的告警填充色

twaver.controls.View.getInnerColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的填充颜色，默认如果数据元是网元，而且有新发告警，则返回最高级别新发告警的颜色，否则返回样式属性inner.color的值

Parameters:

Returns:

String:

返回指定数据元的填充颜色

twaver.controls.View.getLogicalPoint

(
  • e
)
Object

Inherited from twaver.controls.View:

获取鼠标所在的逻辑坐标，包含x，y属性

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Object:

返回鼠标所在的逻辑坐标，包含x，y属性

Example:

network.getView().addEventListener('mousedown', function (e) { var point = network.getLogicalPoint(e); console.log(point.x, point.y); });

twaver.controls.View.getMaxZoom

() Number

Inherited from twaver.controls.View:

获取最大缩放级别

Returns:

Number:

返回最大缩放级别

twaver.controls.View.getMinZoom

() Number

Inherited from twaver.controls.View:

获取最小缩放级别

Returns:

Number:

返回最小缩放级别

twaver.controls.View.getOuterColor

(
  • data
)
String

Inherited from twaver.controls.View:

获取指定数据元的边框颜色，默认情况下，如果数据元是网元，而且有传播告警，则返回传播告警的颜色，否者返回属性为outer.color的style值

Parameters:

Returns:

String:

返回指定数据元的边框颜色

twaver.controls.View.getRootDiv

() HTMLDivElement

Inherited from twaver.controls.View:

获取根div元素

Returns:

HTMLDivElement:

返回根div元素

twaver.controls.View.getZoom

() Number

Inherited from twaver.controls.View:

获取当前缩放级别

Returns:

Number:

返回当前缩放级别

twaver.controls.View.isValidEvent

(
  • e
)
Boolean

Inherited from twaver.controls.View:

获取指定鼠标事件是否合法，如果鼠标所在的位置在滚动条上，则不合法，否则合法

Parameters:

  • e MouseEvent

    鼠标事件

Returns:

Boolean:

如果指定鼠标事件是合法的，则返回true，否则返回false

twaver.controls.View.onZoomChanged

(
  • oldZoom
  • newZoom
)

Inherited from twaver.controls.View:

缩放级别变化时触发的动作，用户不需要调用此方法，但可以重载此方法执行自定义逻辑

Parameters:

  • oldZoom Number

    旧缩放级别

  • newZoom Number

    新缩放级别

twaver.controls.View.panByOffset

(
  • xoffset
  • yoffset
)
Object

Inherited from twaver.controls.View:

滚动水平和垂直滚动条指定偏移量

Parameters:

  • xoffset Number

    x坐标偏移量

  • yoffset Number

    y坐标偏移量

Returns:

Object:

返回实际偏移量，为包含x和y属性的对象

twaver.controls.View.setMaxZoom

(
  • value
)

Inherited from twaver.controls.View:

设置最大缩放级别

Parameters:

  • value Number

    缩放级别

twaver.controls.View.setMinZoom

(
  • value
)

Inherited from twaver.controls.View:

设置最小缩放级别

Parameters:

  • value Number

    缩放级别

twaver.controls.View.setTouchZoom

(
  • z
)

Inherited from twaver.controls.View:

触摸模式下设置缩放级别

Parameters:

  • z Number

    缩放级别

twaver.controls.View.setZoom

(
  • value
  • [animate]
)

Inherited from twaver.controls.View:

设置当前缩放级别

Parameters:

  • value Number

    缩放级别

  • [animate] Boolean optional

    缩放时，是否有动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomIn

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图放大twaver.Defaults.ZOOM_INCREMENT倍

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomOut

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图缩小twaver.Defaults.ZOOM_INCREMENT倍

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomOverview

(
  • [animate]
)

Inherited from twaver.controls.View:

将视图缩放到让所有数据元可见

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.View.zoomReset

(
  • [animate]
)

Inherited from twaver.controls.View:

还原缩放级别为1

Parameters:

  • [animate] Boolean optional

    是否使用动画效果，可选，默认为twaver.Defaults.ZOOM_ANIMATE

twaver.controls.ViewBase.addInteractionListener

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

Inherited from twaver.controls.ViewBase:

添加交互事件监听器，用于监听用户各种操作

Parameters:

  • listener Function

    回调函数

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

  • [ahead] Boolean optional

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

Example:

viewBase.addInteractionListener(function (e) { console.log(e.kind, e.element); });

kind可以为下列值： createElement 创建网元 clickElement 单击网元 doubleClickElement 双击网元 clickBackground 单击背景 doubleClickBackground 双击背景 removeElement 删除网元 selectAll 选中所有网元 upSubNetwork 进入上一层子网 enterSubNetwork 进入子网 bundleLink 展开或合并连线捆绑 expandGroup 展开组 liveMoveStart 开始实时移动网元 liveMoveBetween 正在实时移动网元 liveMoveEnd 结束实时移动网元 lazyMoveStart 开始延迟移动网元 lazyMoveBetween 正在延迟移动网元 lazyMoveEnd 结束延迟移动网元 liveResizeStart 开始实时改变网元大小 liveResizeBetween 正在实时改变网元大小 liveResizeEnd 结束实时改变网元大小 lazyResizeStart 开始延迟改变网元大小 lazyResizeBetween 正在延迟改变网元大小 lazyResizeEnd 结束延迟改变网元大小 selectStart 开始框选 selectBetween 正在框选 selectEnd 结束框选 liveMovePointStart 开始移动ShapeLink或ShapeNode的点 liveMovePointBetween 正在移动ShapeLink或ShapeNode的点 liveMovePointEnd 结束移动ShapeLink或ShapeNode的点

twaver.controls.ViewBase.addViewListener

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

Inherited from twaver.controls.ViewBase:

添加视图变化事件，用于在视图无效、刷新之前或刷新之后执行自定义动作

Parameters:

  • listener Function

    回调函数

  • [scope] Object optional

    可选，回调函数的作用域，默认为null，即全局

  • [ahead] Boolean optional

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

Example:

viewBase.addViewListener(function (e) { console.log(e.kind); }); kind可以为： invalidate 无效视图 validateStart 刷新视图前 validateEnd 刷新视图后

twaver.controls.ViewBase.fireInteractionEvent

(
  • evt
)

Inherited from twaver.controls.ViewBase:

派发交互事件

Parameters:

  • evt Object

    交互事件

twaver.controls.ViewBase.fireViewEvent

(
  • evt
)

Inherited from twaver.controls.ViewBase:

当视图需要重画时，TWaver调用此方法派发视图变化事件

Parameters:

  • evt Object

    视图变化事件

twaver.controls.ViewBase.getIcon

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的图标，默认返回data#getIcon

Parameters:

Returns:

String:

返回指定数据元的图标

twaver.controls.ViewBase.getLabel

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的标签，默认返回Data#getName

Parameters:

Returns:

String:

返回指定数据元的标签

twaver.controls.ViewBase.getSelectColor

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的选中颜色，默认值为twaver.Defaults.SELECT_COLOR

Parameters:

Returns:

String:

返回指定数据元的选中颜色

twaver.controls.ViewBase.getSelectionModel

() twaver.SelectionModel

Inherited from twaver.controls.ViewBase:

获取选择模型，如果ViewBase#isShareSelectionModel为true（默认值为true），则返回和ViewBase绑定的DataBox的SelectionModel，否则返回视图自己独立的SelectionModel

Returns:

twaver.SelectionModel:

返回选择模型

twaver.controls.ViewBase.getToolTip

(
  • data
)
String

Inherited from twaver.controls.ViewBase:

获取指定数据元的提示信息，默认返回Data#getToolTip

Parameters:

Returns:

String:

返回指定数据元的提示信息

twaver.controls.ViewBase.isFocusOnClick

() Boolean

Inherited from twaver.controls.ViewBase:

获取点击时是否让视图获得焦点

Returns:

Boolean:

返回点击时是否让视图获得焦点

twaver.controls.ViewBase.isSelectable

(
  • data
)
Boolean

Inherited from twaver.controls.ViewBase:

判断指定数据元是否可以被选择，此方法包装了SelectionModel的isSelectable方法

Parameters:

Returns:

Boolean:

返回指定数据元是否可以被选择

twaver.controls.ViewBase.isSelected

(
  • data
)
Boolean

Inherited from twaver.controls.ViewBase:

获取指定数据元是否已被选中

Parameters:

Returns:

Boolean:

返回指定数据元是否已被选中

twaver.controls.ViewBase.isShareSelectionModel

() Boolean

Inherited from twaver.controls.ViewBase:

获取是否和视图绑定的数据容器共享选择模型，默认为true

Returns:

Boolean:

返回是否和视图绑定的数据容器共享选择模型

twaver.controls.ViewBase.removeInteractionListener

(
  • listener
  • [scope]
)

Inherited from twaver.controls.ViewBase:

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

Parameters:

  • listener Function

    交互监听器

  • [scope] Object optional

    交互监听器的作用域，可选，默认为null，代表全局

twaver.controls.ViewBase.removeSelection

() twaver.List

Inherited from twaver.controls.ViewBase:

删除选中的网元

Returns:

twaver.List:

返回被删除的网元集合

twaver.controls.ViewBase.removeViewListener

(
  • listener
  • [scope]
)

Inherited from twaver.controls.ViewBase:

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

Parameters:

  • listener Function

    视图变化监听器

  • [scope] Object optional

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

twaver.controls.ViewBase.selectAll

() twaver.List

Inherited from twaver.controls.ViewBase:

选中所有网元

Returns:

twaver.List:

返回所有选中的网元

twaver.controls.ViewBase.setFocusOnClick

(
  • v
)

Inherited from twaver.controls.ViewBase:

设置点击时是否让Network获得焦点

Parameters:

  • v Boolean

    点击时是否让Network获得焦点

twaver.controls.ViewBase.setShareSelectionModel

(
  • shareSelectionModel
)

Inherited from twaver.controls.ViewBase:

设置是否和Network绑定的ElementBox共享选择模型，默认为true

Parameters:

  • shareSelectionModel Boolean

    是否和Network绑定的ElementBox共享选择模型

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，代表全局