Interface FacadeHandlerContext

All Known Implementing Classes:
FacadeHandlerContextImpl

public interface FacadeHandlerContext
The context for when creating component facades out of components, before marshalling the facades to the client. Not a service.
  • Method Details

    • getFormScope

      String getFormScope()
    • getTextResources

      TextResources getTextResources()
    • getParentFacade

      @Nullable @Nullable ComponentFacade getParentFacade()
      Get the parent facade. When we need it, we can extend the ComponentFacade interface so we can browse the already constructed structure a bit better.

      But in some cases (eg. the table column) we know exacly what the parent must be and thus we can cast or use getCurrentFacade(Class) to retrieve facade.

      Returns:
      the parent facade
    • getPathIdentifier

      @Nullable @Nullable String getPathIdentifier()
      Get the current path identifiert. eg. 'firstname', 'relPrincipal', 'Address' ...
      Returns:
      The identifier, or null if it's not a data component.
    • getCurrentFacade

      <F extends ComponentFacade> F getCurrentFacade(Class<F> clazz)
      See getParentFacade(). Additional possibility to move the cast into the context.
      Type Parameters:
      F - the type in which we expect the facade to be
      Parameters:
      clazz - the class in which we expect the facade to be
      Returns:
      the facade in the specific type
    • getComponent

      Component getComponent()
      Returns the current component, which in fact is just the one you expect, because you already have told the system within the method.

      Use getComponent(Class) when you don't want to cast. This is save because you know the type.

      Returns:
      the current component
    • getComponent

      <T extends Component> T getComponent(Class<T> clazz)
      Type-safe equivalent to the getComponent() method
      Type Parameters:
      T - the type
      Parameters:
      clazz - the class
      Returns:
      the component casted to passed type