MultipleImageUploadEditor.md

@serenity-is/corelib / MultipleImageUploadEditor

Class: MultipleImageUploadEditor<P>

Extends

• MultipleFileUploadEditor<P>

Type Parameters

• P extends ImageUploadEditorOptions = ImageUploadEditorOptions

Constructors

new MultipleImageUploadEditor()

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

Parameters

props

EditorProps<P>

Returns

MultipleImageUploadEditor<P>

Overrides

MultipleFileUploadEditor.constructor

Defined in

src/ui/editors/uploadeditors.tsx:465

Properties

domNode

readonly domNode: HTMLElement

Inherited from

MultipleFileUploadEditor.domNode

Defined in

src/ui/widgets/widget.ts:17

---

hiddenInput

protected hiddenInput: HTMLInputElement

Inherited from

MultipleFileUploadEditor.hiddenInput

Defined in

src/ui/editors/uploadeditors.tsx:284

---

idPrefix

readonly idPrefix: string

Inherited from

MultipleFileUploadEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

MultipleFileUploadEditor.options

Defined in

src/ui/widgets/widget.ts:14

---

progress

protected progress: HTMLElement

Inherited from

MultipleFileUploadEditor.progress

Defined in

src/ui/editors/uploadeditors.tsx:283

---

uniqueName

readonly uniqueName: string

Inherited from

MultipleFileUploadEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

isComponent

readonly static isComponent: true = true

Inherited from

MultipleFileUploadEditor.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

MultipleFileUploadEditor.typeInfo

Defined in

src/ui/editors/editorwidget.ts:17

Accessors

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.element

Defined in

src/ui/widgets/widget.ts:63

---

jsonEncodeValue

Get Signature

get jsonEncodeValue(): boolean

Returns

boolean

Set Signature

set jsonEncodeValue(value): void

Parameters

value

boolean

Returns

void

Inherited from

MultipleFileUploadEditor.jsonEncodeValue

Defined in

src/ui/editors/uploadeditors.tsx:459

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

MultipleFileUploadEditor.props

Defined in

src/ui/widgets/widget.ts:207

---

readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

MultipleFileUploadEditor.readOnly

Defined in

src/ui/editors/editorwidget.ts:23

---

value

Get Signature

get value(): UploadedFile[]

Returns

UploadedFile[]

Set Signature

set value(v): void

Parameters

v

UploadedFile[]

Returns

void

Inherited from

MultipleFileUploadEditor.value

Defined in

src/ui/editors/uploadeditors.tsx:415

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

MultipleFileUploadEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:67

---

addFileButtonText()

protected addFileButtonText(): string

Returns

string

Inherited from

MultipleFileUploadEditor.addFileButtonText

Defined in

src/ui/editors/uploadeditors.tsx:336

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

MultipleFileUploadEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

MultipleFileUploadEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

MultipleFileUploadEditor.afterRender

Defined in

src/ui/widgets/widget.ts:146

---

byId()

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

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

MultipleFileUploadEditor.byId

Defined in

src/ui/widgets/widget.ts:106

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

MultipleFileUploadEditor.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

MultipleFileUploadEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Inherited from

MultipleFileUploadEditor.destroy

Defined in

src/ui/widgets/widget.ts:47

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

MultipleFileUploadEditor.findById

Defined in

src/ui/widgets/widget.ts:110

---

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.get_readOnly

Defined in

src/ui/editors/uploadeditors.tsx:375

---

get_required()

get_required(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.get_required

Defined in

src/ui/editors/uploadeditors.tsx:401

---

get_value()

get_value(): UploadedFile[]

Returns

UploadedFile[]

Inherited from

MultipleFileUploadEditor.get_value

Defined in

src/ui/editors/uploadeditors.tsx:409

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

MultipleFileUploadEditor.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute()

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

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

MultipleFileUploadEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getEditValue()

getEditValue(property, target): void

Parameters

property

PropertyItem

target

any

Returns

void

Inherited from

MultipleFileUploadEditor.getEditValue

Defined in

src/ui/editors/uploadeditors.tsx:431

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getToolButtons()

protected getToolButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

MultipleFileUploadEditor.getToolButtons

Defined in

src/ui/editors/uploadeditors.tsx:340

---

getUploadInputOptions()

protected getUploadInputOptions(): UploadInputOptions

Returns

UploadInputOptions

Inherited from

MultipleFileUploadEditor.getUploadInputOptions

Defined in

src/ui/editors/uploadeditors.tsx:310

---

init()

init(): this

Returns

this

Inherited from

MultipleFileUploadEditor.init

Defined in

src/ui/widgets/widget.ts:157

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

MultipleFileUploadEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

populate()

protected populate(): void

Returns

void

Inherited from

MultipleFileUploadEditor.populate

Defined in

src/ui/editors/uploadeditors.tsx:350

---

render()

render(): any

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

MultipleFileUploadEditor.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

MultipleFileUploadEditor.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

MultipleFileUploadEditor.set_readOnly

Defined in

src/ui/editors/uploadeditors.tsx:379

---

set_required()

set_required(value): void

Parameters

value

boolean

Returns

void

Inherited from

MultipleFileUploadEditor.set_required

Defined in

src/ui/editors/uploadeditors.tsx:405

---

set_value()

set_value(value): void

Parameters

value

UploadedFile[]

Returns

void

Inherited from

MultipleFileUploadEditor.set_value

Defined in

src/ui/editors/uploadeditors.tsx:419

---

setEditValue()

setEditValue(source, property): void

Parameters

source

any

property

PropertyItem

Returns

void

Inherited from

MultipleFileUploadEditor.setEditValue

Defined in

src/ui/editors/uploadeditors.tsx:440

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

MultipleFileUploadEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

updateInterface()

protected updateInterface(): void

Returns

void

Inherited from

MultipleFileUploadEditor.updateInterface

Defined in

src/ui/editors/uploadeditors.tsx:369

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

MultipleFileUploadEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

---

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

MultipleFileUploadEditor.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

MultipleFileUploadEditor.createDefaultElement

Defined in

src/ui/widgets/widget.ts:56

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

MultipleFileUploadEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95