Class SingleSelect

java.lang.Object

org.patternfly.component.ComponentDelegate<elemental2.dom.HTMLElement, SingleSelect>

org.patternfly.component.menu.SingleSelect

All Implemented Interfaces:

Attachable, ElementAttributeMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementClassListMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementConsumerMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementContainerMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementEventMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementIdMethods<elemental2.dom.HTMLElement, SingleSelect>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, SingleSelect>, HTMLElementDataMethods<elemental2.dom.HTMLElement, SingleSelect>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, SingleSelect>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, SingleSelect>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, SingleSelect>, Component, Expandable<elemental2.dom.HTMLElement, SingleSelect>, OuiaSupport<elemental2.dom.HTMLElement, SingleSelect>, Modifiers.Disabled<elemental2.dom.HTMLElement, SingleSelect>

public class SingleSelect
extends ComponentDelegate<elemental2.dom.HTMLElement, SingleSelect>

A select component to select exactly one item from a list.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The select uses the browser's top-layer rendering for correct stacking, eliminating z-index issues. CSS position-try-fallbacks handles menu flipping when there is not enough space.

See Also:

• https://www.patternfly.org/components/menus/select

Method Summary

Modifier and Type	Method	Description
SingleSelect	add(Menu menu)
SingleSelect	addMenu(Menu menu)
SingleSelect	applyToMenuList(Consumer<MenuList> consumer)	Applies the provided Consumer to the MenuList associated with this SingleSelect.
SingleSelect	applyToMenuToggle(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
SingleSelect	ariaLabel(String label)
void	attach(elemental2.dom.MutationRecord mutationRecord)
void	clear()
void	clear(boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(elemental2.dom.MutationRecord mutationRecord)
SingleSelect	disabled(boolean disabled)	Adds/removes modifier(disabled)
void	expand(boolean fireEvent)
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
SingleSelect	noDefaultSelectHandler()
SingleSelect	onLoaded(ComponentHandler<SingleSelect> loadedHandler)
SingleSelect	onToggle(ToggleHandler<SingleSelect> toggleHandler)
SingleSelect	placement(Placement placement)
void	select(String identifier)
void	select(String identifier, boolean fireEvent)
void	select(MenuItem item)
void	select(MenuItem item, boolean fireEvent)
static SingleSelect	singleSelect(String text)
static SingleSelect	singleSelect(MenuToggle menuToggle)
SingleSelect	stayOpen(StayOpenPredicate<MenuToggle> stayOpen)	Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.
SingleSelect	that()

Methods inherited from class ComponentDelegate

componentType, element, ouiaComponentType

Methods inherited from class Object

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

Methods inherited from interface ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Modifiers.Disabled

disabled

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

singleSelect

public static SingleSelect singleSelect(String text)

singleSelect

public static SingleSelect singleSelect(MenuToggle menuToggle)

that

public SingleSelect that()

add

public SingleSelect add(Menu menu)

applyToMenuList

public SingleSelect applyToMenuList(Consumer<MenuList> consumer)

Applies the provided Consumer to the MenuList associated with this SingleSelect. If the menu, menu content, or menu list is not yet initialized, they will be created as part of this method.

This method simplifies the process of adding menu items to the component. It is a shortcut for creating and adding a SingleSelectMenu, MenuContent, and MenuList in a single step. Don't use this method if you need to us another menu type, want to customize the menu, content or list or if you want to use MenuGroups.

Parameters:

consumer - a Consumer that accepts a MenuList for customization or modification

Returns:

the current SingleSelect instance for method chaining

noDefaultSelectHandler

public SingleSelect noDefaultSelectHandler()

clear

public void clear()

clear

public void clear(boolean fireEvent)

select

public void select(String identifier)

select

public void select(String identifier,
 boolean fireEvent)

select

public void select(MenuItem item)

select

public void select(MenuItem item,
 boolean fireEvent)

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addMenu

public SingleSelect addMenu(Menu menu)

applyToMenuToggle

public SingleSelect applyToMenuToggle(Consumer<MenuToggle> consumer)

Provides access to the underlying menu toggle using a fluent API style

disabled

public SingleSelect disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<elemental2.dom.HTMLElement, B extends TypedBuilder<elemental2.dom.HTMLElement, B>>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Modifiers.Disabled<elemental2.dom.HTMLElement, B extends TypedBuilder<elemental2.dom.HTMLElement, B>>

placement

public SingleSelect placement(Placement placement)

stayOpen

public SingleSelect stayOpen(StayOpenPredicate<MenuToggle> stayOpen)

Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.

Parameters:

stayOpen - a StayOpenPredicate that evaluates an Event to determine if the menu remains open.

Returns:

the current instance with the condition applied, enabling method chaining.

ariaLabel

public SingleSelect ariaLabel(String label)

onLoaded

public SingleSelect onLoaded(ComponentHandler<SingleSelect> loadedHandler)

onToggle

public SingleSelect onToggle(ToggleHandler<SingleSelect> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<elemental2.dom.HTMLElement, B extends TypedBuilder<elemental2.dom.HTMLElement, B>>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<elemental2.dom.HTMLElement, B extends TypedBuilder<elemental2.dom.HTMLElement, B>>

menuToggle

public MenuToggle menuToggle()

menu

public Menu menu()