Package io.jmix.ui.builder

Class ScreenBuilder

java.lang.Object

io.jmix.ui.builder.ScreenBuilder

Direct Known Subclasses:

ScreenClassBuilder

public class ScreenBuilder
extends Object

Screen builder that is not aware of concrete screen class. It's build() method returns Screen.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Function<ScreenBuilder,Screen>	handler
protected OpenMode	openMode
protected ScreenOptions	options
protected final FrameOwner	origin
protected String	screenId

Constructor Summary

Constructors

Constructor	Description
ScreenBuilder(ScreenBuilder builder)
ScreenBuilder(FrameOwner origin, Function<ScreenBuilder,Screen> handler)

Method Summary

Modifier and Type	Method	Description
Screen	build()	Builds the screen.
OpenMode	getOpenMode()	Returns open mode set by withOpenMode(OpenMode).
ScreenOptions	getOptions()	Returns screen options set by withOptions(ScreenOptions).
FrameOwner	getOrigin()
String	getScreenId()	Returns screen id set by withScreenId(String).
Screen	show()	Builds and shows the editor screen.
ScreenBuilder	withOpenMode(OpenMode openMode)	Sets OpenMode for the screen and returns the builder for chaining.
ScreenBuilder	withOptions(ScreenOptions options)	Sets ScreenOptions for the screen and returns the builder for chaining.
<S extends Screen> ScreenClassBuilder<S>	withScreenClass(Class<S> screenClass)	Sets screen class and returns the EditorClassBuilder for chaining.
ScreenBuilder	withScreenId(String screenId)	Sets screen id and returns the builder for chaining.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

origin

protected final FrameOwner origin

handler

protected final Function<ScreenBuilder,Screen> handler

openMode

protected OpenMode openMode

options

protected ScreenOptions options

screenId

protected String screenId

Constructor Details

ScreenBuilder

public ScreenBuilder(ScreenBuilder builder)

ScreenBuilder

public ScreenBuilder(FrameOwner origin,
 Function<ScreenBuilder,Screen> handler)

Method Details

withOpenMode

public ScreenBuilder withOpenMode(OpenMode openMode)

Sets OpenMode for the screen and returns the builder for chaining.

For example: builder.withOpenMode(OpenMode.DIALOG).build();

withScreenId

public ScreenBuilder withScreenId(String screenId)

Sets screen id and returns the builder for chaining.

Parameters:

screenId - identifier of the screen as specified in the UiController annotation or screens.xml.

withOptions

public ScreenBuilder withOptions(ScreenOptions options)

Sets ScreenOptions for the screen and returns the builder for chaining.

withScreenClass

public <S extends Screen> ScreenClassBuilder<S> withScreenClass(Class<S> screenClass)

Sets screen class and returns the EditorClassBuilder for chaining.

Parameters:

screenClass - class of the screen controller

getOrigin

public FrameOwner getOrigin()

getOpenMode

public OpenMode getOpenMode()

Returns open mode set by withOpenMode(OpenMode).

getOptions

public ScreenOptions getOptions()

Returns screen options set by withOptions(ScreenOptions).

getScreenId

@Nullable
public String getScreenId()

Returns screen id set by withScreenId(String).

build

public Screen build()

Builds the screen. Screen should be shown using Screen.show().

show

public Screen show()

Builds and shows the editor screen.