Skip to content

Configuration

This section describes the user interface–related configuration options available for the Entry classes — CreateEntry, UpdateEntry, DeleteEntry, and DisplayEntry.

These options allow consumers to control various aspects of the generated UI, including dialog titles, button text and behavior, and other presentation-related settings.

Some configuration options may not be applicable to all Entry classes. Such limitations are clearly mentioned in the description of each feature.

Configurations can be applied in two ways:

  • In the constructor of the Entry class.
  • Via getter/setter methods through an instance of an Entry class.

Note

All examples in this section use the CreateEntry class for demonstration purposes. The same configuration applies to other Entry classes as long as the specific feature is supported.

Form Position (index)

number

By default, the Entry classes place the generated form as the first element within the dialog or embedded component. This position can be adjusted using the index configuration, allowing consumers to determine where the form should appear in relation to other generated content.

This feature is especially useful when multiple navigation properties are configured, each producing its own table or form inside the same container. Additionally, ui5.antares.pro.v2.metadata.NavigationProperty instances can also define an index to control the placement of their generated content.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ✅ Yes

Method Returns Description
getIndex() number Current index of the generated form; supports negative values to control its position in the dialog or component.

Method Parameter Type Mandatory Description
setIndex(newValue) newValue number ✅ Yes Sets the index for the generated form; supports negative values for relative positioning.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class
import NavigationProperty from "ui5/antares/pro/v2/metadata/NavigationProperty"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            index: 1 // Position the form after the navigation property content
        });

        entry.addNavigationProperty(new NavigationProperty({
            name: "toSupplier",
            index: 0 // Position the navigation property content before the main form
        }));
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry", // Import the class
    "ui5/antares/pro/v2/metadata/NavigationProperty" // Import the class
], (Controller, CreateEntry, NavigationProperty) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                index: 1 // Position the form after the navigation property content
            });

            entry.addNavigationProperty(new NavigationProperty({
                name: "toSupplier",
                index: 0 // Position the navigation property content before the main form
            }));
        }
    });
});

Dialog Title (dialogTitle)

string

Localized Text

In dialog mode, the Entry classes generate a dialog with a default title composed of localized text and the associated EntitySet name. This default title ensures clarity for end users, but consumers can easily override it using the dialogTitle configuration.

This feature is especially useful when the default title is too generic or when you want to provide a more descriptive, user-friendly title in the dialog header.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ❌ No

Method Returns Description
getDialogTitle() string Returns the current dialog title. If not explicitly set, returns the generated default title.

Method Parameter Type Mandatory Description
setDialogTitle(newValue) newValue string ✅ Yes Sets a custom title for the dialog, replacing the generated default title.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            dialogTitle: "Create New Product" // Override the default dialog title
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                dialogTitle: "Create New Product" // Override the default dialog title
            });
        }
    });
});

Form Title (formTitle)

string

The formTitle property defines the title displayed above the generated form. By default, no title is shown. This property allows you to set a clear and descriptive heading, improving the visual structure and user experience of the form.

A custom formTitle is particularly helpful when forms are part of a larger UI and need to convey context or purpose to the end user.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ✅ Yes

Method Returns Description
getFormTitle() string | undefined Returns the current form title. If no title is set, returns undefined.

Method Parameter Type Mandatory Description
setFormTitle(newValue) newValue string ✅ Yes Sets a custom title for the form.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            formTitle: "Product Details" // Set a custom form title
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                formTitle: "Product Details" // Set a custom form title
            });
        }
    });
});

Form Type (formType)

FormType

SmartForm

Determines the type of form generated for the specified EntitySet. By default, the library creates a SmartForm, which is metadata-driven and supports advanced features such as smart fields, annotations, and automatic OData integration.

This property allows consumers to switch to a SimpleForm when a simpler, less metadata-heavy layout is desired. SimpleForm offers more control over layout and content, making it suitable for custom UI scenarios or when metadata is incomplete.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ✅ Yes

Method Returns Description
getFormType() FormType Returns the current form type. If not explicitly set, returns the default value "SmartForm".

Method Parameter Type Mandatory Description
setFormType(newValue) newValue FormType ✅ Yes Sets the type of form to generate. Must be either "SmartForm" or "SimpleForm".

FormType Values

Value Description
SmartForm Generates a SmartForm using OData metadata to automatically create fields, labels, and layout.
SimpleForm Generates a SimpleForm, offering more flexibility for custom layouts and manual field creation.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            formType: "SimpleForm" // Switch to SimpleForm
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                formType: "SimpleForm" // Switch to SimpleForm
            });
        }
    });
});

