com.vaadin.flow.component.accordion

Class Accordion

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.accordion.Accordion

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, Serializable

@Tag(value="vaadin-accordion")
 @NpmPackage(value="@vaadin/vaadin-accordion",
            version="1.2.0")
 @JsModule(value="@vaadin/vaadin-accordion/src/vaadin-accordion.js")
public class Accordion
extends Component
implements HasSize, HasStyle

Accordion is a a vertically stacked set of expandable panels. Only one panel can be opened at a time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Accordion.OpenedChangeEvent An event fired when an Accordion is opened or closed.

Constructor Summary

Constructors

Constructor and Description
Accordion()

Method Summary

Modifier and Type	Method and Description
AccordionPanel	add(AccordionPanel panel) Adds a panel.
AccordionPanel	add(String summary, Component content) Adds a panel created from the given title and content.
Registration	addOpenedChangeListener(ComponentEventListener<Accordion.OpenedChangeEvent> listener) Registers a listener to be notified whenever a panel is opened or closed.
void	close() Closes the opened panel (if any) in this accordion.
OptionalInt	getOpenedIndex() Gets the index of the currently opened index.
Optional<AccordionPanel>	getOpenedPanel() Gets the opened panel.
void	open(AccordionPanel panel) Opens the specified panel.
void	open(int index) Opens the panel at the specified index.
void	remove(AccordionPanel panel) Removes a panel.
void	remove(Component content) Removes a panel based on the content

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.HasSize

getCssSize, 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.HasElement

getElement

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

addAttachListener

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

addDetachListener

Constructor Detail

Accordion

public Accordion()

Method Detail

add

public AccordionPanel add(String summary,
                          Component content)

Adds a panel created from the given title and content.

Parameters:

summary - the title of the panel

content - the content of th panel

Returns:

the panel created and added

add

public AccordionPanel add(AccordionPanel panel)

Adds a panel.

Parameters:

panel - the non-null panel to be added

Returns:

the added panel

remove

public void remove(AccordionPanel panel)

Removes a panel.

Parameters:

panel - the non-null panel to be removed

remove

public void remove(Component content)

Removes a panel based on the content

Parameters:

content - the non-null content of the panel to be removed

close

public void close()

Closes the opened panel (if any) in this accordion.

open

public void open(int index)

Opens the panel at the specified index.

Parameters:

index - the (positive) index of the panel to be open. The first panel is at index zero.

open

public void open(AccordionPanel panel)

Opens the specified panel.

Parameters:

panel - the non-null panel to be opened

getOpenedIndex

@Synchronize(property="opened",
             value="opened-changed")
public OptionalInt getOpenedIndex()

Gets the index of the currently opened index.

Returns:

the index of the opened panel or null if the accordion is closed.

getOpenedPanel

@Synchronize(property="opened",
             value="opened-changed")
public Optional<AccordionPanel> getOpenedPanel()

Gets the opened panel. Caution should be exercised when using this method with an Accordion which along with its panels were created in a template. Such template children would by default not be children of the Accordion Flow component, thus making it possible for this method to return the wrong panel in such cases.

Returns:

the opened panel.

addOpenedChangeListener

public Registration addOpenedChangeListener(ComponentEventListener<Accordion.OpenedChangeEvent> listener)

Registers a listener to be notified whenever a panel is opened or closed.

Parameters:

listener - the listener to be notified

Returns:

a handle to the registered listener which could also be used to unregister it.