Package io.jmix.ui

Class WindowInfo

java.lang.Object

io.jmix.ui.WindowInfo

Direct Known Subclasses:

WindowConfig.ResolvedWindowInfo

public class WindowInfo
extends Object

Screen's registration information.

See Also:

• WindowConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowInfo.Type	Type of registered controller.

Constructor Summary

Constructors

Modifier	Constructor	Description
	WindowInfo(String id, WindowAttributesProvider windowAttributesProvider, String screenClassName, RouteDefinition routeDefinition)
	WindowInfo(String id, WindowAttributesProvider windowAttributesProvider, org.dom4j.Element descriptor)
	WindowInfo(String id, WindowAttributesProvider windowAttributesProvider, org.dom4j.Element descriptor, RouteDefinition routeDefinition)
protected	WindowInfo(String id, WindowAttributesProvider windowAttributesProvider, org.dom4j.Element descriptor, String screenClassName, RouteDefinition routeDefinition)

Method Summary

Modifier and Type	Method	Description
Class<? extends ScreenFragment>	asFragment()
Class<? extends Screen>	asScreen()
Class<? extends FrameOwner>	getControllerClass()
String	getControllerClassName()	Screen class as set in screens.xml
org.dom4j.Element	getDescriptor()	The whole XML element of the screen as set in screens.xml
String	getId()	Screen ID as set in screens.xml
RouteDefinition	getRouteDefinition()
String	getTemplate()	Screen template path as set in screens.xml
WindowInfo.Type	getType()
WindowInfo	resolve()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

WindowInfo

protected WindowInfo(String id,
 @Nullable
 WindowAttributesProvider windowAttributesProvider,
 @Nullable
 org.dom4j.Element descriptor,
 @Nullable
 String screenClassName,
 @Nullable
 RouteDefinition routeDefinition)

WindowInfo

public WindowInfo(String id,
 WindowAttributesProvider windowAttributesProvider,
 org.dom4j.Element descriptor)

WindowInfo

public WindowInfo(String id,
 WindowAttributesProvider windowAttributesProvider,
 org.dom4j.Element descriptor,
 @Nullable
 RouteDefinition routeDefinition)

WindowInfo

public WindowInfo(String id,
 WindowAttributesProvider windowAttributesProvider,
 String screenClassName,
 @Nullable
 RouteDefinition routeDefinition)

Method Details

getId

public String getId()

Screen ID as set in screens.xml

getType

public WindowInfo.Type getType()

Returns:

type of registered window: SCREEN or FRAGMENT

resolve

public WindowInfo resolve()

Returns:

detached window info instance

getControllerClass

public Class<? extends FrameOwner> getControllerClass()

asScreen

public Class<? extends Screen> asScreen()

asFragment

public Class<? extends ScreenFragment> asFragment()

getDescriptor

@Nullable
public org.dom4j.Element getDescriptor()

The whole XML element of the screen as set in screens.xml

getControllerClassName

@Nullable
public String getControllerClassName()

Screen class as set in screens.xml

Returns:

screen class name

getTemplate

@Nullable
public String getTemplate()

Screen template path as set in screens.xml

Returns:

screen template path

getRouteDefinition

@Nullable
public RouteDefinition getRouteDefinition()

Returns:

route definition configured with Route annotation

toString

public String toString()

Overrides:

toString in class Object