Class Overlay

java.lang.Object
org.patternfly.overlay.Overlay
public class Overlay extends Object
Centralized controller for native popover management. Combines CSS anchor positioning, event listener registration, entry/exit delay timers, and show/hide lifecycle management into a single reusable unit.

Components such as Tooltip and Popover delegate all overlay behavior to this class, keeping their own code focused on component-specific concerns (DOM structure, ARIA, content).

See Also:

  • Method Details

    • overlay

      public static Overlay overlay(HTMLElement overlayElement, Placement placement)

    • triggerMode

      public Overlay triggerMode(TriggerMode mode)

    • trigger

      public Overlay trigger(String selector)

    • trigger

      public Overlay trigger(By selector)

    • trigger

      public Overlay trigger(HTMLElement element)

    • trigger

      public Overlay trigger(Supplier<HTMLElement> supplier)

    • placement

      public Overlay placement(Placement placement)

    • distance

      public Overlay distance(int distance)

    • entryDelay

      public Overlay entryDelay(int delay)

    • exitDelay

      public Overlay exitDelay(int delay)

    • cssPositioning

      public Overlay cssPositioning(boolean enabled)

    • matchTriggerWidth

      public Overlay matchTriggerWidth(boolean match)

    • onToggle

      public Overlay onToggle(OverlayHandler handler)
      Register a handler called after show/hide transitions.

    • attach

      public HTMLElement attach()
      Resolves the trigger element, sets up CSS anchor positioning, and registers event listeners based on the configured TriggerMode. Returns the resolved trigger element or null.

    • detach

      public void detach()
      Removes all event listeners, cancels pending timers, hides the overlay if visible, and tears down CSS anchor positioning.

    • show

      public void show()
      Shows the overlay.

    • show

      public void show(Event event)
      Shows the overlay.

    • hide

      public void hide()
      Hides the overlay.

    • hide

      public void hide(Event event)
      Hides the overlay.

    • toggle

      public void toggle()
      Toggles the overlay between shown and hidden states.

    • toggle

      public void toggle(Event event)
      Toggles the overlay between shown and hidden states.

    • overlayElement

      public HTMLElement overlayElement()

    • trigger

      public HTMLElement trigger()

    • cssPositioning

      public boolean cssPositioning()

    • distance

      public int distance()

    • visible

      public boolean visible()
      Returns whether the overlay is currently visible.