Package io.jmix.flowui.xml.facet.loader

Interface FacetLoader<F extends Facet>

Type Parameters:
F - the type of facet being loaded
All Known Implementing Classes:
AbstractDataLoadCoordinatorFacetLoader, AbstractFacetLoader, AbstractSettingsFacetLoader, DynAttrFacetLoader, FragmentDataLoadCoordinatorFacetLoader, FragmentSettingsFacetLoader, TimerFacetLoader, UrlQueryParametersFacetLoader, ViewDataLoadCoordinatorFacetLoader, ViewSettingsFacetLoader
public interface FacetLoader<F extends Facet>
Defined the contract for loading and initializing facets (non-UI components) from XML descriptors.

  • Method Summary

    Modifier and Type
    Method
    Description
    ComponentLoader.Context
    getContext()
    Returns the context associated with the current facet loading and initialization process.
    org.dom4j.Element
    getElement()
     
    F
    getResultFacet()
     
    void
    initFacet()
    Creates result facet by XML-element.
    void
    loadFacet()
    Loads facet properties by XML definition.
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
    Sets the application context for the current component loader.
    void
    setContext(ComponentLoader.Context context)
    Sets the context for loading and initializing facet components.
    void
    setElement(org.dom4j.Element element)
    Sets the specified XML element to be associated with the facet loader.

  • Method Details

    • initFacet

      void initFacet()
      Creates result facet by XML-element.

    • loadFacet

      void loadFacet()
      Loads facet properties by XML definition.

    • getResultFacet

      F getResultFacet()
      Returns:
      result facet

    • setApplicationContext

      void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Sets the application context for the current component loader.
      Parameters:
      applicationContext - the ApplicationContext instance to set

    • getElement

      org.dom4j.Element getElement()
      Returns:
      XML element associated with the facet loader

    • setElement

      void setElement(org.dom4j.Element element)
      Sets the specified XML element to be associated with the facet loader.
      Parameters:
      element - the Element instance representing the XML configuration for a facet component

    • getContext

      ComponentLoader.Context getContext()
      Returns the context associated with the current facet loading and initialization process.
      Returns:
      the ComponentLoader.Context instance

    • setContext

      void setContext(ComponentLoader.Context context)
      Sets the context for loading and initializing facet components.
      Parameters:
      context - the ComponentLoader.Context instance to set