Frame / SView / Commands / BaseViewCommand

Class: BaseViewCommand

SView.Commands.BaseViewCommand

Memberof

SView.Commands

Description

设置基本视图命令

Author

nihy

Date

2022-08-10 14:21:47

Version

1.0

Copyright

All Rights Reserved.Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• SCommand

  ↳ BaseViewCommand

Table of contents

Constructors

• constructor

Properties

• description
• executedHandleMode
• frame
• inputParas
• isCanAbort
• isDisplayView
• isInterruptible
• isParametersComplete
• isPreView
• isShowLoadingDialog
• name
• outputParas
• priority
• scene
• state
• type
• view
• baseViewType

Methods

• apply
• cancel
• clear
• close
• doPreview
• execute
• existValidParameters
• getConfigData
• getDescription
• getExecutedHandleMode
• getInputParas
• getIsCanAbort
• getIsDisplayView
• getIsInterruptible
• getIsParametersComplete
• getIsPreView
• getIsShowLoadingDialog
• getName
• getOutputParas
• getPriority
• getScene
• getState
• getView
• interrupt
• isShowView
• onClearPreview
• onExecuted
• preview
• release
• resume
• setExecutedHandleMode
• setInputParas
• setIsCanAbort
• setIsDisplayView
• setIsInterruptible
• setIsParametersComplete
• setIsPreView
• setIsShowLoadingDialog
• setName
• setOutputParas
• setPriority
• setScene
• setState
• setView
• touchHandle
• undo

Constructors

constructor

• new BaseViewCommand(frame, viewType): BaseViewCommand

Parameters

Name	Type
frame	any
viewType	BaseViewType

Returns

BaseViewCommand

Description

构造函数

Overrides

SCommand.constructor

Properties

description

• description: string

Inherited from

SCommand.description

---

executedHandleMode

• executedHandleMode: ExecutedHandleMode

Inherited from

SCommand.executedHandleMode

---

frame

• frame: FrameMain

Inherited from

SCommand.frame

---

inputParas

• inputParas: CommandParameters

Inherited from

SCommand.inputParas

---

isCanAbort

• isCanAbort: boolean

Inherited from

SCommand.isCanAbort

---

isDisplayView

• isDisplayView: boolean

Inherited from

SCommand.isDisplayView

---

isInterruptible

• isInterruptible: boolean

Inherited from

SCommand.isInterruptible

---

isParametersComplete

• isParametersComplete: boolean

Inherited from

SCommand.isParametersComplete

---

isPreView

• isPreView: boolean

Inherited from

SCommand.isPreView

---

isShowLoadingDialog

• isShowLoadingDialog: boolean

Inherited from

SCommand.isShowLoadingDialog

---

name

• name: string

Inherited from

SCommand.name

---

outputParas

• outputParas: CommandParameters

Inherited from

SCommand.outputParas

---

priority

• priority: CommandPriority

Inherited from

SCommand.priority

---

scene

• scene: Scene

Inherited from

SCommand.scene

---

state

• state: CommandState

Inherited from

SCommand.state

---

type

• type: number

Inherited from

SCommand.type

---

view

• view: SCommandView

Inherited from

SCommand.view

---

baseViewType

▪ Static Readonly baseViewType: string = "BaseViewType"

Methods

apply

▸ apply(): number

Returns

number

Description

应用

Inherited from

SCommand.apply

---

cancel

▸ cancel(): void

Returns

void

Description

取消

Memberof

SCommand

Inherited from

SCommand.cancel

---

clear

▸ clear(): number

Returns

number

Description

清空

Inherited from

SCommand.clear

---

close

▸ close(): void

Returns

void

Description

关闭

Inherited from

SCommand.close

---

doPreview

▸ doPreview(): number

Returns

number

Description

执行预览

Inherited from

SCommand.doPreview

---

execute

▸ execute(executeAll?): number

Parameters

Name	Type
executeAll?	boolean

Returns

number

Description

执行

Inherited from

SCommand.execute

---

existValidParameters

▸ existValidParameters(): boolean

Returns

boolean

Description

是否存在有效参数

Inherited from

SCommand.existValidParameters

---

getConfigData

▸ getConfigData(): number

Returns

number

Description

获取配置中的命令信息

Inherited from

SCommand.getConfigData

---

getDescription

▸ getDescription(): string

Returns

string

Description

获取命令描述

Inherited from

SCommand.getDescription

---

getExecutedHandleMode

▸ getExecutedHandleMode(): ExecutedHandleMode

Returns

ExecutedHandleMode

Description

获取执行模式

Inherited from

SCommand.getExecutedHandleMode

---

getInputParas

▸ getInputParas(): CommandParameters

Returns

CommandParameters

Description

获取参数

Overrides

SCommand.getInputParas

---

getIsCanAbort

▸ getIsCanAbort(): boolean

Returns

boolean

Description

是否可以中止

Inherited from

SCommand.getIsCanAbort

---

getIsDisplayView

▸ getIsDisplayView(): boolean

Returns

boolean

Description

是否显示View

Inherited from

SCommand.getIsDisplayView

