io.jmix.searchui.screen.result

Class SearchResultsScreen

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.searchui.screen.result.SearchResultsScreen

All Implemented Interfaces:

io.jmix.ui.screen.FrameOwner

@UiController(value="search_SearchResults.screen")
 @UiDescriptor(value="search-results-screen.xml")
public class SearchResultsScreen
extends io.jmix.ui.screen.Screen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SearchResultsScreen.Page

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

io.jmix.ui.screen.Screen.AfterCloseEvent, io.jmix.ui.screen.Screen.AfterDetachEvent, io.jmix.ui.screen.Screen.AfterInitEvent, io.jmix.ui.screen.Screen.AfterShowEvent, io.jmix.ui.screen.Screen.BeforeCloseEvent, io.jmix.ui.screen.Screen.BeforeShowEvent, io.jmix.ui.screen.Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.ui.component.ScrollBoxLayout	contentBox
protected SearchResultsScreen.Page	currentPage
protected io.jmix.core.UnconstrainedDataManager	dataManager
protected EntitySearcher	entitySearcher
protected io.jmix.core.IdSerialization	idSerialization
protected io.jmix.core.Messages	messages
protected io.jmix.core.MessageTools	messageTools
protected io.jmix.core.Metadata	metadata
protected io.jmix.ui.component.HBoxLayout	navigationBox
protected io.jmix.ui.Notifications	notifications
protected java.util.Queue<SearchResultsScreen.Page>	pages
static java.lang.String	SCREEN_ID
protected io.jmix.ui.ScreenBuilders	screenBuilders
protected SearchProperties	searchProperties
protected SearchResult	searchResult
protected io.jmix.ui.UiComponents	uiComponents

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
SearchResultsScreen()

Method Summary

Modifier and Type	Method and Description
protected io.jmix.ui.component.CssLayout	createCssLayout()
protected io.jmix.ui.component.Label<java.lang.String>	createEntityLabel(java.lang.String caption)
protected io.jmix.ui.component.Label<java.lang.String>	createHitLabel(java.lang.String caption)
protected io.jmix.ui.component.Button	createInstanceButton(java.lang.String entityName, SearchResultEntry entry)
protected io.jmix.ui.component.Label<java.lang.String>	createNoSearchTextLabel()
protected io.jmix.ui.component.Label<java.lang.String>	createNotFoundLabel()
protected void	displayInstances(SearchResult searchResult, java.lang.String entityName, io.jmix.ui.component.CssLayout instancesLayout)
protected java.lang.String	formatFieldCaption(java.lang.String entityName, java.lang.String fieldName)
protected SearchResultsScreen.Page	getLastPage()
protected void	handleNoSearchText()
protected void	handleSearchResult(SearchResult searchResult)
protected void	initScreenCaption(SearchResult searchResult)
void	onBeforeShow(io.jmix.ui.screen.Screen.BeforeShowEvent event)
protected void	onInstanceClick(java.lang.String entityName, SearchResultEntry entry)
protected void	openEntityWindow(SearchResultEntry entry, java.lang.String entityName, io.jmix.ui.screen.OpenMode openMode, io.jmix.ui.screen.FrameOwner origin)
protected void	openNextPage()
protected void	openPage(SearchResultsScreen.Page page)
protected java.lang.Object	reloadEntity(io.jmix.core.metamodel.model.MetaClass metaClass, java.lang.Object entityId)
protected void	renderNavigationControls(java.util.Queue<SearchResultsScreen.Page> pages)
protected void	renderResult(SearchResultsScreen.Page page)
SearchResultsScreen	setSearchResult(SearchResult searchResult)

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object

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

Field Detail

SCREEN_ID

public static final java.lang.String SCREEN_ID

See Also:

Constant Field Values

uiComponents

@Autowired
protected io.jmix.ui.UiComponents uiComponents

metadata

@Autowired
protected io.jmix.core.Metadata metadata

messages

@Autowired
protected io.jmix.core.Messages messages

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

screenBuilders

@Autowired
protected io.jmix.ui.ScreenBuilders screenBuilders

dataManager

@Autowired
protected io.jmix.core.UnconstrainedDataManager dataManager

searchProperties

@Autowired
protected SearchProperties searchProperties

entitySearcher

@Autowired
protected EntitySearcher entitySearcher

notifications

@Autowired
protected io.jmix.ui.Notifications notifications

idSerialization

@Autowired
protected io.jmix.core.IdSerialization idSerialization

contentBox

@Autowired
protected io.jmix.ui.component.ScrollBoxLayout contentBox

navigationBox

@Autowired
protected io.jmix.ui.component.HBoxLayout navigationBox

currentPage

protected SearchResultsScreen.Page currentPage

pages

protected java.util.Queue<SearchResultsScreen.Page> pages

searchResult

protected SearchResult searchResult

Constructor Detail

SearchResultsScreen

public SearchResultsScreen()

Method Detail

onBeforeShow

@Subscribe
public void onBeforeShow(io.jmix.ui.screen.Screen.BeforeShowEvent event)

setSearchResult

public SearchResultsScreen setSearchResult(SearchResult searchResult)

initScreenCaption

protected void initScreenCaption(SearchResult searchResult)

handleSearchResult

protected void handleSearchResult(SearchResult searchResult)

handleNoSearchText

protected void handleNoSearchText()

renderResult

protected void renderResult(SearchResultsScreen.Page page)

renderNavigationControls

protected void renderNavigationControls(java.util.Queue<SearchResultsScreen.Page> pages)

openPage

protected void openPage(SearchResultsScreen.Page page)

openNextPage

protected void openNextPage()

getLastPage

protected SearchResultsScreen.Page getLastPage()

createCssLayout

protected io.jmix.ui.component.CssLayout createCssLayout()

createNoSearchTextLabel

protected io.jmix.ui.component.Label<java.lang.String> createNoSearchTextLabel()

createNotFoundLabel

protected io.jmix.ui.component.Label<java.lang.String> createNotFoundLabel()

createEntityLabel

protected io.jmix.ui.component.Label<java.lang.String> createEntityLabel(java.lang.String caption)

displayInstances

protected void displayInstances(SearchResult searchResult,
                                java.lang.String entityName,
                                io.jmix.ui.component.CssLayout instancesLayout)

formatFieldCaption

protected java.lang.String formatFieldCaption(java.lang.String entityName,
                                              java.lang.String fieldName)

createInstanceButton

protected io.jmix.ui.component.Button createInstanceButton(java.lang.String entityName,
                                                           SearchResultEntry entry)

createHitLabel

protected io.jmix.ui.component.Label<java.lang.String> createHitLabel(java.lang.String caption)

onInstanceClick

protected void onInstanceClick(java.lang.String entityName,
                               SearchResultEntry entry)

openEntityWindow

protected void openEntityWindow(SearchResultEntry entry,
                                java.lang.String entityName,
                                io.jmix.ui.screen.OpenMode openMode,
                                io.jmix.ui.screen.FrameOwner origin)

reloadEntity

protected java.lang.Object reloadEntity(io.jmix.core.metamodel.model.MetaClass metaClass,
                                        java.lang.Object entityId)