Editor类 参考

类 Editor 继承关系图:

Public 成员函数
String	GetName ()
boolean	GetSubEditor ()
void	SetSubEditor (boolean val)
boolean	GetExiting ()
void	SetExiting (boolean val)
void	SetName (String name)
EnumEditorCode	Start (ViewContext ctx)
void	Finish (ViewContext ctx)
void	Reset (ViewContext ctx)
boolean	Commit (ViewContext ctx)
boolean	Preview (ViewContext ctx, boolean on)
boolean	Preview (ViewContext ctx)
boolean	Apply (ViewContext ctx)
void	Abort (ViewContext ctx)
EnumEditorCode	OnMouseDown (ViewContext ctx, InputEvent evt)
EnumEditorCode	OnMouseUp (ViewContext ctx, InputEvent evt)
EnumEditorCode	OnMouseMove (ViewContext ctx, InputEvent evt)
EnumEditorCode	OnMouseWheel (ViewContext ctx, InputEvent evt, int delta)
EnumEditorCode	OnKeyDown (ViewContext ctx, InputEvent evt)
EnumEditorCode	OnKeyUp (ViewContext ctx, InputEvent evt)
EnumEditorCode	OnMultiTouch (ViewContext ctx, MultiTouchEvent evt)
EnumEditorCode	OnBeginMultiTouch (ViewContext ctx, MultiTouchEvent evt)
EnumEditorCode	OnEndMultiTouch (ViewContext ctx, MultiTouchEvent evt)
EnumEditorCode	OnInput (ViewContext ctx, ParameterDict input)
boolean	IsEditing (ParameterDict input, String propName)
EnumEditorCode	OnAction (ViewContext ctx, String name, ParameterDict parameters)
EnumEditorCode	OnContextMenu (ViewContext ctx, InputEvent evt)
void	BeforeRendering (ViewContext ctx)
void	AfterRendering (ViewContext ctx)
void	OnDocumentChanged (ViewContext ctx, DocumentEventArgs args)
EnumEditorCode	OnSelectionChanged (ViewContext ctx)
void	NotifyParamsChanged (ViewContext ctx, String propertyName)
void	NotifyParamsChanged (ViewContext ctx)
ParameterDict	GetParams ()
int	GetEditStep ()
void	SetEditStep (int step)
void	ShowTooltip (String content)
boolean	SnapFilter (ViewContext ctx, PickedItem item)

详细描述

<> 基于鼠标、键盘、Touch等方式输入进行交互编辑的基类.

成员函数说明

Abort()

void Editor.Abort

(

ViewContext

ctx

)

显式放弃修改

参数

ctx

上下文

AfterRendering()

void Editor.AfterRendering

(

ViewContext

ctx

)

渲染后调用

参数

ctx

上下文

Apply()

boolean Editor.Apply

(

ViewContext

ctx

)

应用当前数据。调用Commit提交，并且调用Reset重新下一次的操作。

参数

ctx

上下文

返回

是否成功

被 DistanceMeasureEditor , 以及 NodeFrameEidtor 重载.

BeforeRendering()

void Editor.BeforeRendering

(

ViewContext

ctx

)

渲染前调用

参数

ctx

上下文

被 FrameEditor , 以及 StackEditor 重载.

Commit()

boolean Editor.Commit

(

ViewContext

ctx

)

提交修改

参数

ctx

上下文

返回

是否成功

Finish()

void Editor.Finish

(

ViewContext

ctx

)

结束

参数

ctx

上下文

被 FrameEditor , 以及 StackEditor 重载.

GetEditStep()

int Editor.GetEditStep

(

)

获取编辑步骤。步骤不等于Editor的Index

返回

步骤。一般定义为Enum

IsEditing()

boolean Editor.IsEditing	(	ParameterDict	input,
		String	propName )

判断OnInput当前输入更改的属性

参数

input
propName

返回

NotifyParamsChanged() [1/2]

void Editor.NotifyParamsChanged

(

ViewContext

ctx

)

通知参数发生变化

参数

ctx

上下文

NotifyParamsChanged() [2/2]

void Editor.NotifyParamsChanged	(	ViewContext	ctx,
		String	propertyName )

通知参数发生变化

参数

ctx	上下文
propertyName	变化的属性，可为空。

OnAction()

EnumEditorCode Editor.OnAction	(	ViewContext	ctx,
		String	name,
		ParameterDict	parameters )

执行动作

参数

ctx	上下文
name	名称
parameters	参数

返回

