Class ContentAware
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.HtmlComponent
-
- com.vaadin.flow.component.HtmlContainer
-
- com.vaadin.flow.component.html.Div
-
- org.vaadin.miki.superfields.contentaware.ContentAware
-
- All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier,com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>,com.vaadin.flow.component.DetachNotifier,com.vaadin.flow.component.HasComponents,com.vaadin.flow.component.HasElement,com.vaadin.flow.component.HasEnabled,com.vaadin.flow.component.HasOrderedComponents,com.vaadin.flow.component.HasSize,com.vaadin.flow.component.HasStyle,com.vaadin.flow.component.HasText,Serializable,HasId,WithIdMixin<ContentAware>,ContentChangeNotifier
@Tag("content-aware") public class ContentAware extends com.vaadin.flow.component.html.Div implements ContentChangeNotifier, WithIdMixin<ContentAware>Content-aware that sends events when a component is added to or removed from anywhere in its contents (even in a nested layout). Observing changes to the dom structure is disabled by default.- Since:
- 2021-01-20
- Author:
- miki
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ContentAware()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.vaadin.flow.shared.RegistrationaddContentChangeListener(ContentChangeListener listener)Adds a listener to be notified wheneverContentChangeEventhappens.booleanisActive()Checks whether observation for changes is active.protected voidonAttach(com.vaadin.flow.component.AttachEvent attachEvent)voidsetActive(boolean active)Activates or deactivates observation for changes in the dom structure.-
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.ClickNotifier
addClickListener, addClickShortcut
-
Methods inherited from interface com.vaadin.flow.component.HasComponents
add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll
-
Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents
getChildren, getComponentAt, getComponentCount, indexOf, replace
-
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, setText, setWhiteSpace
-
Methods inherited from interface org.vaadin.miki.markers.WithIdMixin
withId
-
-
-
-
Method Detail
-
onAttach
protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
- Overrides:
onAttachin classcom.vaadin.flow.component.Component
-
isActive
public boolean isActive()
Checks whether observation for changes is active.- Returns:
- Whether or not changes to the dom structure are reported to this object;
falseby default.
-
setActive
public void setActive(boolean active)
Activates or deactivates observation for changes in the dom structure.- Parameters:
active- Whether or not to listen to changes.
-
addContentChangeListener
public com.vaadin.flow.shared.Registration addContentChangeListener(ContentChangeListener listener)
Description copied from interface:ContentChangeNotifierAdds a listener to be notified wheneverContentChangeEventhappens.- Specified by:
addContentChangeListenerin interfaceContentChangeNotifier- Parameters:
listener- Listener to add.- Returns:
- A
Registrationthat can be used to stop listening to events.
-
-