Class Dropdown

java.lang.Object

org.patternfly.component.ComponentDelegate<HTMLElement, Dropdown>

org.patternfly.component.menu.Dropdown

All Implemented Interfaces:

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

public class Dropdown
extends ComponentDelegate<HTMLElement, Dropdown>

A dropdown presents a menu of actions or links in a constrained space that will trigger a process or navigate to a new location.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The dropdown 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/dropdown/

Method Summary

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

Methods inherited from class ComponentDelegate

componentType, element

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

Method Details

dropdown

public static Dropdown dropdown(String text)

dropdown

public static Dropdown dropdown(PredefinedIcon icon,
 String label)

dropdown

public static Dropdown dropdown(MenuToggle menuToggle)

applyToMenuList

public Dropdown applyToMenuList(Consumer<MenuList> consumer)

Applies the provided Consumer to the MenuList associated with this Dropdown. 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 DropdownMenu, 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 Dropdown instance for method chaining

that

public Dropdown that()

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addMenu

public Dropdown addMenu(Menu menu)

add

public Dropdown add(Menu menu)

applyToMenuToggle

public Dropdown applyToMenuToggle(Consumer<MenuToggle> consumer)

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

disabled

public Dropdown disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

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

isDisabled

public boolean isDisabled()

Specified by:

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

placement

public Dropdown placement(Placement placement)

stayOpen

public Dropdown stayOpen(StayOpenPredicate stayOpen)

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

Parameters:

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

Returns:

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

ariaLabel

public Dropdown ariaLabel(String label)

onLoaded

public Dropdown onLoaded(ComponentHandler<Dropdown> loadedHandler)

onToggle

public Dropdown onToggle(ToggleHandler<Dropdown> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

menuToggle

public MenuToggle menuToggle()

menu

public Menu menu()