Submit Button Text (submitButtonText)

string

Localized Text

Text displayed on the submit button within the generated dialog. A default localized text is provided by the library based on the current language. This property allows the consumer to override the button text.

Note

The submit button is not generated when using the DisplayEntry class. Additionally, the library will not generate any button in the Component Mode regardless of which Entry class is utilized.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ❌ No

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ❌ No

Method Returns Description
getSubmitButtonText() string Returns the current submit button text. If not explicitly set, returns the default localized text.

Method Parameter Type Mandatory Description
setSubmitButtonText(newValue) newValue string ✅ Yes Sets a custom text for the submit button, overriding the default localized text.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            submitButtonText: "Send Data" // Override the submit button text
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                submitButtonText: "Send Data" // Override the submit button text
            });
        }
    });
});

Submit Button Type (submitButtonType)

ButtonType

Emphasized

Button Type of the submit button in the generated dialog. Defaults to Emphasized. This property allows the consumer to configure a different button type.

Note

The submit button is not generated when using the DisplayEntry class. Additionally, the library will not generate any button in the Component Mode regardless of which Entry class is utilized.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ❌ No

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ❌ No

Method Returns Description
getSubmitButtonType() ButtonType Returns the current submit button type. If not explicitly set, returns the default value Emphasized.

Method Parameter Type Mandatory Description
setSubmitButtonType(newValue) newValue ButtonType ✅ Yes Sets a custom button type for the submit button, overriding the default Emphasized type.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class
import ButtonType from "sap/m/ButtonType"; // Import the ButtonType enum

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            submitButtonType: ButtonType.Reject // Override the submit button type
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry", // Import the class
    "sap/m/ButtonType" // Import the ButtonType enum
], (Controller, CreateEntry, ButtonType) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                submitButtonType: ButtonType.Reject // Override the submit button type
            });
        }
    });
});

Close Button Text (closeButtonText)

string

Localized Text

Text displayed on the close button within the generated dialog. A default localized text is provided by the library based on the current language. This property allows the consumer to override the button text.

Note

The library will not generate any button in the Component Mode regardless of which Entry class is utilized.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ❌ No

Method Returns Description
getCloseButtonText() string Returns the current close button text. If not explicitly set, returns the default localized text.

Method Parameter Type Mandatory Description
setCloseButtonText(newValue) newValue string ✅ Yes Sets a custom text for the close button, overriding the default localized text.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            closeButtonText: "Cancel" // Override the close button text
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry" // Import the class
], (Controller, CreateEntry) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                closeButtonText: "Cancel" // Override the close button text
            });
        }
    });
});

Close Button Type (closeButtonType)

ButtonType

Default

Button Type of the close button in the generated dialog. Defaults to Default. This property allows the consumer to configure a different button type.

Note

The library will not generate any button in the Component Mode regardless of which Entry class is utilized.

Entry Class Availability

Entry Class Available
CreateEntry ✅ Yes
UpdateEntry ✅ Yes
DeleteEntry ✅ Yes
DisplayEntry ✅ Yes

Implementation Mode Availability

Mode Available
Dialog Mode ✅ Yes
Component Mode ❌ No

Method Returns Description
getCloseButtonType() ButtonType Returns the current close button type. If not explicitly set, returns the default value Default.

Method Parameter Type Mandatory Description
setCloseButtonType(newValue) newValue ButtonType ✅ Yes Sets a custom button type for the close button, overriding the default Default type.

Example

Main.controller.ts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import Controller from "sap/ui/core/mvc/Controller";
import CreateEntry from "ui5/antares/pro/v2/entry/CreateEntry"; // Import the class
import ButtonType from "sap/m/ButtonType"; // Import the ButtonType enum

/**
 * @namespace your.apps.namespace
 */
export default class Main extends Controller {
    public onInit() {

    }

    public async onCreateProduct() {
        const entry = new CreateEntry({
            controller: this, 
            entitySet: "Products",
            closeButtonType: ButtonType.Reject // Override the close button type
        });
    }
}
Main.controller.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "ui5/antares/pro/v2/entry/CreateEntry", // Import the class
    "sap/m/ButtonType" // Import the ButtonType enum
], (Controller, CreateEntry, ButtonType) => {
    "use strict";

    return Controller.extend("your.apps.namespace.Main", {
        onInit: function () {

        },

        onCreateProduct: async function () {
            const entry = new CreateEntry({
                controller: this, 
                entitySet: "Products",
                closeButtonType: ButtonType.Reject // Override the close button type
            });
        }
    });
});