com.haulmont.cuba.gui.model

Interface ScreenData

All Known Implementing Classes:

ScreenDataImpl

public interface ScreenData

Interface defining methods for interacting with data API elements of a screen.

Method Summary

Modifier and Type	Method and Description
<T extends InstanceContainer> T	getContainer(java.lang.String id) Returns a container by its id.
java.util.Set<java.lang.String>	getContainerIds() Returns ids of all registered containers.
DataContext	getDataContext() Returns screen's DataContext.
LoadBeforeShowStrategy	getLoadBeforeShowStrategy() Returns a strategy to load data before showing the screen.
<T extends DataLoader> T	getLoader(java.lang.String id) Returns a loader by its id.
java.util.Set<java.lang.String>	getLoaderIds() Returns ids of all registered loaders.
void	loadAll() Performs DataLoader.load() for all loaders registered in the screen.
void	registerContainer(java.lang.String id, InstanceContainer container) Registers the given container in the screen.
void	registerLoader(java.lang.String id, DataLoader loader) Registers the given loader in the screen.
void	setDataContext(DataContext dataContext) Sets DataContext instance for the screen.
void	setLoadBeforeShowStrategy(LoadBeforeShowStrategy strategy) Sets a strategy to load data before showing the screen.

Method Detail

getDataContext

DataContext getDataContext()

Returns screen's DataContext.

setDataContext

void setDataContext(DataContext dataContext)

Sets DataContext instance for the screen.

getLoadBeforeShowStrategy

LoadBeforeShowStrategy getLoadBeforeShowStrategy()

Returns a strategy to load data before showing the screen.

setLoadBeforeShowStrategy

void setLoadBeforeShowStrategy(LoadBeforeShowStrategy strategy)

Sets a strategy to load data before showing the screen.

loadAll

void loadAll()

Performs DataLoader.load() for all loaders registered in the screen.

getContainer

<T extends InstanceContainer> T getContainer(java.lang.String id)

Returns a container by its id.

Throws:

java.lang.IllegalArgumentException - if there is no such container in the screen

getLoader

<T extends DataLoader> T getLoader(java.lang.String id)

Returns a loader by its id.

Throws:

java.lang.IllegalArgumentException - if there is no such loader in the screen

getContainerIds

java.util.Set<java.lang.String> getContainerIds()

Returns ids of all registered containers.

getLoaderIds

java.util.Set<java.lang.String> getLoaderIds()

Returns ids of all registered loaders.

registerContainer

void registerContainer(java.lang.String id,
                       InstanceContainer container)

Registers the given container in the screen.

registerLoader

void registerLoader(java.lang.String id,
                    DataLoader loader)

Registers the given loader in the screen.