---

getIsInterruptible

▸ getIsInterruptible(): boolean

Returns

boolean

Description

获取是否可被中断

Inherited from

SCommand.getIsInterruptible

---

getIsParametersComplete

▸ getIsParametersComplete(): boolean

Returns

boolean

Description

获取参数是否完成准备

Overrides

SCommand.getIsParametersComplete

---

getIsPreView

▸ getIsPreView(): boolean

Returns

boolean

Description

获取命令是否预显

Inherited from

SCommand.getIsPreView

---

getIsShowLoadingDialog

▸ getIsShowLoadingDialog(): boolean

Returns

boolean

Description

是否显示加载对话框

Inherited from

SCommand.getIsShowLoadingDialog

---

getName

▸ getName(): string

Returns

string

Description

获取命令名称

Inherited from

SCommand.getName

---

getOutputParas

▸ getOutputParas(): CommandParameters

Returns

CommandParameters

Description

获取输出参数

Inherited from

SCommand.getOutputParas

---

getPriority

▸ getPriority(): CommandPriority

Returns

CommandPriority

Description

获取命令优先级

Inherited from

SCommand.getPriority

---

getScene

▸ getScene(): Scene

Returns

Scene

Description

获取scene

Inherited from

SCommand.getScene

---

getState

▸ getState(): CommandState

Returns

CommandState

Description

获取命令状态

Inherited from

SCommand.getState

---

getView

▸ getView(): SCommandView

Returns

SCommandView

Description

获取view

Inherited from

SCommand.getView

---

interrupt

▸ interrupt(): CommandExecuteResult

Returns

CommandExecuteResult

Description

中断当前命令

Inherited from

SCommand.interrupt

---

isShowView

▸ isShowView(): boolean

Returns

boolean

Description

判断是否需要显示面板

Inherited from

SCommand.isShowView

---

onClearPreview

▸ onClearPreview(): void

Returns

void

Description

清空预览

Inherited from

SCommand.onClearPreview

---

onExecuted

▸ onExecuted(): number

Returns

number

Description

业务逻辑执行完毕后

Inherited from

SCommand.onExecuted

---

preview

▸ preview(): number

Returns

number

Description

预览

Inherited from

SCommand.preview

---

release

▸ release(): boolean

Returns

boolean

Description

释放

Inherited from

SCommand.release

---

resume

▸ resume(): number

Returns

number

Description

恢复命名

Inherited from

SCommand.resume

---

setExecutedHandleMode

▸ setExecutedHandleMode(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置执行模式

Inherited from

SCommand.setExecutedHandleMode

---

setInputParas

▸ setInputParas(value): void

Parameters

Name	Type
value	CommandParameters

Returns

void

Description

设置输入参数

Inherited from

SCommand.setInputParas

---

setIsCanAbort

▸ setIsCanAbort(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否可以中止

Inherited from

SCommand.setIsCanAbort

---

setIsDisplayView

▸ setIsDisplayView(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否显示View

Inherited from

SCommand.setIsDisplayView

---

setIsInterruptible

▸ setIsInterruptible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否可被中断

Inherited from

SCommand.setIsInterruptible

---

setIsParametersComplete

▸ setIsParametersComplete(value): void

Parameters

Name	Type
value	any

Returns

void

Description

参数是否完整

Inherited from

SCommand.setIsParametersComplete

---

setIsPreView

▸ setIsPreView(value): void

@description: 设置命令是否预显

Parameters

Name	Type	Description
value	boolean	：0不预显，1预显

Returns

void

Inherited from

SCommand.setIsPreView

---

setIsShowLoadingDialog

▸ setIsShowLoadingDialog(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置是否显示加载对话框

Inherited from

SCommand.setIsShowLoadingDialog

---

setName

▸ setName(value): void

Parameters

Name	Type
value	string

Returns

void

Description

设置命令名称

Inherited from

SCommand.setName

---

setOutputParas

▸ setOutputParas(value): void

Parameters

Name	Type
value	CommandParameters

Returns

void

Description

设置输出参数

Inherited from

SCommand.setOutputParas

---

setPriority

▸ setPriority(value): void

Parameters

Name	Type
value	any

Returns

void

Description

设置命令优先级

Inherited from

SCommand.setPriority

---

setScene

▸ setScene(value): void

Parameters

Name	Type
value	Scene

Returns

void

Description

设置scene

Inherited from

SCommand.setScene

---

setState

▸ setState(state): void

Parameters

Name	Type
state	CommandState

Returns

void

Description

设置命令状态

Inherited from

SCommand.setState

---

setView

▸ setView(value): void

Parameters

Name	Type
value	SCommandView

Returns

void

Description

设置view

Inherited from

SCommand.setView

---

touchHandle

▸ touchHandle(event): boolean

Parameters

Name	Type
event	MouseEventArgs | KeyEventArgs | TouchEventArgs

Returns

boolean

Description

处理触摸事件

Inherited from

SCommand.touchHandle

---

undo

▸ undo(): boolean

Returns

boolean

Description

回退

Inherited from

SCommand.undo