Package com.iizix.api.vs

Interface IVSFocusHandler

public interface IVSFocusHandler
An interface used for advanced processing of focus mappings when the standard engines cannot be used. Typically, it is used to map VirtualSpace to the UI or vice versa. This class is instantiated when the VirtualSpace is virtualized for each application session.
Author:
Christopher Mindus

  • Field Details

    • ENGINE_NAME

      static final int ENGINE_NAME
      The engine by plug-in name, e.g. "com.iizix.term" for Terminal.
      See Also:

    • ENGINE_VS

      static final int ENGINE_VS
      The engine: VirtualSpace.
      See Also:

    • ENGINE_UI

      static final int ENGINE_UI
      The engine: UI.
      See Also:

    • NO_CHANGE

      static final IFocusComp NO_CHANGE
      The focus component to return when no change of focus is requested.

  • Method Details

    • processFocusMapping

      IFocusComp processFocusMapping(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, int destination, IFocusComp focusComp, int source, IFocusComp currentFocus)
      Called to return the component to focus.

      Return null to let the default focus engines handle the mapping, NO_CHANGE to leave focus unchanged.

      Return value is an instance of a IFocusComp of the correct type:

      Parameters:
      appGyro - The application session gyro.
      clientGyro - The client session gyro when it applies (could be null for e.g. Terminal).
      destination - The destination component type requested.
      focusComp - The component that received focus.
      source - The source component type provided in focusComp.
      currentFocus - The current focus component, null for none.
      Returns:
      The component to focus of the destination type, null for default processing, or NO_CHANGE to leave focus unchanged.