Package io.jmix.flowui.kit.component.dropdownbutton

Class DropdownButton

java.lang.Object

com.vaadin.flow.component.Component

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

io.jmix.flowui.kit.component.dropdownbutton.AbstractDropdownButton

io.jmix.flowui.kit.component.dropdownbutton.DropdownButton

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<AbstractDropdownButton>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<AbstractDropdownButton>, com.vaadin.flow.component.FocusNotifier<AbstractDropdownButton>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<DropdownButtonVariant>, DropdownButtonComponent, HasSubParts, HasTitle, Serializable

public class DropdownButton
extends AbstractDropdownButton
implements com.vaadin.flow.component.shared.HasThemeVariant<DropdownButtonVariant>

Represents a dropdown button component. This class is used as a customizable button with an associated dropdown menu.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.kit.component.dropdownbutton.AbstractDropdownButton

AbstractDropdownButton.AbstractDropdownButtonItem, AbstractDropdownButton.ActionItemImpl, AbstractDropdownButton.ComponentItemImpl, AbstractDropdownButton.HasMenuItem, AbstractDropdownButton.MenuItemProvider<T>, AbstractDropdownButton.SeparatorUserMenuItem, AbstractDropdownButton.TextItemImpl

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ATTRIBUTE_JMIX_ROLE_VALUE
protected boolean	dropdownIndicatorVisible

Fields inherited from class io.jmix.flowui.kit.component.dropdownbutton.AbstractDropdownButton

ATTRIBUTE_JMIX_ROLE_NAME, dropdownItem, iconComponent, items

Constructor Summary

Constructors

Constructor	Description
DropdownButton()

Method Summary

Modifier and Type	Method	Description
protected JmixMenuItem	createDropdownItem()
protected JmixMenuItem	getDropdownItem()
String	getText()
com.vaadin.flow.component.HasText.WhiteSpace	getWhiteSpace()
protected JmixMenuBar	initContent()
boolean	isDropdownIndicatorVisible()	Deprecated, for removal: This API element is subject to removal in a future version. use DropdownButtonVariant.LUMO_DROPDOWN_INDICATORS and DropdownButtonVariant.AURA_NO_DROPDOWN_INDICATORS instead
void	setDropdownIndicatorVisible(boolean dropdownIndicatorVisible)	Deprecated, for removal: This API element is subject to removal in a future version. use DropdownButtonVariant.LUMO_DROPDOWN_INDICATORS and DropdownButtonVariant.AURA_NO_DROPDOWN_INDICATORS instead
void	setIconComponent(@Nullable com.vaadin.flow.component.Component icon)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setText(String text)
void	setWhiteSpace(com.vaadin.flow.component.HasText.WhiteSpace value)
protected void	updateDropdownIndicator(JmixMenuBar content)
protected void	updateIconSlot()

Methods inherited from class io.jmix.flowui.kit.component.dropdownbutton.AbstractDropdownButton

addAttachListener, addClassName, addClassNames, addDetachListener, addFocusShortcut, addItem, addItem, addItem, addItem, addItem, addItem, addItem, addItem, addItem, addItem, addItemInternal, addSeparator, addSeparatorAtIndex, addThemeName, addThemeNames, blur, createComponentMenuItem, createTextMenuItem, focus, getClassName, getClassNames, getHeight, getHeightUnit, getIcon, getIconComponent, getItem, getItems, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getTabIndex, getThemeName, getThemeNames, getWidth, getWidthUnit, hasClassName, hasThemeName, isAttached, isEnabled, isOpenOnHover, remove, remove, remove, removeAll, removeClassName, removeClassNames, removeThemeName, removeThemeNames, setClassName, setClassName, setEnabled, setHeight, setHeight, setHeightFull, setIcon, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpenOnHover, setSizeFull, setSizeUndefined, setTabIndex, setThemeName, setThemeName, setWidth, setWidth, setWidthFull

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

getChildren, getContent, getElement

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

addListener, bindVisible, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, 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.BlurNotifier

addBlurListener

Methods inherited from interface io.jmix.flowui.kit.component.dropdownbutton.DropdownButtonComponent

getSubPart

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

focus

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

addFocusListener

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

getElement

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

bindEnabled

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

bindHeight, bindWidth

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

bindClassName, bindClassNames, getStyle

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

bindText

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

addThemeName, addThemeNames, bindThemeName, bindThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, bindThemeVariant, removeThemeVariants, setThemeVariant, setThemeVariants, setThemeVariants

Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

getTitle, setTitle

Field Details

ATTRIBUTE_JMIX_ROLE_VALUE

protected static final String ATTRIBUTE_JMIX_ROLE_VALUE

See Also:

• Constant Field Values

dropdownIndicatorVisible

protected boolean dropdownIndicatorVisible

Constructor Details

DropdownButton

public DropdownButton()

Method Details

createDropdownItem

protected JmixMenuItem createDropdownItem()

initContent

protected JmixMenuBar initContent()

Overrides:

initContent in class AbstractDropdownButton

getDropdownItem

protected JmixMenuItem getDropdownItem()

Specified by:

getDropdownItem in class AbstractDropdownButton

updateDropdownIndicator

protected void updateDropdownIndicator(JmixMenuBar content)

setText

public void setText(String text)

Specified by:

setText in interface com.vaadin.flow.component.HasText

getText

public String getText()

Specified by:

getText in interface com.vaadin.flow.component.HasText

setWhiteSpace

public void setWhiteSpace(com.vaadin.flow.component.HasText.WhiteSpace value)

Specified by:

setWhiteSpace in interface com.vaadin.flow.component.HasText

getWhiteSpace

public com.vaadin.flow.component.HasText.WhiteSpace getWhiteSpace()

Specified by:

getWhiteSpace in interface com.vaadin.flow.component.HasText

setIconComponent

@Deprecated(since="3.0",
            forRemoval=true)
public void setIconComponent(@Nullable com.vaadin.flow.component.Component icon)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DropdownButtonComponent

Sets the icon for the component.

Specified by:

setIconComponent in interface DropdownButtonComponent

Parameters:

icon - the icon to set. Can be null to clear the current icon.

isDropdownIndicatorVisible

@Deprecated(since="3.0",
            forRemoval=true)
public boolean isDropdownIndicatorVisible()

Deprecated, for removal: This API element is subject to removal in a future version.

use DropdownButtonVariant.LUMO_DROPDOWN_INDICATORS and DropdownButtonVariant.AURA_NO_DROPDOWN_INDICATORS instead

Returns whether if the dropdown indicator is currently visible.

Returns:

true if the dropdown indicator is visible, false otherwise

setDropdownIndicatorVisible

@Deprecated(since="3.0",
            forRemoval=true)
public void setDropdownIndicatorVisible(boolean dropdownIndicatorVisible)

Deprecated, for removal: This API element is subject to removal in a future version.

use DropdownButtonVariant.LUMO_DROPDOWN_INDICATORS and DropdownButtonVariant.AURA_NO_DROPDOWN_INDICATORS instead

Sets the visibility of the dropdown indicator.

Parameters:

dropdownIndicatorVisible - true to display the indicator, or false to hide it.

updateIconSlot

protected void updateIconSlot()