mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1769] Added prop tables and fixed script (#2896)
* [ADF-1769] Added prop tables and fixed script * [ADF-1769] Corrected JSDoc formatting errors * [ADF-1769] Restored default column to prop tables
This commit is contained in:
committed by
Eugenio Romano
parent
8a4959d172
commit
900fd70d63
@@ -54,6 +54,11 @@ export class FormFieldComponent implements OnInit, OnDestroy {
|
||||
@ViewChild('container', { read: ViewContainerRef })
|
||||
container: ViewContainerRef;
|
||||
|
||||
/** Contains all the necessary data needed to determine what UI Widget
|
||||
* to use when rendering the field in the form. You would typically not
|
||||
* create this data manually but instead create the form in APS and export
|
||||
* it to get to all the `FormFieldModel` definitions.
|
||||
*/
|
||||
@Input()
|
||||
field: FormFieldModel = null;
|
||||
|
||||
|
@@ -26,6 +26,7 @@ import { FormService } from './../services/form.service';
|
||||
})
|
||||
export class FormListComponent implements OnChanges {
|
||||
|
||||
/** The array that contains the information to show inside the list. */
|
||||
@Input()
|
||||
forms: any [] = [];
|
||||
|
||||
|
@@ -41,81 +41,109 @@ export class FormComponent implements OnInit, OnChanges {
|
||||
static COMPLETE_BUTTON_COLOR: string = 'primary';
|
||||
static COMPLETE_OUTCOME_NAME: string ='Complete'
|
||||
|
||||
/** Underlying form model instance. */
|
||||
@Input()
|
||||
form: FormModel;
|
||||
|
||||
/** Task id to fetch corresponding form and values. */
|
||||
@Input()
|
||||
taskId: string;
|
||||
|
||||
/** Content Services node ID for the form metadata. */
|
||||
@Input()
|
||||
nodeId: string;
|
||||
|
||||
/** The id of the form definition to load and display with custom values. */
|
||||
@Input()
|
||||
formId: string;
|
||||
|
||||
/** Name of the form definition to load and display with custom values. */
|
||||
@Input()
|
||||
formName: string;
|
||||
|
||||
/** Toggle saving of form metadata. */
|
||||
@Input()
|
||||
saveMetadata: boolean = false;
|
||||
|
||||
/** Custom form values map to be used with the rendered form. */
|
||||
@Input()
|
||||
data: FormValues;
|
||||
|
||||
/** Path of the folder where the metadata will be stored. */
|
||||
@Input()
|
||||
path: string;
|
||||
|
||||
/** Name to assign to the new node where the metadata are stored. */
|
||||
@Input()
|
||||
nameNode: string;
|
||||
|
||||
/** Toggle rendering of the form title. */
|
||||
@Input()
|
||||
showTitle: boolean = true;
|
||||
|
||||
/** Toggle rendering of the `Complete` outcome button. */
|
||||
@Input()
|
||||
showCompleteButton: boolean = true;
|
||||
|
||||
/** If true then the `Complete` outcome button is shown but it will be disabled. */
|
||||
@Input()
|
||||
disableCompleteButton: boolean = false;
|
||||
|
||||
/** If true then the `Start Process` outcome button is shown but it will be disabled. */
|
||||
@Input()
|
||||
disableStartProcessButton: boolean = false;
|
||||
|
||||
/** Toggle rendering of the `Save` outcome button. */
|
||||
@Input()
|
||||
showSaveButton: boolean = true;
|
||||
|
||||
/** Toggle debug options. */
|
||||
@Input()
|
||||
showDebugButton: boolean = false;
|
||||
|
||||
/** Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. */
|
||||
@Input()
|
||||
readOnly: boolean = false;
|
||||
|
||||
/** Toggle rendering of the `Refresh` button. */
|
||||
@Input()
|
||||
showRefreshButton: boolean = true;
|
||||
|
||||
/** Toggle rendering of the validation icon next to the form title. */
|
||||
@Input()
|
||||
showValidationIcon: boolean = true;
|
||||
|
||||
/** Contains a list of form field validator instances. */
|
||||
@Input()
|
||||
fieldValidators: FormFieldValidator[] = [];
|
||||
|
||||
/** Emitted when the form is submitted with the `Save` or custom outcomes. */
|
||||
@Output()
|
||||
formSaved: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when the form is submitted with the `Complete` outcome. */
|
||||
@Output()
|
||||
formCompleted: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when form content is clicked. */
|
||||
@Output()
|
||||
formContentClicked: EventEmitter<ContentLinkModel> = new EventEmitter<ContentLinkModel>();
|
||||
|
||||
/** Emitted when the form is loaded or reloaded. */
|
||||
@Output()
|
||||
formLoaded: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when form values are refreshed due to a data property change. */
|
||||
@Output()
|
||||
formDataRefreshed: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when any outcome is executed. Default behaviour can be prevented
|
||||
* via `event.preventDefault()`.
|
||||
*/
|
||||
@Output()
|
||||
executeOutcome: EventEmitter<FormOutcomeEvent> = new EventEmitter<FormOutcomeEvent>();
|
||||
|
||||
/** Emitted when any error occurs. */
|
||||
@Output()
|
||||
onError: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
Reference in New Issue
Block a user