Package io.jmix.searchflowui.view.result

Class SearchResultsView

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<T>

io.jmix.flowui.view.View<ViewLayout>

io.jmix.flowui.view.StandardView

io.jmix.searchflowui.view.result.SearchResultsView

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, FragmentOwner, Serializable

@Route(value="search/results",
       layout=DefaultMainViewParent.class)
@ViewController("search_SearchResultsView")
@ViewDescriptor("search-results-view.xml")
@DialogMode(width="50em",
            height="42.5em",
            resizable=true)
public class SearchResultsView
extends StandardView

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.view.View

View.AfterCloseEvent, View.BeforeCloseEvent, View.BeforeShowEvent, View.InitEvent, View.QueryParametersChangeEvent, View.ReadyEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
protected DialogWindows	dialogWindows
protected List<String>	entities
protected EntitySearcher	entitySearcher
protected IdSerialization	idSerialization
protected MessageBundle	messageBundle
protected MessageTools	messageTools
protected Metadata	metadata
protected Notifications	notifications
static final String	QUERY_PARAM_ENTITIES
static final String	QUERY_PARAM_SEARCH_BUTTON_VISIBLE
static final String	QUERY_PARAM_SEARCH_SIZE
static final String	QUERY_PARAM_SETTINGS_BUTTON_VISIBLE
static final String	QUERY_PARAM_STRATEGY
static final String	QUERY_PARAM_VALUE
protected boolean	searchButtonVisible
protected SearchFieldContext	searchFieldContext
protected SearchResult	searchResult
protected final com.vaadin.flow.data.renderer.ComponentRenderer<com.vaadin.flow.component.Component,SearchResultEntry>	searchResultRenderer
protected int	searchSize
protected String	searchStrategy
protected boolean	settingsButtonVisible
protected static final Map<String,String>	systemFieldLabels
protected UiComponents	uiComponents
protected String	value
protected ViewNavigators	viewNavigators

Constructor Summary

Constructors

Constructor	Description
SearchResultsView()

Method Summary

Modifier and Type	Method	Description
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)
protected com.vaadin.flow.component.html.Div	createHitDiv(String caption)
protected JmixButton	createInstanceButton(String entityName, SearchResultEntry entry)
protected com.vaadin.flow.component.html.Span	createNoSearchTextSpan()
protected SearchContext	createSearchContext(SearchFieldContext searchFieldContext)
protected SearchContext	createSearchContext(String value, List<String> entities, int size)
protected SearchField	createSearchField(SearchResult searchResult)
protected String	formatFieldCaption(String entityName, String fieldName)
protected void	handleNoSearchText()
protected void	handleSearchResult(SearchResult searchResult)
protected void	initSearchFieldContext()
void	initView(SearchFieldContext searchFieldContext)
protected void	openEntityView(SearchResultEntry entry, String entityName)
protected void	parseQueryParameters(Map<String,List<String>> parameters)
protected Object	reloadEntity(MetaClass metaClass, Object entityId)
protected void	renderResult(SearchResult searchResult)

Methods inherited from class io.jmix.flowui.view.StandardView

initContent

Methods inherited from class io.jmix.flowui.view.View

addAfterCloseListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addQueryParametersChangeListener, addReadyListener, afterNavigation, beforeLeave, close, close, closeWithDefaultAction, getApplicationContext, getId, getPageTitle, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onDetach, onDetachInternal, removeApplicationListeners, removeViewAttributes, setAfterNavigationHandler, setApplicationContext, setId, setMeterRegistry, setPreventBrowserTabClosing, setViewActions, setViewData, setViewFacets, unregisterBackNavigation

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

QUERY_PARAM_VALUE

public static final String QUERY_PARAM_VALUE

See Also:

• Constant Field Values

QUERY_PARAM_ENTITIES

public static final String QUERY_PARAM_ENTITIES

See Also:

• Constant Field Values

QUERY_PARAM_STRATEGY

public static final String QUERY_PARAM_STRATEGY

See Also:

• Constant Field Values

QUERY_PARAM_SEARCH_SIZE

public static final String QUERY_PARAM_SEARCH_SIZE

See Also:

• Constant Field Values

QUERY_PARAM_SEARCH_BUTTON_VISIBLE

public static final String QUERY_PARAM_SEARCH_BUTTON_VISIBLE

See Also:

• Constant Field Values

QUERY_PARAM_SETTINGS_BUTTON_VISIBLE

public static final String QUERY_PARAM_SETTINGS_BUTTON_VISIBLE

See Also:

• Constant Field Values

systemFieldLabels

protected static final Map<String,String> systemFieldLabels

messageBundle

@ViewComponent
protected MessageBundle messageBundle

uiComponents

@Autowired
protected UiComponents uiComponents

dataManager

@Autowired
protected DataManager dataManager

metadata

@Autowired
protected Metadata metadata

messageTools

@Autowired
protected MessageTools messageTools

viewNavigators

@Autowired
protected ViewNavigators viewNavigators

idSerialization

@Autowired
protected IdSerialization idSerialization

entitySearcher

@Autowired
protected EntitySearcher entitySearcher

dialogWindows

@Autowired
protected DialogWindows dialogWindows

notifications

@Autowired
protected Notifications notifications

searchResult

protected SearchResult searchResult

searchStrategy

protected String searchStrategy

entities

protected List<String> entities

searchSize

protected int searchSize

value

protected String value

searchFieldContext

protected SearchFieldContext searchFieldContext

searchButtonVisible

protected boolean searchButtonVisible

settingsButtonVisible

protected boolean settingsButtonVisible

searchResultRenderer

protected final com.vaadin.flow.data.renderer.ComponentRenderer<com.vaadin.flow.component.Component,SearchResultEntry> searchResultRenderer

Constructor Details

SearchResultsView

public SearchResultsView()

Method Details

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

Overrides:

beforeEnter in class View<ViewLayout>

createSearchContext

protected SearchContext createSearchContext(SearchFieldContext searchFieldContext)

createSearchContext

protected SearchContext createSearchContext(String value,
 List<String> entities,
 int size)

initSearchFieldContext

protected void initSearchFieldContext()

parseQueryParameters

protected void parseQueryParameters(Map<String,List<String>> parameters)

initView

public void initView(SearchFieldContext searchFieldContext)

handleSearchResult

protected void handleSearchResult(SearchResult searchResult)

handleNoSearchText

protected void handleNoSearchText()

renderResult

protected void renderResult(SearchResult searchResult)

createNoSearchTextSpan

protected com.vaadin.flow.component.html.Span createNoSearchTextSpan()

createHitDiv

protected com.vaadin.flow.component.html.Div createHitDiv(String caption)

createSearchField

protected SearchField createSearchField(SearchResult searchResult)

createInstanceButton

protected JmixButton createInstanceButton(String entityName,
 SearchResultEntry entry)

openEntityView

protected void openEntityView(SearchResultEntry entry,
 String entityName)

formatFieldCaption

protected String formatFieldCaption(String entityName,
 String fieldName)

reloadEntity

protected Object reloadEntity(MetaClass metaClass,
 Object entityId)