io.jmix.ui

Interface Fragments

All Known Implementing Classes:

FragmentsImpl

public interface Fragments

Interface defining methods for creation and displaying of reusable screen parts that have their own UI controller.
Usage example (this - Screen controller):

    Fragment editorActions = fragments.create(this, EditorActionsFragment.class)
             .init()
             .getFragment();

    this.getWindow().add(editorActions);
 

Method Summary

Modifier and Type	Method and Description
default <T extends ScreenFragment> T	create(FrameOwner parent, java.lang.Class<T> screenFragmentClass) Creates a screen fragment by its controller class.
<T extends ScreenFragment> T	create(FrameOwner parent, java.lang.Class<T> screenFragmentClass, ScreenOptions options) Creates a screen fragment by its controller class.
default ScreenFragment	create(FrameOwner parent, java.lang.String screenFragmentId) Creates a screen fragment by its id.
ScreenFragment	create(FrameOwner parent, java.lang.String screenFragmentId, ScreenOptions options) Creates a screen fragment by its id.
void	init(ScreenFragment fragment) Perform fragment initialization.

Method Detail

create

default <T extends ScreenFragment> T create(FrameOwner parent,
                                            java.lang.Class<T> screenFragmentClass)

Creates a screen fragment by its controller class.

Parameters:

parent - parent UI controller

screenFragmentClass - screen controller class

create

default ScreenFragment create(FrameOwner parent,
                              java.lang.String screenFragmentId)

Creates a screen fragment by its id.

Parameters:

parent - parent UI controller

screenFragmentId - id of screen fragment

create

<T extends ScreenFragment> T create(FrameOwner parent,
                                    java.lang.Class<T> screenFragmentClass,
                                    ScreenOptions options)

Creates a screen fragment by its controller class.

Parameters:

parent - parent UI controller

screenFragmentClass - screen controller class

options - screen parameters

create

ScreenFragment create(FrameOwner parent,
                      java.lang.String screenFragmentId,
                      ScreenOptions options)

Creates a screen fragment by its id.

Parameters:

parent - parent UI controller

screenFragmentId - id of screen fragment

options - screen parameters

init

void init(ScreenFragment fragment)

Perform fragment initialization. Clients must always perform init.

Parameters:

fragment - fragment