@serenity-is/corelib / MultipleImageUploadEditor

Class: MultipleImageUploadEditor<P>

Type parameters

Name	Type
P	extends ImageUploadEditorOptions = ImageUploadEditorOptions

Hierarchy

• MultipleFileUploadEditor<P>

  ↳ MultipleImageUploadEditor

Table of contents

Constructors

• constructor

Properties

• domNode
• hiddenInput
• idPrefix
• options
• progress
• uniqueName
• typeInfo

Accessors

• element
• jsonEncodeValue
• props
• value

Methods

• addCssClass
• addFileButtonText
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getCustomAttribute
• getEditValue
• getFieldElement
• getGridField
• getToolButtons
• getUploadInputOptions
• get_readOnly
• get_required
• get_value
• init
• internalInit
• internalRenderContents
• populate
• render
• renderContents
• setEditValue
• set_readOnly
• set_required
• set_value
• syncOrAsyncThen
• updateInterface
• useIdPrefix
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

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

Type parameters

Name	Type
P	extends ImageUploadEditorOptions = ImageUploadEditorOptions

Parameters

Name	Type
props	EditorProps<P>

Returns

MultipleImageUploadEditor<P>

Overrides

MultipleFileUploadEditor.constructor

Defined in

src/ui/editors/uploadeditors.ts:479

Properties

domNode

• Readonly domNode: HTMLElement

Inherited from

MultipleFileUploadEditor.domNode

Defined in

src/ui/widgets/widget.ts:18

---

hiddenInput

• Protected hiddenInput: Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.hiddenInput

Defined in

src/ui/editors/uploadeditors.ts:290

---

idPrefix

• Readonly idPrefix: string

Inherited from

MultipleFileUploadEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<EditorProps<P>>

Inherited from

MultipleFileUploadEditor.options

Defined in

src/ui/widgets/widget.ts:15

---

progress

• Protected progress: Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.progress

Defined in

src/ui/editors/uploadeditors.ts:289

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

MultipleFileUploadEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

MultipleFileUploadEditor.typeInfo

Defined in

src/ui/widgets/widget.ts:202

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.element

Defined in

src/ui/widgets/widget.ts:67

---

jsonEncodeValue

• get jsonEncodeValue(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.jsonEncodeValue

Defined in

src/ui/editors/uploadeditors.ts:473

• set jsonEncodeValue(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

MultipleFileUploadEditor.jsonEncodeValue

Defined in

src/ui/editors/uploadeditors.ts:474

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

MultipleFileUploadEditor.props

Defined in

src/ui/widgets/widget.ts:182

---

value

• get value(): UploadedFile[]

Returns

UploadedFile[]

Inherited from

MultipleFileUploadEditor.value

Defined in

src/ui/editors/uploadeditors.ts:429

• set value(v): void

Parameters

Name	Type
v	UploadedFile[]

Returns

void

Inherited from

MultipleFileUploadEditor.value

Defined in

src/ui/editors/uploadeditors.ts:441

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

MultipleFileUploadEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addFileButtonText

▸ addFileButtonText(): string

Returns

string

Inherited from

MultipleFileUploadEditor.addFileButtonText

Defined in

src/ui/editors/uploadeditors.ts:350

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

MultipleFileUploadEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

MultipleFileUploadEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

MultipleFileUploadEditor.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

MultipleFileUploadEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Inherited from

MultipleFileUploadEditor.destroy

Defined in

src/ui/widgets/widget.ts:49

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

MultipleFileUploadEditor.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute

▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr

Type parameters

Name
TAttr

Parameters

Name	Type	Default value
attrType	(...args: any[]) => TAttr	undefined
inherit	boolean	true

Returns

TAttr

Inherited from

MultipleFileUploadEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getEditValue

▸ getEditValue(property, target): void

Parameters

Name	Type
property	PropertyItem
target	any

Returns

void

Inherited from

MultipleFileUploadEditor.getEditValue

Defined in

src/ui/editors/uploadeditors.ts:445

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

MultipleFileUploadEditor.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

MultipleFileUploadEditor.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getToolButtons

▸ getToolButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

MultipleFileUploadEditor.getToolButtons

Defined in

src/ui/editors/uploadeditors.ts:354

---

getUploadInputOptions

▸ getUploadInputOptions(): UploadInputOptions

Returns

UploadInputOptions

Inherited from

MultipleFileUploadEditor.getUploadInputOptions

Defined in

src/ui/editors/uploadeditors.ts:324

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.get_readOnly

Defined in

src/ui/editors/uploadeditors.ts:389

---

get_required

▸ get_required(): boolean

Returns

boolean

Inherited from

MultipleFileUploadEditor.get_required

Defined in

src/ui/editors/uploadeditors.ts:415

---

get_value

▸ get_value(): UploadedFile[]

Returns

UploadedFile[]

Inherited from

MultipleFileUploadEditor.get_value

Defined in

src/ui/editors/uploadeditors.ts:423

---

init

▸ init(): this

Returns

this

Inherited from

MultipleFileUploadEditor.init

Defined in

src/ui/widgets/widget.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

MultipleFileUploadEditor.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

MultipleFileUploadEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

populate

▸ populate(): void

Returns

void

Inherited from

MultipleFileUploadEditor.populate

Defined in

src/ui/editors/uploadeditors.ts:364

---

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:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

MultipleFileUploadEditor.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

setEditValue

▸ setEditValue(source, property): void

Parameters

Name	Type
source	any
property	PropertyItem

Returns

void

Inherited from

MultipleFileUploadEditor.setEditValue

Defined in

src/ui/editors/uploadeditors.ts:454

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

MultipleFileUploadEditor.set_readOnly

Defined in

src/ui/editors/uploadeditors.ts:393

---

set_required

▸ set_required(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

MultipleFileUploadEditor.set_required

Defined in

src/ui/editors/uploadeditors.ts:419

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	UploadedFile[]

Returns

void

Inherited from

MultipleFileUploadEditor.set_value

Defined in

src/ui/editors/uploadeditors.ts:433

---

syncOrAsyncThen

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

Type parameters

Name
T

Parameters

Name	Type
syncMethod	() => T
asyncMethod	() => PromiseLike<T>
then	(v: T) => void

Returns

void

Inherited from

MultipleFileUploadEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

updateInterface

▸ updateInterface(): void

Returns

void

Inherited from

MultipleFileUploadEditor.updateInterface

Defined in

src/ui/editors/uploadeditors.ts:383

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

MultipleFileUploadEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

create

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

Type parameters

Name	Type
TWidget	extends Widget<P>
P	P

Parameters

Name	Type
params	CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

MultipleFileUploadEditor.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

MultipleFileUploadEditor.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

MultipleFileUploadEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95