Package com.vaadin.flow.component.applayout

Class DrawerToggle

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.button.GeneratedVaadinButton<Button>

com.vaadin.flow.component.button.Button

com.vaadin.flow.component.applayout.DrawerToggle

All Implemented Interfaces:

AttachNotifier, BlurNotifier<Button>, ClickNotifier<Button>, DetachNotifier, Focusable<Button>, FocusNotifier<Button>, HasElement, HasEnabled, HasSize, HasStyle, HasText, HasTheme, HasThemeVariant<ButtonVariant>, HasTooltip, Serializable

@Tag("vaadin-drawer-toggle")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.5.12") @NpmPackage(value="@vaadin/app-layout",version="23.5.12") @NpmPackage(value="@vaadin/vaadin-app-layout",version="23.5.12")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/app-layout/src/vaadin-drawer-toggle.js")
public class DrawerToggle
extends Button

Server-side component for the <vaadin-drawer-toggle> element. It is a button that allows the user to open and close the drawer. To use it, add it to the AppLayout, typically in the navbar slot. AppLayout layout = new AppLayout(); layout.addToNavbar(new DrawerToggle());

See Also:

Serialized Form

Nested Class Summary

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

BlurNotifier.BlurEvent<C extends Component>

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

FocusNotifier.FocusEvent<C extends Component>

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

HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
DrawerToggle()

Method Summary

Modifier and Type	Method	Description
void	setIcon(Component icon)	Sets the given component as the icon of this button.

Methods inherited from class com.vaadin.flow.component.button.Button

addThemeVariants, click, clickInClient, getIcon, isAutofocus, isDisableOnClick, isIconAfterText, onAttach, removeThemeVariants, setAutofocus, setDisableOnClick, setIconAfterText, setText

Methods inherited from class com.vaadin.flow.component.button.GeneratedVaadinButton

addToPrefix, addToSuffix, isAutofocusBoolean, isDisabledBoolean, remove, removeAll, setDisabled

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, 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.AttachNotifier

addAttachListener

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

addBlurListener

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

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

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

addDetachListener

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

isEnabled, setEnabled

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

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

getText, getWhiteSpace, setWhiteSpace

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

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

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

getTooltip, setTooltipText

Constructor Detail

DrawerToggle

public DrawerToggle()

Method Detail

setIcon

public void setIcon(Component icon)

Description copied from class: Button

Sets the given component as the icon of this button.

Even though you can use almost any component as an icon, some good options are Icon and Image.

Use Button.setIconAfterText(boolean) to change the icon's position relative to the button's text content.

This method also sets or removes this button's theme=icon attribute based on whether this button contains only an icon after this operation or not.

Overrides:

setIcon in class Button

Parameters:

icon - component to be used as an icon, may be null to only remove the current icon, can't be a text-node