Serenity Guide

Previous Page Next Page

@serenity-is/corelib / MultipleFileUploadEditor

Class: MultipleFileUploadEditor<P>

Defined in: src/ui/editors/uploadeditors.tsx:275

Extends

EditorWidget<P>

Extended by

MultipleImageUploadEditor

Type Parameters

P

P extends MultipleFileUploadEditorOptions = MultipleFileUploadEditorOptions

Implements

Constructors

Constructor

new MultipleFileUploadEditor<P>(props): MultipleFileUploadEditor<P>

Defined in: src/ui/editors/uploadeditors.tsx:286

Parameters

props

EditorProps<P>

Returns

MultipleFileUploadEditor<P>

Overrides

EditorWidget.constructor

Properties

domNode

readonly domNode: HTMLElement

Defined in: src/ui/widgets/widget.ts:14

Inherited from

EditorWidget.domNode

hiddenInput

protected hiddenInput: HTMLInputElement

Defined in: src/ui/editors/uploadeditors.tsx:284

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

EditorWidget.idPrefix

options

protected readonly options: WidgetProps<EditorProps<P>>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

EditorWidget.options

progress

protected progress: HTMLElement

Defined in: src/ui/editors/uploadeditors.tsx:283

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

EditorWidget.uniqueName

[typeInfo]

static [typeInfo]: EditorTypeInfo<"Serenity.">

Defined in: src/ui/editors/uploadeditors.tsx:277

Implementation of

IValidateRequired.[typeInfo]

Overrides

EditorWidget.[typeInfo]

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

EditorWidget.isComponent

Accessors

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Inherited from

EditorWidget.element

jsonEncodeValue

Get Signature

get jsonEncodeValue(): boolean

Defined in: src/ui/editors/uploadeditors.tsx:459

Returns

boolean

Set Signature

set jsonEncodeValue(value): void

Defined in: src/ui/editors/uploadeditors.tsx:460

Parameters

value

boolean

Returns

void

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

EditorWidget.props

readOnly

Get Signature

get readOnly(): boolean

Defined in: src/ui/editors/editorwidget.ts:20

Returns

boolean

Set Signature

set readOnly(value): void

Defined in: src/ui/editors/editorwidget.ts:25

Parameters

value

boolean

Returns

void

Inherited from

EditorWidget.readOnly

value

Get Signature

get value(): UploadedFile[]

Defined in: src/ui/editors/uploadeditors.tsx:415

Returns

UploadedFile[]

Set Signature

set value(v): void

Defined in: src/ui/editors/uploadeditors.tsx:427

Parameters

v

UploadedFile[]

Returns

void

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

EditorWidget.addCssClass

addFileButtonText()

protected addFileButtonText(): string

Defined in: src/ui/editors/uploadeditors.tsx:336

Returns

string

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

EditorWidget.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

EditorWidget.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

EditorWidget.afterRender

byId()

protected byId<TElement>(id): Fluent<TElement>

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

EditorWidget.byId

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

EditorWidget.deferRender

destroy()

destroy(): void

Defined in: src/ui/widgets/widget.ts:42

Returns

void

Inherited from

EditorWidget.destroy

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

EditorWidget.findById

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/uploadeditors.tsx:375

Returns

boolean

Implementation of

IReadOnly.get_readOnly

get_required()

get_required(): boolean

Defined in: src/ui/editors/uploadeditors.tsx:401

Returns

boolean

Implementation of

IValidateRequired.get_required

get_value()

get_value(): UploadedFile[]

Defined in: src/ui/editors/uploadeditors.tsx:409

Returns

UploadedFile[]

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

EditorWidget.getCssClass

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

EditorWidget.getCustomAttribute

getEditValue()

getEditValue(property, target): void

Defined in: src/ui/editors/uploadeditors.tsx:431

Parameters

property

target

any

Returns

void

Implementation of

IGetEditValue.getEditValue

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Inherited from

EditorWidget.getGridField

getToolButtons()

protected getToolButtons(): ToolButton[]

Defined in: src/ui/editors/uploadeditors.tsx:340

Returns

getUploadInputOptions()

protected getUploadInputOptions(): UploadInputOptions

Defined in: src/ui/editors/uploadeditors.tsx:310

Returns

UploadInputOptions

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

EditorWidget.init

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

EditorWidget.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

EditorWidget.legacyTemplateRender

populate()

protected populate(): void

Defined in: src/ui/editors/uploadeditors.tsx:350

Returns

void

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

EditorWidget.render

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

EditorWidget.renderContents

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/uploadeditors.tsx:379

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

set_required()

set_required(value): void

Defined in: src/ui/editors/uploadeditors.tsx:405

Parameters

value

boolean

Returns

void

Implementation of

IValidateRequired.set_required

set_value()

set_value(value): void

Defined in: src/ui/editors/uploadeditors.tsx:419

Parameters

value

UploadedFile[]

Returns

void

setEditValue()

setEditValue(source, property): void

Defined in: src/ui/editors/uploadeditors.tsx:440

Parameters

source

any

property

Returns

void

Implementation of

ISetEditValue.setEditValue

syncOrAsyncThen()

protected syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

EditorWidget.syncOrAsyncThen

updateInterface()

protected updateInterface(): void

Defined in: src/ui/editors/uploadeditors.tsx:369

Returns

void

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

Inherited from

EditorWidget.useIdPrefix

create()

static create<TWidget, P>(params): TWidget

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

EditorWidget.create

createDefaultElement()

static createDefaultElement(): HTMLElement

Defined in: src/ui/widgets/widget.ts:52

Returns

HTMLElement

Inherited from

EditorWidget.createDefaultElement

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

EditorWidget.getWidgetName

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

Inherited from

EditorWidget.registerClass

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

EditorWidget.registerEditor

Previous Page Next Page