ElementSchema类 参考

Public 成员函数
	ElementSchema (String name)
String	GetName ()
void	SetName (String val)
String	GetTitle ()
void	SetTitle (String val)
String	GetIcon ()
void	SetIcon (String val)
String	GetCategory ()
void	SetCategory (String val)
String	GetModifier ()
void	SetModifier (String val)
String	GetSector ()
void	SetSector (String val)
void	Initialize ()
void	AddPropertyItem (String itemName)
boolean	HasPropertyItem (String itemName)
ParameterDict	GetParameterDict ()
void	RemoveParameter (String name)
ParameterValue	FindParameter (String name)
ParameterIterator	CreateParameterIterator ()
void	AddAction (String name, EntityAction action)
void	RemoveAction (String name)
StringList	GetActionNames ()
boolean	OnParameterChanged (Document document, SchemaComponent properties)
boolean	OnParameterChanged (Document document, PropertiesComponent properties)
Element	CreateInstance (String name, Document pOwner)
ObjectId	OnCreateInstance (Document pOwner)
String	OnGetInstanceClassName ()
boolean	OnExecuteAction (Document doc, EntityElement pEntity, String action, ParameterDict pParams)
void	InitializeComponent (GeneralComponent pComponent)
NodeComponent	CreateNodeComponent (String name, Document pOwner)

详细描述

<>
Element扩展模板

成员函数说明

AddAction()

void ElementSchema.AddAction	(	String	name,
		EntityAction	action )

定义实体的行为

参数

name	名字
action	行为对象

AddPropertyItem()

void ElementSchema.AddPropertyItem

(

String

itemName

)

添加属性标识。标识由应用层自己定义。

参数

itemName

标识名称

CreateInstance()

Element ElementSchema.CreateInstance	(	String	name,
		Document	pOwner )

创建实例，并做初始化。

参数

name	名称
pOwner	文档

返回

对象ID

CreateNodeComponent()

NodeComponent ElementSchema.CreateNodeComponent	(	String	name,
		Document	pOwner )

NodeComponent：创建Node组件。

参数

name	名称
pOwner	文档

返回

对象ID

CreateParameterIterator()

ParameterIterator ElementSchema.CreateParameterIterator

(

)

创建参数迭代器

返回

参数遍历器

FindParameter()

ParameterValue ElementSchema.FindParameter

(

String

name

)

查找参数

参数

name

参数名

返回

参数值

GetActionNames()

StringList ElementSchema.GetActionNames

(

)

获取关联的EntityAction名称列表

返回

名称列表

GetParameterDict()

ParameterDict ElementSchema.GetParameterDict

(

)

获取参数列表

HasPropertyItem()

boolean ElementSchema.HasPropertyItem

(

String

itemName

)

是否存在某个属性的标识。

参数

itemName

标识名称

返回

true存在

Initialize()

void ElementSchema.Initialize

(

)

初始化。如设置参数值

InitializeComponent()

void ElementSchema.InitializeComponent

(

GeneralComponent

pComponent

)

GeneralComponent: 用ElementSchema的属性来初始化组件

返回

组件

OnCreateInstance()

ObjectId ElementSchema.OnCreateInstance

(

Document

pOwner

)

创建实例。默认根据OnGetInstanceClassName返回的类名称来创建。

参数

pOwner

文档。

返回

对象的ID

OnExecuteAction()

boolean ElementSchema.OnExecuteAction	(	Document	doc,
		EntityElement	pEntity,
		String	action,
		ParameterDict	pParams )

执行自定义命令

参数

doc	文档
pEntity	Entity对象
action	命令
pParams	参数

返回

是否成功

OnGetInstanceClassName()

String ElementSchema.OnGetInstanceClassName

(

)

返回自定义对象的类名。必须是从Element继承的类的名称

返回

类名称

OnParameterChanged() [1/2]

boolean ElementSchema.OnParameterChanged	(	Document	document,
		PropertiesComponent	properties )

PropertiesComponent: 当对象的参数发生更改的时候调用。一般用于更新关联的属性。

参数

document	文档
properties	属性

返回

OnParameterChanged() [2/2]

boolean ElementSchema.OnParameterChanged	(	Document	document,
		SchemaComponent	properties )

当对象的参数发生更改的时候调用。一般用于重新生成几何。

参数

document	文档
properties	几何参数表

返回

是否成功

RemoveAction()

void ElementSchema.RemoveAction

(

String

name

)

移除行为

参数

name

名字

RemoveParameter()

void ElementSchema.RemoveParameter

(

String

name

)

移除参数

参数

name

参数名