Class AbstractExplorerWidget<C extends com.vaadin.flow.component.Component>

  • Type Parameters:
    C - The type of the graphical component that contains the explorer.
    Direct Known Subclasses:
    AttachmentExplorer, AuditTrailExplorer, RelationshipExplorer, SpecialChildrenExplorer

    public abstract class AbstractExplorerWidget<C extends com.vaadin.flow.component.Component>
    extends Object
    A component designed to explore a model structures such as relationships, attachments, containment hierarchy, etc.Subclasses will behave like factories, just like
    Charles Edward Bedon Cortazar <>
    • Constructor Detail

      • AbstractExplorerWidget

        public AbstractExplorerWidget()
    • Method Detail

      • getName

        public abstract String getName()
        Obtains the name of the explorer. This name will be used as label in lists and context menus.
        The explorer name.
      • getDescription

        public abstract String getDescription()
        Obtains the description of the explorer. This will be used in help texts and tool tip texts.
        The description of what the explorer does.
      • appliesTo

        public abstract String appliesTo()
        Tells the consumer what type of objects the explorer is suitable for. For example, a explorer of physical connection would be apply to GenericPhysicalConnection and so on.
        The type of object the explorer is intended to.
      • build

        public abstract C build​(BusinessObjectLight selectedObject)
        Creates an embeddable visual component withe the explorer.
        selectedObject - The object from which the explorer will be built.
        The embeddable component.