inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2905] Updated JSDocs for core (#3271)

Browse Source
This commit is contained in:
Andy Stark
2018-05-04 19:03:13 +01:00
committed by Eugenio Romano
parent fe0ac0e474
commit c824e646de
18 changed files with 256 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/core/form-rendering.service.md
View File

@@ -2,6 +2,7 @@
Added: v2.0.0
Status: Active
---
# Form Rendering service
Maps an APS form field type string onto the corresponding form widget component type.
@@ -10,19 +11,21 @@ Maps an APS form field type string onto the corresponding form widget component
### Methods
- `getComponentTypeResolver(type: string, defaultValue: Type<{}> = this.defaultValue): DynamicComponentResolveFunction`
Gets the currently active ComponentTypeResolver function for a field type.
- `type` - The type whose resolver you want
- `defaultValue` - Default type returned for types that are not yet mapped
- `setComponentTypeResolver(type: string, resolver: DynamicComponentResolveFunction, override: boolean = false)`
Sets or optionally replaces a ComponentTypeResolver function for a field type.
- `type` - The type whose resolver you want to set
- `resolver` - The new resolver function
- `override` - The new resolver will only replace an existing one if this parameter is true
- `resolveComponentType(model: DynamicComponentModel, defaultValue: Type<{}> = this.defaultValue): Type<{}>`
Finds the component type that is needed to render a form field.
- `model` - [Form field model](form-field.model.md) for the field to render
- `defaultValue` - Default type returned for field types that are not yet mapped.
- `getComponentTypeResolver(type: string = null, defaultValue: Type<__type> = this.defaultValue): DynamicComponentResolveFunction`<br/>
Gets the currently active ComponentTypeResolver function for a field type.
- `type: string = null` - The type whose resolver you want
- `defaultValue: Type<__type> = this.defaultValue` - Default type returned for types that are not yet mapped
- **Returns** `DynamicComponentResolveFunction` - Resolver function
- `resolveComponentType(model: DynamicComponentModel = null, defaultValue: Type<__type> = this.defaultValue): Type<__type>`<br/>
Finds the component type that is needed to render a form field.
- `model: DynamicComponentModel = null` - (form-field.model.md) for the field to render
- `defaultValue: Type<__type> = this.defaultValue` - Default type returned for field types that are not yet mapped.
- **Returns** `Type<__type>` - Component type
- `setComponentTypeResolver(type: string = null, resolver: DynamicComponentResolveFunction = null, override: boolean = false)`<br/>
Sets or optionally replaces a ComponentTypeResolver function for a field type.
- `type: string = null` - The type whose resolver you want to set
- `resolver: DynamicComponentResolveFunction = null` - The new resolver function
- `override: boolean = false` - The new resolver will only replace an existing one if this parameter is true
## Details