Package com.persequor.extension.frontend

Interface IPage

All Superinterfaces:
IContent<ISection>, IHasAttributes<ISection>, IHasId<ISection>, ISection
public interface IPage extends ISection
This is used to compose a page or a Vertical Container component with a series of sub-components like forms, tables, graphs, etc.

  • Method Details

    • form

      void form(Consumer<IForm> consumer)
      Add a form to the page or Vertical Container.

      Forms can contain fields of different types and the form will be posted to the IFrontendComponent.handle(IPage, IInputData) method.

      Parameters:
      consumer - to populate the form

    • form

      void form(IInputData inputData, Consumer<IForm> consumer)
      Add a form to the page or Vertical Container.

      Forms can contain fields of different types and the form will be posted to the IFrontendComponent.handle(IPage, IInputData) method.

      Parameters:
      inputData - data to populate form fields with
      consumer - to populate the form

    • form

      void form(Props props, IInputData inputData, Consumer<IForm> consumer)
      Add a form to the page or Vertical Container.

      Forms can contain fields of different types and the form will be posted to the IFrontendComponent.handle(IPage, IInputData) method.

      Parameters:
      props - the layout properties for the form
      inputData - data to populate form fields with
      consumer - to populate the form

    • table

      void table(Consumer<ITable> consumer)
      Add a table to the page or Vertical Container.

      Tables are defined by adding rows to the consumer, and columns to the nested consumers.

      Parameters:
      consumer - to populate the table

    • table

      void table(IInputData inputData, Consumer<ITable> consumer)
      Add a table to the page or Vertical Container.

      Tables are defined by adding rows to the consumer, and columns to the nested consumers.

      Parameters:
      consumer - to populate the table
      inputData - to update the current state of the table

    • eventsTable

      void eventsTable(IInputData inputData, Consumer<IEventsTable> consumer)
      Will add an event table like the one used on core SAGA UI pages, with the possibility to enable server side pagination.
      Parameters:
      inputData - to update the current state of the table
      consumer - to populate the table

    • eventsTable

      void eventsTable(EventList events)
      Will add an event table like the one used on core SAGA UI pages.
      Parameters:
      events - to populate the table with

    • eventsTable

      void eventsTable(EventList events, boolean withExtensions, boolean withListExtensions, boolean skipRefetchOnOpen)
      Will add an event table like the one used on core SAGA UI pages.
      Parameters:
      events - to populate the table with
      withExtensions - enrich events with event extensions, EPC enrichment and revert status. This defaults to false and is normally only done when fetching an individual event.
      withListExtensions - enrich events with list extensions
      skipRefetchOnOpen - skip refetching event when viewing details

    • eventsTable

      void eventsTable(List<UUID> sagaEventIds)
      Will add an event table like the one used on core SAGA UI pages. Providing Event IDs will make the UI fetch the events from the backend.
      Parameters:
      sagaEventIds - to populate the table with

    • timeline

      void timeline(Consumer<ITimeline> consumer)
      Parameters:
      consumer - to add components to the timeline

    • redirect

      void redirect(RedirectableLink to)
      Will redirect the user to another URL.
      Parameters:
      to - target

    • redirect

      void redirect(RedirectableLink to, int delay)

    • toast

      void toast(ToastType variant, String message)
      Add a message toast that will pop up on the screen after it gets refreshed by specifying the message and the variant (success, error, warning, info)
      Parameters:
      variant - Type of toast
      message - Message in toast

    • toast

      void toast(ToastType variant, IString message)
      Add a message toast that will pop up on the screen after it gets refreshed by specifying the message and the variant (success, error, warning, info)
      Parameters:
      variant - Type of toast
      message - Message in toast

    • alert

      void alert(AlertType severity, IString title, IString message)
      Add an alert message on the page
      Parameters:
      severity - Type of message
      title - Title of message
      message - Message text

    • alert

      void alert(AlertType severity, IString message)
      Add an alert message on the page
      Parameters:
      severity - Type of message
      message - Message text

    • alert

      void alert(AlertType severity, String title, String message)
      Add an alert message on the page
      Parameters:
      severity - Type of message
      title - Title of message
      message - Message text

    • alert

      void alert(AlertType severity, String message)
      Add an alert message on the page
      Parameters:
      severity - Type of message
      message - Message text

    • section

      void section(Props props, Consumer<ISection> consumer)
      Add a visible section containing other elements
      Specified by:
      section in interface IContent<ISection>
      Parameters:
      props - The grid width the box should have and the justify property of the content, use this to place boxes next to each other
      consumer - The content

    • section

      void section(Consumer<ISection> consumer)
      Add a visible section containing other elements
      Specified by:
      section in interface IContent<ISection>
      Parameters:
      consumer - The content

    • accordion

      void accordion(Consumer<IAccordion> consumer)
      Add an accordion element displaying components in foldable panels
      Parameters:
      consumer - The content

    • getOnLoad

      @Deprecated @Experimental List<PageOnLoadAction> getOnLoad()
      Deprecated.
      Client side scripting when page is loaded.
      Returns:
      the list of client side actions to be carried out when the page is loaded.