Kanzi  3.9.9
Kanzi Engine Java API
FocusScopeType Enum Reference

Specifies focus scope types. More...

Inheritance diagram for FocusScopeType:
[legend]

Public Member Functions

 FocusScopeType (int value)
 Constructs a FocusScopeType of an integer value. More...
 
 FocusScopeType (FocusScopeType enum_)
 Constructs a copy of a FocusScopeType object. More...
 
int getValue ()
 Returns the integer value of the enumeration constant. More...
 
final int swigValue ()
 Returns the integer value of the enumeration constant. More...
 

Static Public Member Functions

static FocusScopeType swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant. More...
 
static FocusScopeType toEnum (int value)
 Converts an integer value to the matching enumeration constant. More...
 

Public Attributes

 AutoClosingModal =(4)
 Auto-closing modal overlay is similar to modal overlay, except that when the overlay is an Activity in a
Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input originates from outside
the boundaries of that Activity. More...
 
 AutoClosingModeless =(6)
 Auto-closing modeless overlay is similar to modeless overlay, except that when the overlay is an
Activity in a Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input
originates from outside the boundaries of that Activity. More...
 
 Fence =(2)
 Focus fence keeps the focus navigation inside the scope and does not allow the focus navigation to enter
or leave that scope.
 
 Group =(1)
 Focus group groups focusable nodes. More...
 
 Modal =(3)
 Modal overlay blocks the key and touch input that originates from outside its boundaries and keeps the
focus navigation within the overlay boundaries, just like a focus fence. More...
 
 Modeless =(5)
 Modeless overlay propagates the key and touch input that originates from outside its boundaries, but
keeps the focus navigation within the focus scope boundaries, just like a modal overlay. More...
 
 NoScope =(0)
 Removes previously set focus scope data from a Node or focus scope info. More...
 
 Popup =(4)
 Sets a node to be a popup overlay focus scope. More...
 

Detailed Description

Specifies focus scope types.

Constructor & Destructor Documentation

FocusScopeType ( int  value)

Constructs a FocusScopeType of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

Constructs a copy of a FocusScopeType object.

Parameters
enum_FocusScopeType to be copy constructed.

Member Function Documentation

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

static FocusScopeType swigToEnum ( int  swigValue)
static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters
swigValueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.
final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.
static FocusScopeType toEnum ( int  value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

Member Data Documentation

AutoClosingModal =(4)

Auto-closing modal overlay is similar to modal overlay, except that when the overlay is an Activity in a
Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input originates from outside
the boundaries of that Activity.



When input occurs outside the boundaries of an auto-closing modal focus scope, Kanzi dispatches the
FocusManager::InputOutsideOverlayMessage to the focus scope node, and suppresses that input. A Parallel
Activity Host automatically handles the InputOutsideOverlayMessage message sent by an Activity which is an
auto-closing modal overlay.

AutoClosingModeless =(6)

Auto-closing modeless overlay is similar to modeless overlay, except that when the overlay is an
Activity in a Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input
originates from outside the boundaries of that Activity.



When input occurs outside the boundaries of an auto-closing modeless focus scope, Kanzi dispatches the
FocusManager::InputOutsideOverlayMessage to the focus scope node. A Parallel Activity Host automatically
handles the InputOutsideOverlayMessage message sent by an Activity which is an auto-closing modeless overlay.

Group =(1)

Focus group groups focusable nodes.

You can move the focus to a focus group and out of the focus group.

Modal =(3)

Modal overlay blocks the key and touch input that originates from outside its boundaries and keeps the
focus navigation within the overlay boundaries, just like a focus fence.

Every Kanzi application has at least
one modal overlay: the Screen node.

When input occurs outside the boundaries of a modal focus scope, Kanzi dispatches the
FocusManager::InputOutsideOverlayMessage to the focus scope node.

Modeless =(5)

Modeless overlay propagates the key and touch input that originates from outside its boundaries, but
keeps the focus navigation within the focus scope boundaries, just like a modal overlay.



When input occurs outside the boundaries of a modeless focus scope, Kanzi dispatches the
FocusManager::InputOutsideOverlayMessage to the focus scope node.

NoScope =(0)

Removes previously set focus scope data from a Node or focus scope info.

Kanzi uses this value internally.

Popup =(4)

Sets a node to be a popup overlay focus scope.


Deprecated In Kanzi 3.9.2. Use FocusScopeType::AutoClosingModal instead.