Module is.codion.swing.framework.ui

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

Interface EntitySearchFieldPanel.Builder

All Superinterfaces:

ComponentBuilder<Entity,EntitySearchFieldPanel,EntitySearchFieldPanel.Builder>

Enclosing class:

EntitySearchFieldPanel

public static interface EntitySearchFieldPanel.Builder
extends ComponentBuilder<Entity,EntitySearchFieldPanel,EntitySearchFieldPanel.Builder>

A builder for a EntitySearchFieldPanel

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	buttonLocation(String buttonLocation)	Must be one of BorderLayout.WEST or BorderLayout.EAST
EntitySearchFieldPanel.Builder	buttonsFocusable(boolean buttonsFocusable)	Default false
EntitySearchFieldPanel.Builder	columns(int columns)
EntitySearchFieldPanel.Builder	confirmAdd(boolean confirmAdd)
EntitySearchFieldPanel.Builder	confirmEdit(boolean confirmEdit)
EntitySearchFieldPanel.Builder	includeAddButton(boolean includeAddButton)
EntitySearchFieldPanel.Builder	includeEditButton(boolean includeEditButton)
EntitySearchFieldPanel.Builder	includeSearchButton(boolean includeSearchButton)
EntitySearchFieldPanel.Builder	limit(int limit)
EntitySearchFieldPanel.Builder	lowerCase(boolean lowerCase)	Makes the field convert all upper case input to lower case
EntitySearchFieldPanel.Builder	searchHintEnabled(boolean searchHintEnabled)
EntitySearchFieldPanel.Builder	searchIndicator(EntitySearchField.SearchIndicator searchIndicator)
EntitySearchFieldPanel.Builder	searchOnFocusLost(boolean searchOnFocusLost)
EntitySearchFieldPanel.Builder	selectAllOnFocusGained(boolean selectAllOnFocusGained)
EntitySearchFieldPanel.Builder	selectorFactory(Function<EntitySearchModel,EntitySearchField.Selector> selectorFactory)
EntitySearchFieldPanel.Builder	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 includeSearchButton(boolean includeSearchButton)

Parameters:

includeSearchButton - true if a search button should be included

Returns:

this builder instance

includeAddButton

EntitySearchFieldPanel.Builder 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)
• EntitySearchFieldPanel.builder(EntitySearchModel, Supplier, Value)

includeEditButton

EntitySearchFieldPanel.Builder 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)
• EntitySearchFieldPanel.builder(EntitySearchModel, Supplier, Value)

confirmAdd

EntitySearchFieldPanel.Builder confirmAdd(boolean confirmAdd)

Parameters:

confirmAdd - true if adding an item should be confirmed

Returns:

this builder instance

confirmEdit

EntitySearchFieldPanel.Builder confirmEdit(boolean confirmEdit)

Parameters:

confirmEdit - true if editing an item should be confirmed

Returns:

this builder instance

buttonsFocusable

EntitySearchFieldPanel.Builder buttonsFocusable(boolean buttonsFocusable)

Default false

Parameters:

buttonsFocusable - true if the buttons should be focusable

Returns:

this builder instance

buttonLocation

EntitySearchFieldPanel.Builder 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 columns(int columns)

Parameters:

columns - the number of colums in the text field

Returns:

this builder instance

upperCase

EntitySearchFieldPanel.Builder 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 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

searchHintEnabled

EntitySearchFieldPanel.Builder 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 searchOnFocusLost(boolean searchOnFocusLost)

Parameters:

searchOnFocusLost - true if search should be performed on focus lost

Returns:

this builder instance

selectAllOnFocusGained

EntitySearchFieldPanel.Builder selectAllOnFocusGained(boolean selectAllOnFocusGained)

Parameters:

selectAllOnFocusGained - true if the contents should be selected when the field gains focus

Returns:

this builder instance

searchIndicator

EntitySearchFieldPanel.Builder searchIndicator(EntitySearchField.SearchIndicator searchIndicator)

Parameters:

searchIndicator - the search indicator

Returns:

this builder instance

selectorFactory

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

Parameters:

selectorFactory - the selector factory to use

Returns:

this builder instance

limit

EntitySearchFieldPanel.Builder 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<Entity,EntitySearchFieldPanel,EntitySearchFieldPanel.Builder>

Returns:

a new EntitySearchFieldPanel based on this builder