Form | kdayun 界面引擎API

弹窗类

可以实现: 信息框页面层 iframe层加载层 tips层

Hierarchy

Form

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Form(): Form

Returns Form

Properties

Static btn

btn: string[] = ...

Static cache

cache: { extend?: any; theme?: any } = ...

Type declaration

Optional extend?: any
Optional theme?: any

Static config

config: IFormConfig = ...

Static forms

forms: FormInstance[] = ...

Static html

html: JQuery<HTMLElement>

Static index

index: number = 9999999

Static moveElem

moveElem: JQuery<HTMLElement>

Static setTop

setTop: ($elem: JQuery<HTMLElement>) => any

Type declaration

- ($elem: JQuery<HTMLElement>): any
- Parameters
  - $elem: JQuery<HTMLElement>
  Returns any

Static v

v: string = '1.0'

Static win

win: JQuery<Window>

Static zIndex

zIndex: number

Methods

Static alert

alert(content: string, options: FormHandle | IFormConfirmOptions, yes: FormHandle): number

- Defined in YH-Designer/src/base/Form.ts:793
弹出警告窗
```
Form.alert("您好!")
```
Parameters
- content: string
  
  内容
- options: FormHandle | IFormConfirmOptions
  
  设置项,可以设置弹出窗的配置项
- yes: FormHandle
  
  按确定时候的回调函数
Returns number

返回弹出层的唯一id

Static close

close(index: number, force?: boolean): boolean

- Defined in YH-Designer/src/base/Form.ts:1058
关闭

Parameters
- index: number
  
  弹出层的唯一id
- force: boolean = false
  
  强行关闭,不考虑canClose事件
Returns boolean

返回false关闭失败,其他都成功

Static closeAll

closeAll(type: FormType): void

- Defined in YH-Designer/src/base/Form.ts:1077
关闭所有层

Parameters
- type: FormType
Returns void

Static confirm

confirm(content: string, options?: IFormConfirmOptions, yes?: FormHandle, cancel?: FormHandle): number

- Defined in YH-Designer/src/base/Form.ts:850
弹出询问

```typescript Form.msg("您好!", { time: 30000 }, function(index?: number, $elem?: JQuery){

}, function(index?: number, $elem?: JQuery){

} ) ```

Parameters
- content: string
  
  询问内容
- Optional options: IFormConfirmOptions
  
  配置项
- Optional yes: FormHandle
  
  点击确定后触发
- Optional cancel: FormHandle
  
  点击取消触发
Returns number

返回弹出层的唯一id

Static full

full(index: number): void

- Defined in YH-Designer/src/base/Form.ts:1067
全屏

Parameters
- index: number
  
  弹出层的唯一id
Returns void

Static getChildFrame

getChildFrame(selector: any, index: any): JQuery<HTMLElement | Document | Text | Comment>

- Defined in YH-Designer/src/base/Form.ts:998
获取子iframe的DOM

Parameters
- selector: any
  
  jquery的选择字符串 'html','div','.classname' 等等与jquery 的元素选择字符串相同
- index: any
  
  弹出层的唯一id
Returns JQuery<HTMLElement | Document | Text | Comment>

返回iframe的DOM

Static getFrameIndex

getFrameIndex(name: string): string

- Defined in YH-Designer/src/base/Form.ts:1007
得到当前iframe层的索引，子iframe时使用

Parameters
- name: string
Returns string

Static getPath

getPath(): string

- Defined in YH-Designer/src/base/Form.ts:707
Returns string

Private Static getStyle

getStyle(node: any, name: any): string

- Defined in YH-Designer/src/base/Form.ts:723
Parameters
- node: any
- name: any
Returns string

Static iframeAuto

iframeAuto(index: number): void

- Defined in YH-Designer/src/base/Form.ts:1015
iframe层自适应宽高

Parameters
- index: number
  
  弹出窗口唯一id
Returns void

Static iframeSrc

iframeSrc(index: number, url: string): void

- Defined in YH-Designer/src/base/Form.ts:1025
重置iframe url

Parameters
- index: number
  
  弹出窗口唯一id
- url: string
  
  重设的http路径
Returns void

Static init

init(): void

- Defined in YH-Designer/src/base/Form.ts:702
Returns void

Private Static link

link(href: string, fn?: Function, cssname?: string): void

- Defined in YH-Designer/src/base/Form.ts:739
Parameters
- href: string
- Optional fn: Function
- Optional cssname: string
Returns void

Static load

load(icon?: FormIcon, options?: IFormLoadOptions): number

- Defined in YH-Designer/src/base/Form.ts:951
弹出正在加载层
```
Form.load(0,  { time: 30000 })
```
Parameters
- Optional icon: FormIcon
  
  主题图标
- Optional options: IFormLoadOptions
  
  弹出层的配置项
Returns number

返回弹出层的唯一id

Static min

min(index: number): void

- Defined in YH-Designer/src/base/Form.ts:1035
最小化

Parameters
- index: number
  
  弹出层的唯一id
Returns void

Static msg

msg(content: string, options?: IFormMsgOptions, end?: () => void): number

- Defined in YH-Designer/src/base/Form.ts:913
弹出消息层
```
Form.msg("您好!",  { time: 30000 })
```
Parameters
- content: string
  
  提示信息
- Optional options: IFormMsgOptions
  
  配置项
- Optional end: () => void
  
  结束的回调
  - - (): void
    - Returns void
Returns number

返回弹出层的唯一id

Static notice

notice(content: string, options?: IFormMsgOptions, end?: () => void): number

