# Class StickyHeaderContainer

java.lang.Object
com.codename1.ui.Component
com.codename1.ui.Container
com.codename1.components.StickyHeaderContainer

All Implemented Interfaces:
  `Animation, Editable, StyleListener, Iterable<Component>`

public class StickyHeaderContainer extends Container

A scrollable container that pins the most recently scrolled-past section header to the top of its viewport, in the style of the iOS contacts list or sectioned material lists. As the next section's header rises into the pinned slot the previous header is replaced through a configurable scroll-driven transition: a directional slide where the rising header pushes the pinned one up and out, an instant cover where the rising header simply slides over the pinned one, or a fade where the pinned header fades to transparency as the next section closes the gap. Transitions are driven by scroll position so the visual stays in sync with the user's gesture and there is no time-based animation that lags behind a slow drag or skips ahead on a fling.

Sections are added with `addSection(header, content)`. The header is a real component that participates in the scroll: when it is the active section's header it is moved into a pinned overlay slot at the top of the container, and a same-sized invisible placeholder is left behind in the scroll content so nothing jumps. Because the pinned header is the same instance, action listeners and child components remain interactive while it is pinned.

    StickyHeaderContainer sticky = new StickyHeaderContainer();
    sticky.setTransitionStyle(StickyHeaderContainer.TRANSITION_SLIDE);
    for (char c = 'A'; c <= 'Z'; c++) {
        Label header = new Label("" + c, "StickyHeader");
        Container items = new Container(BoxLayout.y());
        for (int i = 0; i < 5; i++) {
            items.add(new Label(c + " entry " + i));
        }
        sticky.addSection(header, items);
    }
    form.add(BorderLayout.CENTER, sticky);

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final int`
  `TRANSITION_FADE`
  As the next section's header rises into the pinned slot from below the pinned header both slides up and fades to transparency, so it dissolves out of the slot while the rising header takes its place.
  `static final int`
  `TRANSITION_NONE`
  Replace the pinned header without a fade or shift.
  `static final int`
  `TRANSITION_SLIDE`
  As the next section's header rises into the pinned slot from below it pushes the pinned header up and out of the slot in sync with the scroll, replacing it once the rising header reaches the top.

  ### Fields inherited from class Component

  `BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `StickyHeaderContainer()`
  Creates an empty sticky header container.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `StickyHeaderContainer`
  `addSection(Component header)`
  Adds a header-only section.
  `StickyHeaderContainer`
  `addSection(Component header, Component content)`
  Adds a section consisting of a sticky header and its content.
  `void`
  `clearSections()`
  Removes all sections and content from the container.
  `int`
  `getActiveSectionIndex()`
  Returns the index of the currently pinned section, or `-1` if no header is currently pinned.
  `Container`
  `getScrollContainer()`
  Returns the inner scrolling container that hosts the section content.
  `int`
  `getScrollPosition()`
  Returns the current scroll position of the inner scroll container.
  `List<Component>`
  `getStickyHeaders()`
  Returns an unmodifiable view of the registered sticky headers in the order they were added.
  `Container`
  `getStickyHost()`
  Returns the overlay container that hosts the currently-pinned header.
  `int`
  `getTransitionDurationMillis()`
  `float`
  `getTransitionProgress()`
  Returns the progress of the in-flight transition as a fraction in `[0, 1]`: `0` when the next section is just touching the slot from below and `1` when it has fully displaced the pinned header.
  `int`
  `getTransitionStyle()`
  `boolean`
  `isTransitionInProgress()`
  Returns true while the next section's header is overlapping the pinned slot, i.e.
  `void`
  `setScrollPosition(int y)`
  Sets the scroll position of the inner scroll container.
  `void`
  `setTransitionDurationMillis(int millis)`
  Retained for API compatibility.
  `void`
  `setTransitionStyle(int style)`
  Selects how the pinned header is replaced when the next section rises into the slot.
  `void`
  `updateSticky()`
  Recomputes which section header should be pinned and how far the next section has displaced it.

  ### Methods inherited from class Container

  `add, add, add, add, add, add, addAll, addComponent, addComponent, addComponent, addComponent, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, constrainHeightWhenScrollable, constrainWidthWhenScrollable, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getChildrenAsList, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayout, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getResponderAt, getSafeAreaRoot, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isSafeArea, isSafeAreaRoot, isScrollableX, isScrollableY, isSelectableInteraction, isSurface, iterator, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, paintComponentBackground, paintGlass, paramString, pointerPressed, refreshTheme, removeAll, removeComponent, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, revalidateLater, revalidateWithAnimationSafety, scrollComponentToVisible, setCellRenderer, setEnabled, setLayout, setLeadComponent, setSafeArea, setSafeAreaRoot, setScrollable, setScrollableX, setScrollableY, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager, updateTabIndices`

  ### Methods inherited from class Component

  `addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, animate, announceForAccessibility, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAccessibilityText, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, getEditingDelegate, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initComponent, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, initUnselectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, isRippleEffect, isRTL, isScrollable, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, onSetFocusable, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAccessibilityText, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPinchBlocksDragAndDrop, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setPropertyValue, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUIIDFinal, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains`

  ### Methods inherited from class Object

  `clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Field Details

  - ### TRANSITION_NONE

    public static final int TRANSITION_NONE
    Replace the pinned header without a fade or shift. The pinned header stays in place until the rising section reaches the slot top, at which point the swap is instant. The rising header is hidden behind the pinned slot during the overlap.
    See Also:
      - Constant Field Values

  - ### TRANSITION_SLIDE

    public static final int TRANSITION_SLIDE
    As the next section's header rises into the pinned slot from below it pushes the pinned header up and out of the slot in sync with the scroll, replacing it once the rising header reaches the top.
    See Also:
      - Constant Field Values

  - ### TRANSITION_FADE

    public static final int TRANSITION_FADE
    As the next section's header rises into the pinned slot from below the pinned header both slides up and fades to transparency, so it dissolves out of the slot while the rising header takes its place. The swap happens once the rising header reaches the top.
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### StickyHeaderContainer

    public StickyHeaderContainer()
    Creates an empty sticky header container. Add sections via `addSection(header, content)`.

- ## Method Details

  - ### addSection

    public StickyHeaderContainer addSection(Component header, Component content)
    Adds a section consisting of a sticky header and its content. The content may be `null` for a header-only section. Returns this for chaining.

  - ### addSection

    public StickyHeaderContainer addSection(Component header)
    Adds a header-only section.

  - ### getScrollContainer

    public Container getScrollContainer()
    Returns the inner scrolling container that hosts the section content. Use this to add non-section components such as a footer, or for programmatic scrolling via `setScrollPosition(int)`.

  - ### getStickyHost

    public Container getStickyHost()
    Returns the overlay container that hosts the currently-pinned header. While a section is active its header lives here; otherwise the host is empty and zero-height.

  - ### getStickyHeaders

    public List<Component> getStickyHeaders()
    Returns an unmodifiable view of the registered sticky headers in the order they were added.

  - ### getActiveSectionIndex

    public int getActiveSectionIndex()
    Returns the index of the currently pinned section, or `-1` if no header is currently pinned.

  - ### setTransitionStyle

    public void setTransitionStyle(int style)
    Selects how the pinned header is replaced when the next section rises into the slot. One of `TRANSITION_NONE`, `TRANSITION_SLIDE` (default) or `TRANSITION_FADE`.

  - ### getTransitionStyle

    public int getTransitionStyle()

  - ### setTransitionDurationMillis

    public void setTransitionDurationMillis(int millis)
    Retained for API compatibility. Transitions are now scroll-driven so the per-frame duration no longer affects visuals; the value is validated and stored but otherwise unused.

  - ### getTransitionDurationMillis

    public int getTransitionDurationMillis()

  - ### isTransitionInProgress

    public boolean isTransitionInProgress()
    Returns true while the next section's header is overlapping the pinned slot, i.e. the scroll-driven transition is mid-flight.

  - ### getTransitionProgress

    public float getTransitionProgress()
    Returns the progress of the in-flight transition as a fraction in `[0, 1]`: `0` when the next section is just touching the slot from below and `1` when it has fully displaced the pinned header. Returns `0` when no transition is in progress.

  - ### setScrollPosition

    public void setScrollPosition(int y)
    Sets the scroll position of the inner scroll container. The value is clamped to the valid range and triggers a sticky-header recompute.

  - ### getScrollPosition

    public int getScrollPosition()
    Returns the current scroll position of the inner scroll container.

  - ### clearSections

    public void clearSections()
    Removes all sections and content from the container.

  - ### updateSticky

    public void updateSticky()
    Recomputes which section header should be pinned and how far the next section has displaced it. Called internally on every scroll event; call it explicitly when section content has been mutated outside of a normal layout cycle.