Previous Page Next Page

@serenity-is/corelib / ImageUploadEditor

Class: ImageUploadEditor<P>

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

Extends

Type Parameters

P

P extends ImageUploadEditorOptions = ImageUploadEditorOptions

Constructors

Constructor

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

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

Parameters

props

EditorProps<P>

Returns

ImageUploadEditor<P>

Overrides

FileUploadEditor.constructor

Properties

domNode

readonly domNode: HTMLElement

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

Inherited from

FileUploadEditor.domNode

entity

protected entity: UploadedFile

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

Inherited from

FileUploadEditor.entity

fileSymbols

protected fileSymbols: HTMLElement

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

Inherited from

FileUploadEditor.fileSymbols

hiddenInput

protected hiddenInput: HTMLInputElement

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

Inherited from

FileUploadEditor.hiddenInput

idPrefix

readonly idPrefix: string

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

Inherited from

FileUploadEditor.idPrefix

options

protected readonly options: WidgetProps<EditorProps<P>>

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

Inherited from

FileUploadEditor.options

progress

protected progress: HTMLElement

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

Inherited from

FileUploadEditor.progress

toolbar

protected toolbar: Toolbar

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

Inherited from

FileUploadEditor.toolbar

uniqueName

readonly uniqueName: string

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

Inherited from

FileUploadEditor.uniqueName

uploadInput

protected uploadInput: Fluent

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

Inherited from

FileUploadEditor.uploadInput

[typeInfo]

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

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

Overrides

FileUploadEditor.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

FileUploadEditor.isComponent

Accessors

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

FileUploadEditor.element

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

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

FileUploadEditor.readOnly

value

Get Signature

get value(): UploadedFile

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

Returns

UploadedFile

Set Signature

set value(v): void

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

Parameters
v

UploadedFile

Returns

void

Inherited from

FileUploadEditor.value

Methods

addCssClass()

protected addCssClass(): void

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

Returns

void

Inherited from

FileUploadEditor.addCssClass

addFileButtonText()

protected addFileButtonText(): string

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

Returns

string

Inherited from

FileUploadEditor.addFileButtonText

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

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

FileUploadEditor.addValidationRule

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

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

FileUploadEditor.byId

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

FileUploadEditor.change

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

FileUploadEditor.changeSelect2

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

FileUploadEditor.deferRender

destroy()

destroy(): void

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

Returns

void

Inherited from

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

FileUploadEditor.findById

get_readOnly()

get_readOnly(): boolean

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

Returns

boolean

Inherited from

FileUploadEditor.get_readOnly

get_required()

get_required(): boolean

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

Returns

boolean

Inherited from

FileUploadEditor.get_required

get_value()

get_value(): UploadedFile

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

Returns

UploadedFile

Inherited from

FileUploadEditor.get_value

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

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

FileUploadEditor.getCustomAttribute

getEditValue()

getEditValue(property, target): void

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

Parameters

property

PropertyItem

target

any

Returns

void

Inherited from

FileUploadEditor.getEditValue

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

FileUploadEditor.getGridField

getToolButtons()

protected getToolButtons(): ToolButton[]

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

Returns

ToolButton[]

Inherited from

FileUploadEditor.getToolButtons

getUploadInputOptions()

protected getUploadInputOptions(): UploadInputOptions

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

Returns

UploadInputOptions

Inherited from

FileUploadEditor.getUploadInputOptions

init()

init(): this

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

Returns

this

Inherited from

FileUploadEditor.init

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

FileUploadEditor.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

FileUploadEditor.legacyTemplateRender

populate()

protected populate(): void

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

Returns

void

Inherited from

FileUploadEditor.populate

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

FileUploadEditor.render

renderContents()

protected renderContents(): any

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

Returns

any

Inherited from

FileUploadEditor.renderContents

set_readOnly()

set_readOnly(value): void

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

Parameters

value

boolean

Returns

void

Inherited from

FileUploadEditor.set_readOnly

set_required()

set_required(value): void

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

Parameters

value

boolean

Returns

void

Inherited from

FileUploadEditor.set_required

set_value()

set_value(value): void

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

Parameters

value

UploadedFile

Returns

void

Inherited from

FileUploadEditor.set_value

setEditValue()

setEditValue(source, property): void

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

Parameters

source

any

property

PropertyItem

Returns

void

Inherited from

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

FileUploadEditor.syncOrAsyncThen

updateInterface()

protected updateInterface(): void

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

Returns

void

Inherited from

FileUploadEditor.updateInterface

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

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

FileUploadEditor.create

createDefaultElement()

static createDefaultElement(): HTMLElement

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

Returns

HTMLElement

Inherited from

FileUploadEditor.createDefaultElement

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

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

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

FileUploadEditor.registerEditor