Logo

    Home

    Documentation

    Use Cases

    Training

    Applications

    Release Notes

    Screen

    Screen

    • Description
    • Windows
    • Dialogs
    • Frames
    • Layout
    • Panel
    • How to use it
    • 1. Create the Object
    • 2. Select Layout Pattern
    • Attributes

    Description

    Screens are containers that are used to place and organise other B1 Objects inside (e.g. FormsForms , Grid / TableGrid / Table) in a specific layout. There are three types of screens in Build.One.

    Windows

    Windows are handled in B1 with the SwatWindows object. sUsers can resize SwatWindows, minimise them or lose the focus of them (click outside)

    Dialogs

    Dialogs are handled in B1 with the SwatDialog object. Users can resize SwatDialogs, minimise them but no lose the focus of them (click outside)

    Frames

    FrameFrame screen type is handled in B1 with the SwatFrame object. SwatFrame can not be launch alone, instead they can be placed inside other Screens to generate complex Layouts

    Layout

    Every Screen has a Layout. Layouts define the structure of a Screen. This means they specify the number of Panels contained in the Layout, and the way they are arranged.

    Panel

    Every space in the layout is filled with a Panel, which can contain objects like Grids or Forms. Also a Panel can contain a FrameFrame with its own layout which allow any configuration of screen structure that is no possible with the Layout of a single Screen. Each panel can have a title, can be resized and can be collapsed.

    Example of a Screen with a Layout of 2 panels side by side
    Example of a Screen with a Layout of 2 panels side by side

    How to use it

    1. Create the Object

    Screens can be created in the Design > Screens section of the sidebar. Using the Create Button will show the Screen Creation Dialog. In this screen, the basic attributes like name, description or module can be defined on the left. And on the right panel there is the option to select which type of screen needs to be created or select a template already defined.

    Screen Creation Dialog
    Screen Creation Dialog
    icon
    SwatWindows can be used as desktops or as “Windows” with a task in the taskbar. That depends on how you define the menu function for launching a screen.

    2. Select Layout Pattern

    The number of panels and its organisation is defined with the Layout of the Screen. This attribute can be defined easily with the second tab of the attributes panel, where a select field will display the options available.

    image
    icon
    If you don’t know the layout designs, you can review them visually by clicking in the search icon of the field to display a dialog with all the options available.
    image

    Now you can specify the content for every panel just by dragging and dropping the desired object from the catalogue of objects

    icon
    Dynamic Content in the title

    For the attributes “Title” and “Short title” you can define static text and dynamic content. For the dynamic content use double curly brackets {{}}. You have access to all data which will be provided by a used BusinessEntity, for example: “Customer {{cust_no}} - {{cust_name}}”

    icon
    Renaming Screens

    When renaming screens, make sure to delete manually the old .smartrepo and .svg files in the development environment. These can be found here: /workspace/[REPO_NAME]/src/data/repository/[MODULE]

    When not deleting them, it may happen that the old (not renamed version) will be displayed in the screen overview

    This is a known issue and already placed in our internal backlog to optimize this process in the future

    Attributes

    Attribute
    Description
    Example/Values
    icon
    Defines the small icon that is shown in the header next to the title based on Font Awesome.
    fad fa-starfighter
    Layout
    Defines the arrangements of visual objects within the window
    1C, 2E, 2U...
    Title
    Defines the title of the window that is shown in the header (regardless of name of object).
    “Customer Profil”
    titleShort
    Define the title which will be shown in the taskbar when the screen is opened as a window.
    HasChangesTrackingEnabled
    The Border and the task will be highlighted when making changes within the screen
    True/False

    Back to DocumentationDocumentation

    Back to Home Page

    Logo