B25.Form

Overview

The B25.Form class is the main point of interaction for anything that you want to do on the form. Inside the customize method (defined in the B25.Form.Customizer interface) you can add your own event handlers to the form (or its child elements). Inside the handleEvent method of your own handlers, you can inspect the current form state and update values on it (or its child elements). Use the getter methods to access lower level child elements, such as fields or related lists.

There are three events that you can hook into at the form level:

• onInit - for prepopulating fields when a new reservation is created

• onOpen - for changing the appearance of the form depending on the reservation being shown

• onBeforeSave - for adding your own validation

Example 1: Adding a handler

Adding handlers is done inside the customize method of your own implementation of the B25.Form.Customizer interface.

Also see: Quick Start Guide

Example 2: Updating the form

Updating the form’s record is done using getActiveRecord() inside the handleEvent method of your own event handlers.

Also see: B25.FormEventHandler

Interfaces

B25.Form.Customizer

The B25.Form.Customizer interface is what you need to implement to attach your own handlers to the form (also see: Quick Start Guide). It only has one method, with the following signature:

Parameters:

Methods

getField

This method will return a Field object for the specified SObjectField. The SObjectField must be an existing reservation field. You can use this Field object to bind handlers inside your Customizer class.

Return value: B25.FormField

Parameters:

Example:

getActiveRecord()

This method returns a wrapper representing the record that is currently visible on the form.

Return value: B25.FormRecord

Example:

Update the reservation title from inside a B25.FormEventHandler

getParentRecord()

This method returns a wrapper representing the parent record of the form, if it has any.

Return value: B25.FormRecord

hasParentRecord()

Returns true if the form has a parent record.

getChildRecords()

This method returns a wrapper representing all the child records of the form, if it has any.

Return value: B25.FormRecordCollection

hasChildRecords()

Returns true if the form has a child records.

getButton

This method will return a Button object. The buttonName must be an existing button.

Return value: B25.FormButton

Parameters:

Example:

getSection

This method will return a Section object. The sectionName must be an existing section label.

Return value: B25.FormSection

Parameters:

Example:

getLookup

Similar to getField, but instead this method will return a Lookup object for the specified SObjectField. The SObjectField must be an existing lookup field on reservation.

Return value: B25.Lookup

Parameters:

Example:

getRelatedList

Returns the related list associated with the passed SObjectType token. The SObjectType must be a child of the form’s SObjectType (which is currently always B25__Reservation__c).

Return value: B25.RelatedList

Parameters:

Example:

getReservation

Returns the actual reservation record of this form. You can use this method inside your handlers to get more information about the field values of the current reservation record.

Setting values directly on this record has no effect. If you want to update field values, call getField followed by updateValue instead, as illustrated below:

Return value: B25__Reservation__c

onInit (without parameters)

Returns the list of handlers that have been defined to trigger when the form is initialized. For more details, see onInit (with parameter) below.

Return value: List<B25.FormEventHandler>

onInit (with parameter)

This method adds a handler which triggers when the reservation form is initialized for a new reservation. It also triggers for each reservation that gets added to the sidebar of the form, such as for recurring reservations or when using custom form logic to add child reservations.

Adding an onInit handler is primarily intended to prepopulate fields on new reservations. For changing the appearance of the form, use an onOpen handler instead.

Parameters:

onOpen (without parameters)

Returns the list of handlers that have been defined to trigger when the form is opened. For more details, see onOpen (with parameter) below.

Return value: List<B25.FormEventHandler>

onOpen (with parameter)

This method adds a handler which triggers when the reservation form is opened for either a new or existing reservation. It also triggers when you switch to another reservation in the sidebar, which is visible if the form is showing multiple reservations, such as for recurring reservations or when using the multi-select mode on the calendar.

Adding an onOpen handler is primarily intended to change the appearance of the form depending on the reservation being shown. You can use this to show/hide fields, buttons, sections, etc. To prepopulate fields for new reservations, use an onInit handler instead.

Parameters:

onBeforeSave (without parameters)

Returns the list of handlers that have been defined to trigger when the form is opened. For more details, see onBeforeSave (with parameter) below.

Return value: List<B25.FormEventHandler>

onBeforeSave (with parameter)

This method adds a handler which triggers when the reservation form is saved, but before the actual saving logic is executed. You can use such a handler to add your own validation, and show error toast messages for example (see showErrorToast below).

Parameters:

addButton

Adds a button to the form. Must be called inside the customize method.

Parameters:

Example:

showSuccessToast

Shows a success toast notification on the form.

Parameters:

Example:

showErrorToast

Shows an error toast notification on the form.

Parameters:

Example:

showWarningToast

Shows a warning toast notification on the form.

Parameters:

Example:

showInfoToast

Shows an info toast notification on the form.

Parameters:

Example: