Class ComponentRegistry

java.lang.Object

org.patternfly.component.ComponentRegistry

public class ComponentRegistry
extends Object

Public, type-keyed singleton registry for PatternFly components that exist at most once per page. Use this class to register and look up global components such as Page, Masthead, or NotificationDrawerList.

This is distinct from ComponentStore, which is an internal, package-private store for wiring parent-child relationships via DOM traversal and supports multiple instances of the same ComponentType.

Registration is done by calling registerComponent(ComponentType, BaseComponent) or registerSubComponent(ComponentType, String, SubComponent). Lookup is done by calling lookupComponent(ComponentType) and lookupSubComponent(ComponentType, String). When a registered component is removed from the DOM, call unregisterComponent(ComponentType) or unregisterSubComponent(ComponentType, String) to prevent stale references.

Method Summary

Modifier and Type	Method	Description
static ComponentRegistry	componentRegistry()
<C extends BaseComponent<E,B>, E extends HTMLElement, B extends TypedBuilder<E,B>> C	lookupComponent(ComponentType type)
<C extends SubComponent<E,B>, E extends HTMLElement, B extends TypedBuilder<E,B>> C	lookupSubComponent(ComponentType type, String name)
void	registerComponent(ComponentType type, BaseComponent<?,?> component)
void	registerSubComponent(ComponentType type, String name, SubComponent<?,?> subComponent)
void	unregisterComponent(ComponentType type)
void	unregisterSubComponent(ComponentType type, String name)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

componentRegistry

public static ComponentRegistry componentRegistry()

registerComponent

public void registerComponent(ComponentType type,
 BaseComponent<?,?> component)

registerSubComponent

public void registerSubComponent(ComponentType type,
 String name,
 SubComponent<?,?> subComponent)

unregisterComponent

public void unregisterComponent(ComponentType type)

unregisterSubComponent

public void unregisterSubComponent(ComponentType type,
 String name)

lookupComponent

public <C extends BaseComponent<E,B>, E extends HTMLElement, B extends TypedBuilder<E,B>>
C lookupComponent(ComponentType type)

lookupSubComponent

public <C extends SubComponent<E,B>, E extends HTMLElement, B extends TypedBuilder<E,B>>
C lookupSubComponent(ComponentType type,
 String name)