Interface OuiaSupport<E extends HTMLElement, B extends TypedBuilder<E,B>>

All Superinterfaces:

IsElement<E>, TypedBuilder<E,B>

All Known Implementing Classes:

Accordion, AccordionItem, AccordionItemBody, ActionList, ActionListGroup, ActionListItem, Alert, AlertActionGroup, AlertDescription, AlertGroup, Avatar, Backdrop, BackToTop, Badge, Banner, BaseChart, BaseComponent, BaseFilterInput, BaseLayout, BaseSearchInput, BaseTextInputGroup, Brand, Breadcrumb, BreadcrumbItem, Bullet, Bullseye, Button, Card, CardActions, CardBody, CardExpandableContent, CardFooter, CardHeader, CardSelectableActions, CardTitle, Cell, Checkbox, CheckboxBody, CheckboxDescription, CodeBlock, CodeBlockAction, CodeBlockActions, CodeBlockHeader, CodeEditor, CodeEditorAction, CodeEditorActions, CodeEditorHeader, CodeEditorHeaderMain, CodeEditorLink, CodeEditorLinks, CodeEditorTab, CodeEditorTabIcon, CodeEditorTabText, ComponentDelegate, Content, DataList, DataListAction, DataListCell, DataListExpandableContent, DataListItem, DescriptionList, DescriptionListDescription, DescriptionListGroup, DescriptionListTerm, Divider, Donut, DonutThreshold, DonutUtilization, Drawer, DrawerBody, DrawerCloseButton, DrawerContent, DrawerPanel, DrawerPanelHead, DrawerSection, Dropdown, DropdownMenu, EmptyState, EmptyStateActions, EmptyStateBody, EmptyStateFooter, ExpandableNavigationGroup, ExpandableSection, ExpandableSectionContent, ExpandableSectionToggle, FilterInput, Finder, FinderColumn, FinderColumnActions, FinderColumnHeader, FinderColumnSearch, FinderItem, FinderItemActions, FinderItemDescription, FinderPreview, Flex, Form, FormActionGroup, FormAlert, FormControl, FormFieldGroup, FormFieldGroupBody, FormFieldGroupHeader, FormGroup, FormGroupControl, FormGroupLabel, FormSection, FormSelect, FormSelectOption, FormSelectOptionGroup, Gallery, Grid, HelperText, HelperTextItem, Hint, HintActions, HintBody, HintFooter, HintTitle, Icon, InputGroup, InputGroupItem, InputGroupText, JumpLinks, JumpLinksItem, JumpLinksList, Label, LabelGroup, Level, List, ListItem, Masthead, MastheadBrand, MastheadContent, MastheadLogo, MastheadMain, MastheadToggle, Menu, MenuContent, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemAction, MenuList, MenuSearch, MenuToggle, MenuToggleAction, Modal, ModalBody, ModalFooter, ModalHeader, ModalHeaderDescription, ModalHeaderTitle, MultiSelect, MultiSelectMenu, MultiTypeahead, Navigation, NavigationGroup, NavigationItem, NavigationLinkText, NotificationBadge, NotificationDrawer, NotificationDrawerBody, NotificationDrawerHeader, NotificationDrawerItem, NotificationDrawerItemBody, NotificationDrawerList, NumberInput, Page, PageBreadcrumb, PageGroup, PageHeader, PageMain, PageNavigation, PageSection, PageSectionBuilder, PageSidebar, PageSidebarBody, PageTabs, PageWizard, Panel, PanelFooter, PanelHeader, PanelMain, Pie, Popover, PopoverBody, PopoverFooter, PopoverHeader, PopperDropdown, PopperMultiSelect, PopperMultiTypeahead, PopperPopover, PopperPopoverBody, PopperPopoverFooter, PopperPopoverHeader, PopperSingleSelect, PopperSingleTypeahead, PopperTooltip, Progress, ProgressStep, ProgressStepper, Radio, RadioBody, RadioDescription, SearchInput, ServiceCard, SimpleList, SimpleListGroup, SimpleListItem, SingleSelect, SingleSelectMenu, SingleTypeahead, Skeleton, SkipToContent, Slider, SliderActions, Split, Stack, SubComponent, Switch, Tab, TabContent, TabContentBody, Table, TableCaption, TableText, Tabs, Tbody, Td, TemplateComponent, TextArea, TextInput, TextInputGroup, TextInputGroupUtilities, Th, Thead, ThemeSelector, Timestamp, Title, TitleCell, ToggleGroup, ToggleGroupItem, Toolbar, ToolbarContent, ToolbarFilterContent, ToolbarFilterLabelGroup, ToolbarGroup, ToolbarItem, ToolbarToggleGroup, Tooltip, Tr, TreeView, TreeViewItem, Truncate, Wizard, WizardFooter, WizardHeader, WizardHeaderDescription, WizardHeaderTitle, WizardNav, WizardNavItem, WizardStep

public interface OuiaSupport<E extends HTMLElement, B extends TypedBuilder<E,B>>
extends TypedBuilder<E,B>, IsElement<E>

Interface for components that support Open UI Automation. Implement this interface in custom components to participate in OUIA without extending PatternFly Java base classes.

Usage:

public class MyWidget implements IsElement<HTMLElement>, OuiaSupport<HTMLElement, MyWidget> {

    public MyWidget() {
        initOuia();
    }

    @Override
    public String ouiaComponentType() {
        return "MyApp/MyWidget";
    }
}

See Also:

• Ouia

Method Summary

Modifier and Type	Method	Description
default void	initOuia()	Initializes OUIA attributes (data-ouia-component-type and data-ouia-safe) on this component's element.
default void	initOuia(String id)	Initializes OUIA attributes with a component ID on this component's element.
String	ouiaComponentType()	Returns the OUIA component type identifier (e.g.
default B	ouiaId(String id)	Sets the data-ouia-component-id attribute on this component's element.
default void	ouiaSafe(boolean safe)	Sets the data-ouia-safe attribute on this component's element.
default void	ouiaTransition()	Marks the element as unsafe during a CSS transition and restores it to safe afterward.

Methods inherited from interface IsElement

element

Methods inherited from interface TypedBuilder

that

Method Details

ouiaComponentType

String ouiaComponentType()

Returns the OUIA component type identifier (e.g. "PF6/Component/Button" or "MyApp/MyWidget").

initOuia

default void initOuia()

Initializes OUIA attributes (data-ouia-component-type and data-ouia-safe) on this component's element.

initOuia

default void initOuia(String id)

Initializes OUIA attributes with a component ID on this component's element.

ouiaId

default B ouiaId(String id)

Sets the data-ouia-component-id attribute on this component's element.

ouiaSafe

default void ouiaSafe(boolean safe)

Sets the data-ouia-safe attribute on this component's element.

ouiaTransition

default void ouiaTransition()

Marks the element as unsafe during a CSS transition and restores it to safe afterward.