状态

OnBeginMultiTouch()

EnumEditorCode Editor.OnBeginMultiTouch	(	ViewContext	ctx,
		MultiTouchEvent	evt )

开始多点触摸

参数

ctx	上下文
evt	事件

返回

状态

OnContextMenu()

EnumEditorCode Editor.OnContextMenu	(	ViewContext	ctx,
		InputEvent	evt )

自定义右键菜单

参数

ctx	上下文
evt	事件

返回

状态

OnDocumentChanged()

void Editor.OnDocumentChanged	(	ViewContext	ctx,
		DocumentEventArgs	args )

文档发生变化

参数

ctx	上下文
args	参数

被 StackEditor 重载.

OnEndMultiTouch()

EnumEditorCode Editor.OnEndMultiTouch	(	ViewContext	ctx,
		MultiTouchEvent	evt )

结束多点触摸

参数

ctx	上下文
evt	事件

返回

状态

OnInput()

EnumEditorCode Editor.OnInput	(	ViewContext	ctx,
		ParameterDict	input )

应用输入参数，如输入框输入

参数

ctx	上下文
input	参数

返回

状态

被 FrameEditor , 以及 StackEditor 重载.

OnKeyDown()

EnumEditorCode Editor.OnKeyDown	(	ViewContext	ctx,
		InputEvent	evt )

键盘按下

参数

ctx	上下文
evt	事件

返回

状态

OnKeyUp()

EnumEditorCode Editor.OnKeyUp	(	ViewContext	ctx,
		InputEvent	evt )

键盘松开

参数

ctx	上下文
evt	事件

返回

状态

被 DistanceMeasureEditor, NodeFrameEidtor , 以及 StackEditor 重载.

OnMouseDown()

EnumEditorCode Editor.OnMouseDown	(	ViewContext	ctx,
		InputEvent	evt )

鼠标按下

参数

ctx	上下文
evt	事件

返回

状态

被 DistanceMeasureEditor, FrameEditor , 以及 StackEditor 重载.

OnMouseMove()

EnumEditorCode Editor.OnMouseMove	(	ViewContext	ctx,
		InputEvent	evt )

鼠标移动

参数

ctx	上下文
evt	事件

返回

状态

被 FrameEditor , 以及 StackEditor 重载.

OnMouseUp()

EnumEditorCode Editor.OnMouseUp	(	ViewContext	ctx,
		InputEvent	evt )

鼠标松开

参数

ctx	上下文
evt	事件

返回

状态

被 FrameEditor , 以及 StackEditor 重载.

OnMouseWheel()

EnumEditorCode Editor.OnMouseWheel	(	ViewContext	ctx,
		InputEvent	evt,
		int	delta )

鼠标中键滚动

参数

ctx	上下文
evt	事件
delta	变化量

返回

状态

OnMultiTouch()

EnumEditorCode Editor.OnMultiTouch	(	ViewContext	ctx,
		MultiTouchEvent	evt )

多点触摸

参数

ctx	上下文
evt	事件

返回

状态

OnSelectionChanged()

EnumEditorCode Editor.OnSelectionChanged

(

ViewContext

ctx

)

选择集发生变化

参数

ctx

上下文

被 StackEditor 重载.

Preview() [1/2]

boolean Editor.Preview

(

ViewContext

ctx

)

预览修改

参数

ctx

上下文

返回

是否成功

Preview() [2/2]

boolean Editor.Preview	(	ViewContext	ctx,
		boolean	on )

预览修改

参数

ctx	上下文
on	开启/关闭

返回

是否成功

被 NodeFrameEidtor 重载.

Reset()

void Editor.Reset

(

ViewContext

ctx

)

重置，一般会重新创建对象

参数

ctx

上下文

SetEditStep()

void Editor.SetEditStep

(

int

step

)

设置编辑步骤。

参数

step	步骤。一般定义为Enum

SetName()

void Editor.SetName

(

String

name

)

设置名称

ShowTooltip()

void Editor.ShowTooltip

(

String

content

)

通知显示提示信息

参数

content

内容

SnapFilter()

boolean Editor.SnapFilter	(	ViewContext	ctx,
		PickedItem	item )

设置snap的过滤条件

参数

ctx	上下文
item	选择对象

返回

Start()

EnumEditorCode Editor.Start

(

ViewContext

ctx

)

开始。子类优先继承OnStart方法。

参数

ctx

上下文

返回

状态

被 NodeFrameEidtor , 以及 StackEditor 重载.