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 Summary
Fields Modifier and Type Field Description static int
ENGINE_NAME
The engine by plug-in name, e.g.static int
ENGINE_UI
The engine: UI.static int
ENGINE_VS
The engine: VirtualSpace.static IFocusComp
NO_CHANGE
The focus component to return when no change of focus is requested.
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IFocusComp
processFocusMapping(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
null
to let the default focus engines handle the mapping,
to leave focus unchanged.NO_CHANGE
Return value is an instance of a
of the correct type:IFocusComp
- Any
destination
:null
for default mapping engine processing, destination
is
:ENGINE_UI
an instance of a
that implementsUIComp
,IUIFocusComp
destination
is
:ENGINE_VS
an instance of a
, i.e. one ofIVSComponent
,VirtualSpace
,VSField
,VSAction
orVSTable
.VSGroup
- Parameters:
appGyro
- The application session gyro.clientGyro
- The client session gyro when it applies (could benull
for 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,
null
for default processing, or
to leave focus unchanged.NO_CHANGE
- Any