- Defined in YH-Designer/src/base/Form.ts:875
弹出通知层
```
Form.notice("您好!",  { time: 30000 })
```
Parameters
- content: string
  
  提示信息
- Optional options: IFormMsgOptions
  
  配置项
- Optional end: () => void
  
  结束的回调
  - - (): void
    - Returns void
Returns number

返回弹出层的唯一id

Static open

open(options: IFormOptions): number

开启弹窗

Form.Form({
type: FormType.page
, id: 'id'
, title: '组件树(可拖拽修改组件位置)'
, shade: 0
, area: ['300px', '500px']
, content: that.getEditorHtml()
, onSuccess: (index, $elem) => {
}
, onYes(index, $elem) {
}
, restore: (index, $elem) => { }
})

Parameters

options: IFormOptions

配置项

Returns number

返回弹出层的唯一id

Static photos

photos(options: IFormPhotoOptions, loop: boolean, key?: any): number

- Defined in YH-Designer/src/base/Form.ts:1262
展示相册例子:
1. 从json来显示图片
```
layer.photos({
photos: {
"title": "", //相册标题
"id": 123, //相册id
"start": 0, //初始显示的图片序号，默认0
"data": [   //相册包含的图片，数组格式
{
"alt": "图片名",
"pid": 666, //图片id
"src": "", //原图地址
"thumb": "" //缩略图地址
}
]
}
,anim: 5 //0-6的选择，指定弹出图片动画类型，默认随机（请注意，3.0之前的版本用shift参数）
});
```
2. 如果是直接从页面中获取图片，那么需要指向图片的父容器，并且你的img可以设定一些规定的属性 ```html
Parameters
- options: IFormPhotoOptions
  
  配置项
- loop: boolean
  
  循环
- Optional key: any
  
  唯一值
Returns number

返回弹出层的唯一id

Static prompt

prompt(options: IFormPromptOptions, yes: (value: any, index: number, $inputElem: JQuery<HTMLElement>) => void): number

- Defined in YH-Designer/src/base/Form.ts:1120
prompt弹出框

Parameters
- options: IFormPromptOptions
  
  弹出框选项
- yes: (value: any, index: number, $inputElem: JQuery<HTMLElement>) => void
  
  点击确定回调
  - - (value: any, index: number, $inputElem: JQuery<HTMLElement>): void
    - Parameters
      - value: any
      - index: number
      - $inputElem: JQuery<HTMLElement>
      Returns void
Returns number

返回弹出层的唯一id

Static px

px(val: string, suffix?: string, def?: any): any

- Defined in YH-Designer/src/base/Form.ts:1092
处理后缀的问题

Parameters
- val: string
  
  值
- suffix: string = 'px'
  
  可选参数后缀
- def: any = null
Returns any

Private Static ready

ready(callback?: any): typeof Form

- Defined in YH-Designer/src/base/Form.ts:732
主体CSS等待事件

Parameters
- Optional callback: any
Returns typeof Form

Static setConfig

setConfig(options: IFormConfirmOptions): typeof Form

- Defined in YH-Designer/src/base/Form.ts:766
配置

Parameters
- options: IFormConfirmOptions
Returns typeof Form

Static tab

tab(options: IFormTabOptions): number

- Defined in YH-Designer/src/base/Form.ts:1169
tab层

Parameters
- options: IFormTabOptions
  
  配置项
Returns number

返回弹出层的唯一id

Static theme

theme(type: string): string

- Defined in YH-Designer/src/base/Form.ts:779
主题

Parameters
- type: string
Returns string

Static tips

tips(content: string, $follow: JQuery<HTMLElement>, options: IFormTipsOptions): number

- Defined in YH-Designer/src/base/Form.ts:973
吸附在组周围的tips
```
Form.tips("hello", btn.getElemt(), { tips: {color:"red", direct: "down" } })
```
Parameters
- content: string
  
  提示信息
- $follow: JQuery<HTMLElement>
  
  吸附的html的id 如: "#id" 或者 jquery对象
- options: IFormTipsOptions
  
  弹出层的配置项
Returns number

返回弹出层的唯一id

Static title

title(newTitle: string, index: number): void

- Defined in YH-Designer/src/base/Form.ts:1047
改变title

Parameters
- newTitle: string
  
  修改抬头的名称
- index: number
  
  弹出层的唯一id
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Form

Properties

Static btn

Static cache

Type declaration

Optional extend?: any

Optional theme?: any

Static config

Static forms

Static html

Static index

Static moveElem

Static setTop

Type declaration

Parameters

$elem: JQuery<HTMLElement>

Returns any

Static v

Static win

Static zIndex

Methods

Static alert

Parameters

content: string

options: FormHandle | IFormConfirmOptions

yes: FormHandle

Returns number

Static close

Parameters

index: number

force: boolean = false

Returns boolean

Static closeAll

Parameters

type: FormType

Returns void

Static confirm

Parameters

content: string

Optional options: IFormConfirmOptions

Optional yes: FormHandle

Optional cancel: FormHandle

Returns number

Static full

Parameters

index: number

Returns void

Static getChildFrame

Parameters

selector: any

index: any

Returns JQuery<HTMLElement | Document | Text | Comment>

Static getFrameIndex

Parameters

name: string

Returns string

Static getPath

Returns string

Private Static getStyle

Parameters

node: any

name: any

Returns string

Static iframeAuto

Parameters

index: number

Returns void

Static iframeSrc

Parameters

index: number

url: string

Returns void

Static init