@serenity-is/corelib / MultipleFileUploadEditor
Class: MultipleFileUploadEditor<P>
Type parameters
Name | Type |
---|---|
P |
extends MultipleFileUploadEditorOptions = MultipleFileUploadEditorOptions |
Hierarchy
EditorWidget
<P
>↳
MultipleFileUploadEditor
Implements
Table of contents
Constructors
Properties
Accessors
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 MultipleFileUploadEditor<P
>(props
): MultipleFileUploadEditor
<P
>
Type parameters
Name | Type |
---|---|
P |
extends MultipleFileUploadEditorOptions = MultipleFileUploadEditorOptions |
Parameters
Name | Type |
---|---|
props |
EditorProps <P > |
Returns
Overrides
Defined in
src/ui/editors/uploadeditors.ts:292
Properties
domNode
• Readonly
domNode: HTMLElement
Inherited from
Defined in
hiddenInput
• Protected
hiddenInput: Fluent
<HTMLElement
>
Defined in
src/ui/editors/uploadeditors.ts:290
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
options
• Protected
Readonly
options: WidgetProps
<EditorProps
<P
>>
Inherited from
Defined in
progress
• Protected
progress: Fluent
<HTMLElement
>
Defined in
src/ui/editors/uploadeditors.ts:289
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.EditorWidget"
>
Inherited from
Defined in
Accessors
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Inherited from
EditorWidget.element
Defined in
jsonEncodeValue
• get
jsonEncodeValue(): boolean
Returns
boolean
Defined in
src/ui/editors/uploadeditors.ts:473
• set
jsonEncodeValue(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Defined in
src/ui/editors/uploadeditors.ts:474
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
EditorWidget.props
Defined in
value
• get
value(): UploadedFile
[]
Returns
Defined in
src/ui/editors/uploadeditors.ts:429
• set
value(v
): void
Parameters
Name | Type |
---|---|
v |
UploadedFile [] |
Returns
void
Defined in
src/ui/editors/uploadeditors.ts:441
Methods
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addFileButtonText
▸ addFileButtonText(): string
Returns
string
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
EditorWidget.addValidationRule
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
EditorWidget.addValidationRule
Defined in
change
▸ change(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
destroy
▸ destroy(): void
Returns
void
Inherited from
Defined in
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
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
EditorWidget.getCustomAttribute
Defined in
getEditValue
▸ getEditValue(property
, target
): void
Parameters
Name | Type |
---|---|
property |
PropertyItem |
target |
any |
Returns
void
Implementation of
Defined in
src/ui/editors/uploadeditors.ts:445
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
getToolButtons
▸ getToolButtons(): ToolButton
[]
Returns
Defined in
src/ui/editors/uploadeditors.ts:354
getUploadInputOptions
▸ getUploadInputOptions(): UploadInputOptions
Returns
Defined in
src/ui/editors/uploadeditors.ts:324
get_readOnly
▸ get_readOnly(): boolean
Returns
boolean
Implementation of
Defined in
src/ui/editors/uploadeditors.ts:389
get_required
▸ get_required(): boolean
Returns
boolean
Implementation of
IValidateRequired.get_required
Defined in
src/ui/editors/uploadeditors.ts:415
get_value
▸ get_value(): UploadedFile
[]
Returns
Defined in
src/ui/editors/uploadeditors.ts:423
init
▸ init(): this
Returns
this
Inherited from
Defined in
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
EditorWidget.internalRenderContents
Defined in
populate
▸ populate(): void
Returns
void
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
Defined in
renderContents
▸ renderContents(): any
Returns
any
Inherited from
Defined in
setEditValue
▸ setEditValue(source
, property
): void
Parameters
Name | Type |
---|---|
source |
any |
property |
PropertyItem |
Returns
void
Implementation of
Defined in
src/ui/editors/uploadeditors.ts:454
set_readOnly
▸ set_readOnly(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Implementation of
Defined in
src/ui/editors/uploadeditors.ts:393
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:419
set_value
▸ set_value(value
): void
Parameters
Name | Type |
---|---|
value |
UploadedFile [] |
Returns
void
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
Defined in
updateInterface
▸ updateInterface(): void
Returns
void
Defined in
src/ui/editors/uploadeditors.ts:383
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
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
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLElement
Returns
HTMLElement
Inherited from
EditorWidget.createDefaultElement
Defined in
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string