Index (App Headroom for Vaadin Flow 25.1.1 API)

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

A

addCollapseChangeListener(ComponentEventListener) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Registers a listener to be notified whenever AppHeadroom.isCollapsed() changes.
addPinnedChangeListener(ComponentEventListener) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Deprecated.
Use AppHeadroom.addCollapseChangeListener(ComponentEventListener) instead.
AppHeadroom - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Hides/shows an AppLayout's top and bottom navigation bars on scroll.
AppHeadroom.CollapseChangeEvent - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Fired whenever the chrome's expanded/collapsed state changes, whether driven by scrolling on the client or by a server-initiated reset (e.g. detaching this instance via AppHeadroom.remove()).
AppHeadroom.CondensedBar - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: One bar's condensed-view accessor (see AppHeadroom.getCondensedTop()/ AppHeadroom.getCondensedBottom()) — pick a shape via AppHeadroom.CondensedBar.asFloating() or AppHeadroom.CondensedBar.asRibbon() to get a shape-specific accessor exposing only the methods that make sense for it, the same pattern Grid's asSingleSelect()/asMultiSelect() already use for an analogous "pick one of a few mutually-exclusive modes" choice.
AppHeadroom.DeviceType - Enum Class in org.vaadin.addons.joelpop.appheadroom.ui.component: Coarse device category, used by AppHeadroom.setActivationPredicate(SerializableBiPredicate).
AppHeadroom.FloatingCondensedBar - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: AppHeadroom.CondensedBar.asFloating()'s shape-specific accessor.
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: Deprecated.
Use AppHeadroom.CollapseChangeEvent instead. Same underlying event, fired alongside it whenever it fires — note the inverted value: AppHeadroom.PinnedChangeEvent.isPinned() (shown) is equivalent to !AppHeadroom.CollapseChangeEvent.isCollapsed().
AppHeadroom.RibbonCondensedBar - Class in org.vaadin.addons.joelpop.appheadroom.ui.component: AppHeadroom.CondensedBar.asRibbon()'s shape-specific accessor.
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.
asFloating() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.CondensedBar: Shapes this bar's condensed view as a small, floating, auto-centered Component.
asRibbon() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.CondensedBar: Shapes this bar's condensed view as a full-width, opaque ribbon — background flush to the true screen edge, extending into the safe area exactly like the real bar's own landscape treatment, with only the content inset from the unsafe zone.
ATTR_BOTTOM_BAR_PINNED - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the AppHeadroom.setBottomBarCollapsible(boolean) attribute.
ATTR_CONDENSED_BOTTOM_SHAPE - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the attribute telling app-headroom.ts which shape (if any) the bottom condensed view is.
ATTR_CONDENSED_TOP_SHAPE - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Wire name of the attribute telling app-headroom.ts which shape (if any) the top condensed view is.
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.setTopBarCollapsible(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.

C

CollapseChangeEvent(AppHeadroom, boolean, boolean) - Constructor for class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.CollapseChangeEvent: 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.

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.addCollapseChangeListener(ComponentEventListener) DOM event.

G

getCondensedBottom() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Same as AppHeadroom.getCondensedTop(), for the bottom bar.
getCondensedTop() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: The top bar's condensed-view accessor — a small alternate view that can cross-fade into place while the real top bar is scroll-hidden.
getStyle() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.RibbonCondensedBar: The frame's own style — overrides the default var(--vaadin-background-container) background, or anything else about the frame.

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.
isCollapsed() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.CollapseChangeEvent: Same value as AppHeadroom.isCollapsed() at the time this event fired.
isCollapsed() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Whether the chrome is currently collapsed/hidden (true) or expanded/shown (false, the initial and default state).
isPinned() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Deprecated.
Use AppHeadroom.isCollapsed() instead — note the inverted return value: isPinned() (shown) is equivalent to !isCollapsed().
isPinned() - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.PinnedChangeEvent: Deprecated.
Use !AppHeadroom.CollapseChangeEvent.isCollapsed() instead.

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 expanded 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: Deprecated.

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.isCollapsed() 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.
setBottomBarCollapsible(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Same as AppHeadroom.setTopBarCollapsible(boolean), for the bottom bar.
setBottomBarPinned(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Deprecated.
Use AppHeadroom.setBottomBarCollapsible(boolean) instead — see AppHeadroom.setTopBarPinned(boolean) for the argument-inversion note. Calling this delegates to AppHeadroom.setBottomBarCollapsible(boolean).
setComponent(Component) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.FloatingCondensedBar: Sets the Component to show, attached immediately.
setComponent(Component) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom.RibbonCondensedBar: Sets the Component to show, nested inside an AppHeadroom-owned frame attached immediately.
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).
setTopBarCollapsible(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Explicitly overrides whether the top bar can ever collapse (hide) at all, regardless of the automatic position/shape inference.
setTopBarPinned(boolean) - Method in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: Deprecated.
Use AppHeadroom.setTopBarCollapsible(boolean) instead — note the inverted argument: setTopBarPinned(true) (never collapse) is equivalent to setTopBarCollapsible(false). Calling this delegates to AppHeadroom.setTopBarCollapsible(boolean).
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).
SHAPE_FLOATING - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: AppHeadroom.ATTR_CONDENSED_TOP_SHAPE/AppHeadroom.ATTR_CONDENSED_BOTTOM_SHAPE value for AppHeadroom.CondensedBar.asFloating().
SHAPE_RIBBON - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: AppHeadroom.ATTR_CONDENSED_TOP_SHAPE/AppHeadroom.ATTR_CONDENSED_BOTTOM_SHAPE value for AppHeadroom.CondensedBar.asRibbon().
SLOT_CONDENSED_BOTTOM - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: slot name the bottom condensed view's element is attached under.
SLOT_CONDENSED_TOP - Static variable in class org.vaadin.addons.joelpop.appheadroom.ui.component.AppHeadroom: slot name the top condensed view's element is attached under.

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 C D E G I L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form