Package com.iizix.api.vs
Interface IVSFocusHandler
public interface IVSFocusHandlerAn 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 Summary
Fields Modifier and Type Field Description static intENGINE_NAMEThe engine by plug-in name, e.g.static intENGINE_UIThe engine: UI.static intENGINE_VSThe engine: VirtualSpace.static IFocusCompNO_CHANGEThe focus component to return when no change of focus is requested.
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IFocusCompprocessFocusMapping(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, int destination, IFocusComp focusComp, int source, IFocusComp currentFocus)Called to return the component to focus.
Field Detail
ENGINE_NAME
static final int ENGINE_NAME
The engine by plug-in name, e.g. "com.iizix.term" for Terminal.- See Also:
- Constant Field Values
ENGINE_VS
static final int ENGINE_VS
The engine: VirtualSpace.- See Also:
- Constant Field Values
ENGINE_UI
static final int ENGINE_UI
The engine: UI.- See Also:
- Constant Field Values
NO_CHANGE
static final IFocusComp NO_CHANGE
The focus component to return when no change of focus is requested.
Method Detail
processFocusMapping
IFocusComp processFocusMapping(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, int destination, IFocusComp focusComp, int source, IFocusComp currentFocus)
Called to return the component to focus.Return
nullto let the default focus engines handle the mapping,to leave focus unchanged.NO_CHANGEReturn value is an instance of a
of the correct type:IFocusComp- Any
destination:nullfor default mapping engine processing, destinationis:ENGINE_UI
an instance of athat implementsUIComp,IUIFocusCompdestinationis:ENGINE_VS
an instance of a, i.e. one ofIVSComponent,VirtualSpace,VSField,VSActionorVSTable.VSGroup
- Parameters:
appGyro- The application session gyro.clientGyro- The client session gyro when it applies (could benullfor e.g. Terminal).destination- The destination component type requested.focusComp- The component that received focus.source- The source component type provided infocusComp.currentFocus- The current focus component, null for none.- Returns:
- The component to focus of the destination type,
nullfor default processing, orto leave focus unchanged.NO_CHANGE
- Any