Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui.component

Interface EntitySearchFieldPanel.Builder<T,B extends EntitySearchFieldPanel.Builder<T,B>>

All Superinterfaces:

ComponentBuilder<T,EntitySearchFieldPanel,B>

All Known Subinterfaces:

EntitySearchFieldPanel.MultiSelectionBuilder, EntitySearchFieldPanel.SingleSelectionBuilder

Enclosing class:

EntitySearchFieldPanel

public static interface EntitySearchFieldPanel.Builder<T,B extends EntitySearchFieldPanel.Builder<T,B>>
extends ComponentBuilder<T,EntitySearchFieldPanel,B>

A builder for a EntitySearchFieldPanel

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntitySearchFieldPanel.Builder.Factory	Provides multi or single selection EntitySearchFieldPanel.Builder instances

Field Summary

Fields inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

COMPONENT_VALUE, TRANSFER_FOCUS_ON_ENTER

Method Summary

Modifier and Type	Method	Description
EntitySearchFieldPanel	build()	Builds a new component instance.
EntitySearchFieldPanel.Builder<T,B>	buttonLocation(String buttonLocation)	Must be one of BorderLayout.WEST or BorderLayout.EAST
EntitySearchFieldPanel.Builder<T,B>	buttonsFocusable(boolean buttonsFocusable)	Default false
EntitySearchFieldPanel.Builder<T,B>	columns(int columns)
EntitySearchFieldPanel.Builder<T,B>	confirmAdd(boolean confirmAdd)
EntitySearchFieldPanel.Builder<T,B>	confirmEdit(boolean confirmEdit)
EntitySearchFieldPanel.Builder<T,B>	editable(boolean editable)
EntitySearchFieldPanel.Builder<T,B>	includeAddButton(boolean includeAddButton)
EntitySearchFieldPanel.Builder<T,B>	includeEditButton(boolean includeEditButton)
EntitySearchFieldPanel.Builder<T,B>	includeSearchButton(boolean includeSearchButton)
EntitySearchFieldPanel.Builder<T,B>	limit(int limit)
EntitySearchFieldPanel.Builder<T,B>	lowerCase(boolean lowerCase)	Makes the field convert all upper case input to lower case
EntitySearchFieldPanel.Builder<T,B>	searchHintEnabled(boolean searchHintEnabled)
EntitySearchFieldPanel.Builder<T,B>	searchIndicator(EntitySearchField.SearchIndicator searchIndicator)
EntitySearchFieldPanel.Builder<T,B>	searchOnFocusLost(boolean searchOnFocusLost)
EntitySearchFieldPanel.Builder<T,B>	selectorFactory(Function<EntitySearchModel,EntitySearchField.Selector> selectorFactory)
EntitySearchFieldPanel.Builder<T,B>	upperCase(boolean upperCase)	Makes the field convert all lower case input to upper case

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

background, border, build, buildValue, buildValue, clientProperty, componentListener, componentOrientation, consumer, enabled, enabled, focusable, focusCycleRoot, focusListener, font, foreground, keyEvent, keyListener, label, link, link, listener, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onBuildValue, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, transferFocusOnEnter, transferHandler, validator, value, visible

Method Details

includeSearchButton

EntitySearchFieldPanel.Builder<T,B> includeSearchButton(boolean includeSearchButton)

Parameters:

includeSearchButton - true if a search button should be included

Returns:

this builder instance

includeAddButton

EntitySearchFieldPanel.Builder<T,B> includeAddButton(boolean includeAddButton)

Parameters:

includeAddButton - true if a 'Add' button should be included

Returns:

this builder instance

Throws:

IllegalStateException - in case no edit panel supplier is available

See Also:

• EntitySearchFieldPanel.builder(EntitySearchModel, Supplier)

includeEditButton

EntitySearchFieldPanel.Builder<T,B> includeEditButton(boolean includeEditButton)

Parameters:

includeEditButton - true if a 'Edit' button should be included

Returns:

this builder instance

Throws:

IllegalStateException - in case no edit panel supplier is available

See Also:

• EntitySearchFieldPanel.builder(EntitySearchModel, Supplier)

confirmAdd

EntitySearchFieldPanel.Builder<T,B> confirmAdd(boolean confirmAdd)

Parameters:

confirmAdd - true if adding an item should be confirmed

Returns:

this builder instance

confirmEdit

EntitySearchFieldPanel.Builder<T,B> confirmEdit(boolean confirmEdit)

Parameters:

confirmEdit - true if editing an item should be confirmed

Returns:

this builder instance

buttonsFocusable

EntitySearchFieldPanel.Builder<T,B> buttonsFocusable(boolean buttonsFocusable)

Default false

Parameters:

buttonsFocusable - true if the buttons should be focusable

Returns:

this builder instance

buttonLocation

EntitySearchFieldPanel.Builder<T,B> buttonLocation(String buttonLocation)

Must be one of BorderLayout.WEST or BorderLayout.EAST

Parameters:

buttonLocation - the button location

Returns:

this builder instance

Throws:

IllegalArgumentException - in case the value is not one of BorderLayout.WEST or BorderLayout.EAST

columns

EntitySearchFieldPanel.Builder<T,B> columns(int columns)

Parameters:

columns - the number of colums in the text field

Returns:

this builder instance

upperCase

EntitySearchFieldPanel.Builder<T,B> upperCase(boolean upperCase)

Makes the field convert all lower case input to upper case

Parameters:

upperCase - if true the text component convert all lower case input to upper case

Returns:

this builder instance

lowerCase

EntitySearchFieldPanel.Builder<T,B> lowerCase(boolean lowerCase)

Makes the field convert all upper case input to lower case

Parameters:

lowerCase - if true the text component convert all upper case input to lower case

Returns:

this builder instance

editable

EntitySearchFieldPanel.Builder<T,B> editable(boolean editable)

Parameters:

editable - false if the field should not be editable

Returns:

this builder instance

searchHintEnabled

EntitySearchFieldPanel.Builder<T,B> searchHintEnabled(boolean searchHintEnabled)

Parameters:

searchHintEnabled - true if a search hint text should be visible when the field is empty and not focused

Returns:

this builder instance

searchOnFocusLost

EntitySearchFieldPanel.Builder<T,B> searchOnFocusLost(boolean searchOnFocusLost)

Parameters:

searchOnFocusLost - true if search should be performed on focus lost

Returns:

this builder instance

searchIndicator

EntitySearchFieldPanel.Builder<T,B> searchIndicator(EntitySearchField.SearchIndicator searchIndicator)

Parameters:

searchIndicator - the search indicator

Returns:

this builder instance

selectorFactory

EntitySearchFieldPanel.Builder<T,B> selectorFactory(Function<EntitySearchModel,EntitySearchField.Selector> selectorFactory)

Parameters:

selectorFactory - the selector factory to use

Returns:

this builder instance

limit

EntitySearchFieldPanel.Builder<T,B> limit(int limit)

Parameters:

limit - the search result limit

Returns:

this builder instance

build

EntitySearchFieldPanel build()

Description copied from interface: ComponentBuilder

Builds a new component instance.

Specified by:

build in interface ComponentBuilder<T,EntitySearchFieldPanel,B extends EntitySearchFieldPanel.Builder<T,B>>

Returns:

a new EntitySearchFieldPanel based on this builder