io.jmix.ui.builder

Class ScreenClassBuilder<S extends Screen>

java.lang.Object

io.jmix.ui.builder.ScreenBuilder

io.jmix.ui.builder.ScreenClassBuilder<S>

public class ScreenClassBuilder<S extends Screen>
extends ScreenBuilder

Screen builder that knows the concrete screen class. It's build() method returns that class.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<AfterScreenCloseEvent<S>>	afterCloseListener
protected java.util.function.Consumer<AfterScreenShowEvent<S>>	afterShowListener
protected java.lang.Class<S>	screenClass

Fields inherited from class io.jmix.ui.builder.ScreenBuilder

handler, openMode, options, origin, screenId

Constructor Summary

Constructors

Constructor and Description
ScreenClassBuilder(ScreenBuilder builder, java.lang.Class<S> screenClass)

Method Summary

Modifier and Type	Method and Description
S	build() Builds the screen.
java.util.function.Consumer<AfterScreenCloseEvent<S>>	getAfterCloseListener()
java.util.function.Consumer<AfterScreenShowEvent<S>>	getAfterShowListener()
java.lang.Class<S>	getScreenClass() Returns screen class.
S	show() Builds and shows the editor screen.
ScreenClassBuilder<S>	withAfterCloseListener(java.util.function.Consumer<AfterScreenCloseEvent<S>> listener) Adds Screen.AfterCloseEvent listener to the screen.
ScreenClassBuilder<S>	withAfterShowListener(java.util.function.Consumer<AfterScreenShowEvent<S>> listener) Adds Screen.AfterShowEvent listener to the screen.
ScreenClassBuilder<S>	withOpenMode(OpenMode openMode) Sets OpenMode for the screen and returns the builder for chaining.
ScreenClassBuilder<S>	withOptions(ScreenOptions options) Sets ScreenOptions for the screen and returns the builder for chaining.
ScreenBuilder	withScreenId(java.lang.String screenId) Sets screen id and returns the builder for chaining.

Methods inherited from class io.jmix.ui.builder.ScreenBuilder

getOpenMode, getOptions, getOrigin, getScreenId, withScreenClass

Methods inherited from class java.lang.Object

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

Field Detail

screenClass

protected java.lang.Class<S extends Screen> screenClass

afterShowListener

protected java.util.function.Consumer<AfterScreenShowEvent<S extends Screen>> afterShowListener

afterCloseListener

protected java.util.function.Consumer<AfterScreenCloseEvent<S extends Screen>> afterCloseListener

Constructor Detail

ScreenClassBuilder

public ScreenClassBuilder(ScreenBuilder builder,
                          java.lang.Class<S> screenClass)

Method Detail

withOpenMode

public ScreenClassBuilder<S> withOpenMode(OpenMode openMode)

Description copied from class: ScreenBuilder

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

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

Overrides:

withOpenMode in class ScreenBuilder

withOptions

public ScreenClassBuilder<S> withOptions(ScreenOptions options)

Description copied from class: ScreenBuilder

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

Overrides:

withOptions in class ScreenBuilder

withScreenId

public ScreenBuilder withScreenId(java.lang.String screenId)

Description copied from class: ScreenBuilder

Sets screen id and returns the builder for chaining.

Overrides:

withScreenId in class ScreenBuilder

Parameters:

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

withAfterShowListener

public ScreenClassBuilder<S> withAfterShowListener(java.util.function.Consumer<AfterScreenShowEvent<S>> listener)

Adds Screen.AfterShowEvent listener to the screen.

Parameters:

listener - listener

withAfterCloseListener

public ScreenClassBuilder<S> withAfterCloseListener(java.util.function.Consumer<AfterScreenCloseEvent<S>> listener)

Adds Screen.AfterCloseEvent listener to the screen.

Parameters:

listener - listener

getScreenClass

@Nullable
public java.lang.Class<S> getScreenClass()

Returns screen class.

getAfterShowListener

public java.util.function.Consumer<AfterScreenShowEvent<S>> getAfterShowListener()

Returns:

after show screen listener

getAfterCloseListener

public java.util.function.Consumer<AfterScreenCloseEvent<S>> getAfterCloseListener()

Returns:

after close screen listener

build

public S build()

Description copied from class: ScreenBuilder

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

Overrides:

build in class ScreenBuilder

show

public S show()

Description copied from class: ScreenBuilder

Builds and shows the editor screen.

Overrides:

show in class ScreenBuilder