alfresco-ng2-components/docs/process-services-cloud/components/form-cloud.component.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Form component	v3.2.0	Active	2019-04-01

Form cloud component

Shows a form from Process Services

Contents

• Basic Usage
  • Empty form template
• Class members
  • Properties
  • Events
• Details
  • Displaying a form
  • Controlling outcome execution behaviour
  • Field Validators
  • Common scenarios
• See also

Basic Usage

<adf-cloud-form 
    [appName]="appName"
    [taskId]="taskId">
</adf-cloud-form>

Empty form template

The template defined inside empty-form will be shown when no form definition is found:

<adf-cloud-form .... >

    <div empty-form >
        <h2>Empty form</h2>
    </div>

</adf-cloud-form>

Class members

Properties

Name	Type	Default value	Description
appName	string		App id to fetch corresponding form and values.
taskId	string		Task id to fetch corresponding form and values.
form	FormCloudModel		Underlying form model instance.
formId	string		The id of the form definition to load and display with custom values.
data	TaskVariableCloud[]		Custom form values map to be used with the rendered form.
disableCompleteButton	boolean	false	If true then the Complete outcome button is shown but it will be disabled.
disableStartProcessButton	boolean	false	If true then the Start Process outcome button is shown but it will be disabled.
fieldValidators	FormFieldValidator[]	[]	Contains a list of form field validator instances.
readOnly	boolean	false	Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled.
showCompleteButton	boolean	true	Toggle rendering of the Complete outcome button.
showDebugButton	boolean	false	Toggle debug options.
showRefreshButton	boolean	true	Toggle rendering of the Refresh button.
showSaveButton	boolean	true	Toggle rendering of the Save outcome button.
showTitle	boolean	true	Toggle rendering of the form title.
showValidationIcon	boolean	true	Toggle rendering of the validation icon next to the form title.

Events

Name	Type	Description
error	EventEmitter<any>	Emitted when any error occurs.
executeOutcome	EventEmitter<FormOutcomeEvent>	Emitted when any outcome is executed. Default behaviour can be prevented via event.preventDefault().
formCompleted	EventEmitter<FormCloudModel>	Emitted when the form is submitted with the Complete outcome.
formDataRefreshed	EventEmitter<FormCloudModel>	Emitted when form values are refreshed due to a data property change.
formError	EventEmitter<FormFieldModel[]>	Emitted when the supplied form values have a validation error.
formLoaded	EventEmitter<FormCloudModel>	Emitted when the form is loaded or reloaded.
formSaved	EventEmitter<FormCloudModel>	Emitted when the form is submitted with the Save or custom outcomes.

Details

All formXXX events receive a FormCloudModel instance as their argument:

MyView.component.html

<adf-cloud-form
    [appName]="appName"
    [taskId]="selectedTask?.id"
    (formSaved)="onFormSaved($event)">
</adf-cloud-form>

MyView.component.ts

onFormSaved(form: FormCloudModel) {
    console.log(form);
}

Displaying a form

There are various ways to display a form. The common scenarios are detailed below.

Displaying a form instance by task id

<adf-cloud-form 
    [appName]="appName"
    [taskId]="selectedTask?.id">
</adf-cloud-form>

For an existing Task both the form and its values will be fetched and displayed.

Displaying a form definition by form id

<adf-cloud-form 
    [appName]="appName"
    [formId]="selectedFormDefinition?.id"
    [data]="customData">
</adf-cloud-form>

In this case, only the form definition will be fetched.

Controlling outcome execution behaviour

In unusual circumstances, you may need to take complete control of form outcome execution. You can do this by implementing the executeOutcome event, which is emitted for both system outcomes and custom ones.

Note that by default, the code in your executeOutcome handler is executed before the default behavior but you can switch the default behavior off using event.preventDefault(). You might want to do this, for example, to provide custom form validation or to show a summary of the form validation before it is submitted.

MyView.component.html

<adf-cloud-form
    [appName]="appName"
    [taskId]="selectedTask?.id"
    executeOutcome="validateForm($event)">
</adf-cloud-form>

MyView.component.ts

import { FormOutcomeEvent } from '@alfresco/adf-core';

export class MyView {

    validateForm(event: FormOutcomeEvent) {
        let outcome = event.outcome;

        // you can also get additional properties of outcomes
        // if you defined them within outcome definition

        if (outcome) {
            let form = outcome.form;
            if (form) {
                // check/update the form here
                event.preventDefault();
            }
        }
    }

}

There are two other functions that can be very useful when you need to control form outcomes:

• saveTaskForm() - Saves the current form
• completeTaskForm(outcome?: string) Saves and completes the form with a given outcome name

Field Validators

You can supply a set of validator objects to the form using the fieldValidators property. Each validator implements a check for a particular type of data (eg, a date validator might check that the date in the field falls between 1980 and 2017). ADF supplies a standard set of validators that handle most common cases but you can also implement your own custom validators to replace or extend the set. See the Form Field Validator interface for full details and examples.

Common scenarios

Rendering a form using form definition JSON

See the demo-form file for an example of form definition JSON.

The component below (with the JSON assigned to the formDefinitionJSON property), shows how a form definition is rendered:

@Component({
    selector: 'sample-form',
    template: `<div class="form-container">
                    <adf-cloud-form
                        [form]="form">
                    </adf-cloud-form>
                </div>`
})
export class SampleFormComponent implements OnInit {

    form: FormCloudModel;
    formDefinitionJSON: any;

    constructor(private formService: FormService) {
    }

    ngOnInit() {        
        this.form = this.formService.parseForm(this.formDefinitionJSON);
    }
}

Customizing the styles of form outcome buttons

You can use normal CSS selectors to style the outcome buttons of your form. Every outcome has an CSS id value following a simple pattern:

  adf-cloud-form-OUTCOME_NAME

In the CSS, you can target any outcome ID and change the style as in this example:

#adf-cloud-form-complete {
    background-color: blue !important;
    color: white;
}


#adf-cloud-form-save {
    background-color: green !important;
    color: white;
}

#adf-cloud-form-customoutcome {
    background-color: yellow !important;
    color: white;
}

See also

• Form Field Validator interface
• Extensibility
• Form rendering service
• Form field model
• Form service