Index (App Headroom for Vaadin Flow 25.1.0 API)

A D E I L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addPinnedChangeListener(ComponentEventListener) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Registers a listener to be notified whenever AppHeadroom.isPinned() changes.
AppHeadroom - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Hides/shows an AppLayout's top and bottom navigation bars on scroll.
AppHeadroom.DeviceType - Enum Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Coarse device category, used by AppHeadroom.setActivationPredicate(SerializableBiPredicate).
AppHeadroom.Orientation - Enum Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Viewport orientation, used by AppHeadroom.setActivationPredicate(SerializableBiPredicate).
AppHeadroom.PinnedChangeEvent - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Fired whenever the chrome's pinned/unpinned state changes, whether driven by scrolling on the client or by a server-initiated reset (e.g. detaching this instance via AppHeadroom.remove()).
applyTo(AppLayout) - Static method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Applies headroom scroll-hide/show behavior to the given AppLayout and returns the component for optional further configuration.
ATTR_BOTTOM_BAR_PINNED - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setBottomBarPinned(boolean) attribute.
ATTR_HIDE_TOLERANCE - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setHideTolerance(int) attribute.
ATTR_SHOW_TOLERANCE - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setShowTolerance(int) attribute.
ATTR_TOP_BAR_PINNED - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setTopBarPinned(boolean) attribute.
ATTR_TOP_OFFSET - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setTopOffset(int) attribute.
ATTR_TRANSITION_DURATION - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setTransitionDuration(int) attribute.

D

DESKTOP - Enum constant in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.DeviceType

E

EVENT_PINNED_CHANGED - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.addPinnedChangeListener(ComponentEventListener) DOM event.

I

isActive() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Whether the headroom effect is currently active for this session, per the last evaluation of the activation predicate.
isPinned() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Whether the chrome is currently shown (true, the initial and default state) or hidden (false).
isPinned() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.PinnedChangeEvent: Same value as AppHeadroom.isPinned() at the time this event fired.

L

LANDSCAPE - Enum constant in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.Orientation

O

onDetach(DetachEvent) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Resets the server-visible pinned state directly, rather than relying on the client's own pinned-changed event during teardown: when detachment is server-initiated (e.g.
org.vaadin.addons.joelpop.appheadroom.ui.component - package org.vaadin.addons.joelpop.appheadroom.ui.component

P

PHONE - Enum constant in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.DeviceType
PinnedChangeEvent(AppHeadroom, boolean, boolean) - Constructor for class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.PinnedChangeEvent: Constructed by Flow when the client fires pinned-changed, or directly by AppHeadroom itself for a server-initiated reset; not meant to be constructed by application code.
PORTRAIT - Enum constant in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.Orientation
PROPERTY_ACTIVE - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.isActive() element property.
PROPERTY_PINNED - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.isPinned() element property.

R

remove() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Detaches this instance, removing its scroll-hide/show behavior from the AppLayout it was applied to.

S

setActivationPredicate(SerializableBiPredicate) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Sets the predicate that decides whether the headroom effect should be active, evaluated against this session's detected AppHeadroom.DeviceType and current AppHeadroom.Orientation.
setBottomBarPinned(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Same as AppHeadroom.setTopBarPinned(boolean), for the bottom bar.
setHideTolerance(int) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Sets how far, in pixels, the user must scroll down past the last shown-position high-water mark before the chrome hides (default 30).
setShowTolerance(int) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Sets how far, in pixels, the user must scroll up past the last hidden-position low-water mark before the chrome is restored (default 30).
setTabletMinShortSidePx(int) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Overrides the physical-screen-shorter-side threshold, in CSS pixels, used to distinguish AppHeadroom.DeviceType.TABLET from AppHeadroom.DeviceType.PHONE among touch devices (default 768, matching vaadin-flow-app-nav-layout's equivalent device detection).
setTopBarPinned(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Explicitly overrides whether the top bar is treated as pinned (never hidden), regardless of the automatic position/shape inference.
setTopOffset(int) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Sets the distance from the top of the page, in pixels, within which the chrome is always shown (default 100).
setTransitionDuration(int) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Sets how long, in milliseconds, the show/hide slide and padding transitions take (default 600).

T

TABLET - Enum constant in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.DeviceType

V

valueOf(String) - Static method in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.DeviceType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.Orientation: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.DeviceType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.Orientation: Returns an array containing the constants of this enum class, in the order they are declared.

A D E I L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form