@serenity-is/corelib / FileUploadEditor

Class: FileUploadEditor

Hierarchy

• Widget<FileUploadEditorOptions>

  ↳ FileUploadEditor

  ↳↳ ImageUploadEditor

Implements

• IReadOnly
• IGetEditValue
• ISetEditValue
• IValidateRequired

Table of contents

Constructors

• constructor

Properties

• element
• entity
• fileSymbols
• hiddenInput
• idPrefix
• options
• progress
• toolbar
• uniqueName
• uploadInput
• widgetName

Accessors

• value

Methods

• addCssClass
• addFileButtonText
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getEditValue
• getGridField
• getToolButtons
• getUploadInputOptions
• get_readOnly
• get_required
• get_value
• init
• initialize
• populate
• renderContents
• setEditValue
• set_readOnly
• set_required
• set_value
• updateInterface
• create
• elementFor
• getWidgetName

Constructors

constructor

• new FileUploadEditor(div, opt)

Parameters

Name	Type
div	JQuery
opt	FileUploadEditorOptions

Overrides

Widget.constructor

Defined in

src/ui/editors/uploadeditors.ts:23

Properties

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

entity

• Protected entity: UploadedFile

Defined in

src/ui/editors/uploadeditors.ts:259

---

fileSymbols

• Protected fileSymbols: JQuery

Defined in

src/ui/editors/uploadeditors.ts:262

---

hiddenInput

• Protected hiddenInput: JQuery

Defined in

src/ui/editors/uploadeditors.ts:264

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: FileUploadEditorOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

progress

• Protected progress: JQuery

Defined in

src/ui/editors/uploadeditors.ts:261

---

toolbar

• Protected toolbar: Toolbar

Defined in

src/ui/editors/uploadeditors.ts:260

---

uniqueName

• Protected uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

uploadInput

• Protected uploadInput: JQuery

Defined in

src/ui/editors/uploadeditors.ts:263

---

widgetName

• Protected widgetName: string

Inherited from

Widget.widgetName

Defined in

src/ui/widgets/widget.ts:63

Accessors

value

• get value(): UploadedFile

Returns

UploadedFile

Defined in

src/ui/editors/uploadeditors.ts:185

• set value(v): void

Parameters

Name	Type
v	UploadedFile

Returns

void

Defined in

src/ui/editors/uploadeditors.ts:227

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addFileButtonText

▸ Protected addFileButtonText(): string

Returns

string

Defined in

src/ui/editors/uploadeditors.ts:87

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name	Type
eventClass	string
rule	(p1: JQuery) => string

Returns

JQuery

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Inherited from

Widget.destroy

Defined in

src/ui/widgets/widget.ts:92

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getEditValue

▸ getEditValue(property, target): void

Parameters

Name	Type
property	PropertyItem
target	any

Returns

void

Implementation of

IGetEditValue.getEditValue

Defined in

src/ui/editors/uploadeditors.ts:231

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getToolButtons

▸ Protected getToolButtons(): ToolButton[]

Returns

ToolButton[]

Defined in

src/ui/editors/uploadeditors.ts:91

---

getUploadInputOptions

▸ Protected getUploadInputOptions(): UploadInputOptions

Returns

UploadInputOptions

Defined in

src/ui/editors/uploadeditors.ts:57

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/uploadeditors.ts:144

---

get_required

▸ get_required(): boolean

Returns

boolean

Implementation of

IValidateRequired.get_required

Defined in

src/ui/editors/uploadeditors.ts:169

---

get_value

▸ get_value(): UploadedFile

Returns

UploadedFile

Defined in

src/ui/editors/uploadeditors.ts:177

---

init

▸ init(action?): FileUploadEditor

Parameters

Name	Type
action?	(widget: any) => void

Returns

FileUploadEditor

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Inherited from

Widget.initialize

Defined in

src/ui/widgets/widget.ts:176

---

populate

▸ Protected populate(): void

Returns

void

Defined in

src/ui/editors/uploadeditors.ts:119

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

setEditValue

▸ setEditValue(source, property): void

Parameters

Name	Type
source	any
property	PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

Defined in

src/ui/editors/uploadeditors.ts:236

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/uploadeditors.ts:148

---

set_required

▸ set_required(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IValidateRequired.set_required

Defined in

src/ui/editors/uploadeditors.ts:173

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	UploadedFile

Returns

void

Defined in

src/ui/editors/uploadeditors.ts:189

---

updateInterface

▸ Protected updateInterface(): void

Returns

void

Defined in

src/ui/editors/uploadeditors.ts:136

---

create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<TOpt, TWidget>
TOpt	TOpt

Parameters

Name	Type
params	CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

Widget.create

Defined in

src/ui/widgets/widget.ts:153

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name	Type
editorType	(...args: any[]) => TWidget

Returns

JQuery

Inherited from

Widget.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124