com.haulmont.cuba.gui.builders

Class ScreenClassBuilder<S extends Screen>

java.lang.Object

com.haulmont.cuba.gui.builders.ScreenBuilder

com.haulmont.cuba.gui.builders.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>>	closeListener
protected java.lang.Class<S>	screenClass

Fields inherited from class com.haulmont.cuba.gui.builders.ScreenBuilder

handler, launchMode, 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>>	getCloseListener() Returns screen close listener.
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>	withLaunchMode(Screens.LaunchMode launchMode) Sets Screens.LaunchMode for the screen and returns the builder for chaining.
ScreenClassBuilder<S>	withOpenMode(OpenMode openMode) Sets Screens.LaunchMode 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.
ScreenClassBuilder<S>	withScreenId(java.lang.String screenId) Sets screen id and returns the builder for chaining.

Methods inherited from class com.haulmont.cuba.gui.builders.ScreenBuilder

getLaunchMode, 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

closeListener

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

Constructor Detail

ScreenClassBuilder

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

Method Detail

withLaunchMode

public ScreenClassBuilder<S> withLaunchMode(Screens.LaunchMode launchMode)

Description copied from class: ScreenBuilder

Sets Screens.LaunchMode for the screen and returns the builder for chaining.

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

Overrides:

withLaunchMode in class ScreenBuilder

withOpenMode

public ScreenClassBuilder<S> withOpenMode(OpenMode openMode)

Description copied from class: ScreenBuilder

Sets Screens.LaunchMode 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 ScreenClassBuilder<S> 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.

withAfterCloseListener

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

Adds Screen.AfterCloseEvent listener to the screen.

Parameters:

listener - listener

getScreenClass

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

Returns screen class.

getCloseListener

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

Returns screen close 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