FileUploadEditor.md

@serenity-is/corelib / FileUploadEditor

Class: FileUploadEditor<P>

Extends

• EditorWidget<P>

Extended by

• ImageUploadEditor

Type Parameters

• P extends FileUploadEditorOptions = FileUploadEditorOptions

Implements

• IReadOnly
• IGetEditValue
• ISetEditValue
• IValidateRequired

Constructors

new FileUploadEditor()

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

Parameters

props

EditorProps<P>

Returns

FileUploadEditor<P>

Overrides

EditorWidget.constructor

Defined in

src/ui/editors/uploadeditors.tsx:23

Properties

domNode

readonly domNode: HTMLElement

Inherited from

EditorWidget.domNode

Defined in

src/ui/widgets/widget.ts:17

---

entity

protected entity: UploadedFile

Defined in

src/ui/editors/uploadeditors.tsx:251

---

fileSymbols

protected fileSymbols: HTMLElement

Defined in

src/ui/editors/uploadeditors.tsx:254

---

hiddenInput

protected hiddenInput: HTMLInputElement

Defined in

src/ui/editors/uploadeditors.tsx:256

---

idPrefix

readonly idPrefix: string

Inherited from

EditorWidget.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

EditorWidget.options

Defined in

src/ui/widgets/widget.ts:14

---

progress

protected progress: HTMLElement

Defined in

src/ui/editors/uploadeditors.tsx:253

---

toolbar

protected toolbar: Toolbar<ToolbarOptions>

Defined in

src/ui/editors/uploadeditors.tsx:252

---

uniqueName

readonly uniqueName: string

Inherited from

EditorWidget.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

uploadInput

protected uploadInput: Fluent<HTMLElement>

Defined in

src/ui/editors/uploadeditors.tsx:255

---

isComponent

readonly static isComponent: true = true

Inherited from

EditorWidget.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

EditorWidget.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

EditorWidget.element

Defined in

src/ui/widgets/widget.ts:63

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

EditorWidget.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

EditorWidget.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

Defined in

src/ui/editors/uploadeditors.tsx:181

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

EditorWidget.addCssClass

Defined in

src/ui/widgets/widget.ts:67

---

addFileButtonText()

protected addFileButtonText(): string

Returns

string

Defined in

src/ui/editors/uploadeditors.tsx:85

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

EditorWidget.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

EditorWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

EditorWidget.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

EditorWidget.byId

Defined in

src/ui/widgets/widget.ts:106

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

EditorWidget.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Inherited from

EditorWidget.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

EditorWidget.findById

Defined in

src/ui/widgets/widget.ts:110

---

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/uploadeditors.tsx:139

---

get_required()

get_required(): boolean

Returns

boolean

Implementation of

IValidateRequired.get_required

Defined in

src/ui/editors/uploadeditors.tsx:165

---

get_value()

get_value(): UploadedFile

Returns

UploadedFile

Defined in

src/ui/editors/uploadeditors.tsx:173

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

EditorWidget.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

EditorWidget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getEditValue()

getEditValue(property, target): void

Parameters

property

PropertyItem

target

any

Returns

void

Implementation of

IGetEditValue.getEditValue

Defined in

src/ui/editors/uploadeditors.tsx:224

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

EditorWidget.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getToolButtons()

protected getToolButtons(): ToolButton[]

Returns

ToolButton[]

Defined in

src/ui/editors/uploadeditors.tsx:89

---

getUploadInputOptions()

protected getUploadInputOptions(): UploadInputOptions

Returns

UploadInputOptions

Defined in

src/ui/editors/uploadeditors.tsx:58

---

init()

init(): this

Returns

this

Inherited from

EditorWidget.init

Defined in

src/ui/widgets/widget.ts:157

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

EditorWidget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

EditorWidget.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

populate()

protected populate(): void

Returns

void

Defined in

src/ui/editors/uploadeditors.tsx:114

---

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

EditorWidget.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

EditorWidget.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/uploadeditors.tsx:143

---

set_required()

set_required(value): void

Parameters

value

boolean

Returns

void

Implementation of

IValidateRequired.set_required

Defined in

src/ui/editors/uploadeditors.tsx:169

---

set_value()

set_value(value): void

Parameters

value

UploadedFile

Returns

void

Defined in

src/ui/editors/uploadeditors.tsx:185

---

setEditValue()

setEditValue(source, property): void

Parameters

source

any

property

PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

Defined in

src/ui/editors/uploadeditors.tsx:228

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

EditorWidget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

updateInterface()

protected updateInterface(): void

Returns

void

Defined in

src/ui/editors/uploadeditors.tsx:131

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

EditorWidget.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

EditorWidget.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

EditorWidget.createDefaultElement

Defined in

src/ui/widgets/widget.ts:56

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

EditorWidget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95