We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.html.
Class NativeDetails
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.HtmlComponent
-
- com.vaadin.flow.component.html.NativeDetails
-
All Implemented Interfaces:
AttachNotifier,ClickNotifier<NativeDetails>,DetachNotifier,HasElement,HasSize,HasStyle,Serializable@Tag("details") public class NativeDetails extends HtmlComponent implements ClickNotifier<NativeDetails>Component representing a
<details>element.Since:
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classNativeDetails.SummaryComponent representing a
<summary>element.static classNativeDetails.ToggleEventRepresents the DOM event "toggle".
-
Constructor Summary
Constructors Constructor Description NativeDetails()Creates a new details with an empty summary.
NativeDetails(Component summaryContent)Creates a new details with the given content of the summary.
NativeDetails(Component summaryContent, Component content)Creates a new details using the provided summary content and content.
NativeDetails(String summary)Creates a new details with the given summary.
NativeDetails(String summary, Component content)Creates a new details using the provided summary and content.
-
Method Summary
All Methods Modifier and Type Method Description RegistrationaddToggleListener(ComponentEventListener<NativeDetails.ToggleEvent> listener)Adds a listener for
toggleevents fired by the details, which are dispatched to the details element whenever its state changes between open and closed.ComponentgetContent()Returns the details content which was set via
setContent(Component).NativeDetails.SummarygetSummary()Returns
NativeDetails.Summarycomponent associated with this details.StringgetSummaryText()Returns the textual summary of this details.
booleanisOpen()Return whether or not the details is opened and the content is displayed.
voidsetContent(Component content)Sets the details content and removes the previously set content.
voidsetOpen(boolean open)Sets whether or not the details should be opened.
voidsetSummary(Component... summaryContent)Sets the components of the summary.
voidsetSummaryText(String summary)Sets the text of the summary.
-
Methods inherited from class com.vaadin.flow.component.HtmlComponent
getTitle, setTitle
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, 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.ClickNotifier
addClickListener, addClickShortcut
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
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
-
-
-
-
Constructor Detail
-
NativeDetails
public NativeDetails()Creates a new details with an empty summary.
-
NativeDetails
public NativeDetails(String summary)Creates a new details with the given summary.
Parameters:
summary- the summary to set.
-
NativeDetails
public NativeDetails(Component summaryContent)Creates a new details with the given content of the summary.
Parameters:
summaryContent- the summary content to set.
-
NativeDetails
public NativeDetails(String summary, Component content)Creates a new details using the provided summary and content.
Parameters:
summary- the summary text to set.content- the content component to set.
-
-
Method Detail
-
getSummary
public NativeDetails.Summary getSummary()Returns
NativeDetails.Summarycomponent associated with this details.Returns:
the summary component
-
getSummaryText
public String getSummaryText()Returns the textual summary of this details.
Returns:
the text content of the summary, not
nullSee Also:
-
setSummaryText
public void setSummaryText(String summary)Sets the text of the summary. Removes previously set components of the summary.
Parameters:
summary- the summary text to set.See Also:
-
setSummary
public void setSummary(Component... summaryContent)Sets the components of the summary. Removes previously set text or components of the summary.
Parameters:
summaryContent- the summary content to set.See Also:
-
getContent
public Component getContent()Returns the details content which was set via
setContent(Component).Returns:
the content of the details, can be
null.
-
setContent
public void setContent(Component content)Sets the details content and removes the previously set content.
Parameters:
content- the content of the details to setSee Also:
-
isOpen
@Synchronize(property="open", value="toggle") public boolean isOpen()Return whether or not the details is opened and the content is displayed.
Returns:
whether details are expanded or collapsed
-
setOpen
public void setOpen(boolean open)Sets whether or not the details should be opened.
trueif the details should be opened and the content should be displayed,falseto collapse it.Parameters:
open- the boolean value to set
-
addToggleListener
public Registration addToggleListener(ComponentEventListener<NativeDetails.ToggleEvent> listener)Adds a listener for
toggleevents fired by the details, which are dispatched to the details element whenever its state changes between open and closed.Note: This event is always triggered on client side. Resulting in
isFromClient()to always returntrue.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
-