Package io.jmix.searchui.screen.result

Class SearchResultsScreen

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.searchui.screen.result.SearchResultsScreen

All Implemented Interfaces:

FrameOwner

@UiController("search_SearchResults.screen")
@UiDescriptor("search-results-screen.xml")
public class SearchResultsScreen
extends Screen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SearchResultsScreen.Page

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

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected ScrollBoxLayout	contentBox
protected SearchResultsScreen.Page	currentPage
protected UnconstrainedDataManager	dataManager
protected EntitySearcher	entitySearcher
protected IdSerialization	idSerialization
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected HBoxLayout	navigationBox
protected Notifications	notifications
protected Queue<SearchResultsScreen.Page>	pages
static final String	SCREEN_ID
protected ScreenBuilders	screenBuilders
protected SearchProperties	searchProperties
protected SearchResult	searchResult
protected 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	Description
SearchResultsScreen()

Method Summary

Modifier and Type	Method	Description
protected CssLayout	createCssLayout()
protected Label<String>	createEntityLabel(String caption)
protected Label<String>	createHitLabel(String caption)
protected Button	createInstanceButton(String entityName, SearchResultEntry entry)
protected Label<String>	createNoSearchTextLabel()
protected Label<String>	createNotFoundLabel()
protected void	displayInstances(SearchResult searchResult, String entityName, CssLayout instancesLayout)
protected String	formatFieldCaption(String entityName, String fieldName)
protected SearchResultsScreen.Page	getLastPage()
protected void	handleNoSearchText()
protected void	handleSearchResult(SearchResult searchResult)
protected void	initScreenCaption(SearchResult searchResult)
void	onBeforeShow(Screen.BeforeShowEvent event)
protected void	onInstanceClick(String entityName, SearchResultEntry entry)
protected void	openEntityWindow(SearchResultEntry entry, String entityName, OpenMode openMode, FrameOwner origin)
protected void	openNextPage()
protected void	openPage(SearchResultsScreen.Page page)
protected Object	reloadEntity(MetaClass metaClass, Object entityId)
protected void	renderNavigationControls(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 Details

SCREEN_ID

public static final String SCREEN_ID

See Also:

• Constant Field Values

uiComponents

@Autowired
protected UiComponents uiComponents

metadata

@Autowired
protected Metadata metadata

messages

@Autowired
protected Messages messages

messageTools

@Autowired
protected MessageTools messageTools

screenBuilders

@Autowired
protected ScreenBuilders screenBuilders

dataManager

@Autowired
protected UnconstrainedDataManager dataManager

searchProperties

@Autowired
protected SearchProperties searchProperties

entitySearcher

@Autowired
protected EntitySearcher entitySearcher

notifications

@Autowired
protected Notifications notifications

idSerialization

@Autowired
protected IdSerialization idSerialization

contentBox

@Autowired
protected ScrollBoxLayout contentBox

navigationBox

@Autowired
protected HBoxLayout navigationBox

currentPage

protected SearchResultsScreen.Page currentPage

pages

protected Queue<SearchResultsScreen.Page> pages

searchResult

protected SearchResult searchResult

Constructor Details

SearchResultsScreen

public SearchResultsScreen()

Method Details

onBeforeShow

@Subscribe
public void onBeforeShow(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(Queue<SearchResultsScreen.Page> pages)

openPage

protected void openPage(SearchResultsScreen.Page page)

openNextPage

protected void openNextPage()

getLastPage

@Nullable
protected SearchResultsScreen.Page getLastPage()

createCssLayout

protected CssLayout createCssLayout()

createNoSearchTextLabel

protected Label<String> createNoSearchTextLabel()

createNotFoundLabel

protected Label<String> createNotFoundLabel()

createEntityLabel

protected Label<String> createEntityLabel(String caption)

displayInstances

protected void displayInstances(SearchResult searchResult,
 String entityName,
 CssLayout instancesLayout)

formatFieldCaption

protected String formatFieldCaption(String entityName,
 String fieldName)

createInstanceButton

protected Button createInstanceButton(String entityName,
 SearchResultEntry entry)

createHitLabel

protected Label<String> createHitLabel(String caption)

onInstanceClick

protected void onInstanceClick(String entityName,
 SearchResultEntry entry)

openEntityWindow

protected void openEntityWindow(SearchResultEntry entry,
 String entityName,
 OpenMode openMode,
 FrameOwner origin)

reloadEntity

protected Object reloadEntity(MetaClass metaClass,
 Object entityId)