Kanzi  3.9.4
Java API
FocusManagerMetadata Interface Reference

Metadata definitions for FocusManager. More...

Classes

class  FocusEnteredFocusScopeMessageArguments
 Metadata definitions for FocusEnteredFocusScopeMessageArguments. More...
 
class  FocusLeftFocusScopeMessageArguments
 Metadata definitions for FocusLeftFocusScopeMessageArguments. More...
 
class  InputOutsideOverlayMessageArguments
 Metadata definitions for InputOutsideOverlayMessageArguments. More...
 
class  MoveFocusMessageArguments
 Metadata definitions for MoveFocusMessageArguments. More...
 
class  OverlayBroughtToFrontMessageArguments
 Metadata definitions for OverlayBroughtToFrontMessageArguments. More...
 
class  OverlayGainedFocusMessageArguments
 Metadata definitions for OverlayGainedFocusMessageArguments. More...
 
class  OverlayLostFocusMessageArguments
 Metadata definitions for OverlayLostFocusMessageArguments. More...
 
class  OverlaySentToBackMessageArguments
 Metadata definitions for OverlaySentToBackMessageArguments. More...
 
class  PostFocusMessageArguments
 Metadata definitions for PostFocusMessageArguments. More...
 
class  PreFocusMessageArguments
 Metadata definitions for PreFocusMessageArguments. More...
 
class  ScopeStateChangeMessageArguments
 Metadata definitions for ScopeStateChangeMessageArguments. More...
 

Public Attributes

DynamicMessageType< FocusManagerMetadata.PreFocusMessageArguments > AboutToGainFocusMessage
 Kanzi sends this message before a focusable node receives focus. More...
 
DynamicMessageType< FocusManagerMetadata.PreFocusMessageArguments > AboutToLoseFocusMessage
 Kanzi sends this message before the focused node loses focus. More...
 
DynamicPropertyType< Boolean > CyclicFocusNavigationProperty
 Sets whether the focus chain navigation within the focus scope is cyclic. More...
 
DynamicMessageType< FocusManagerMetadata.FocusEnteredFocusScopeMessageArguments > FocusEnteredFocusScopeMessage
 When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus. More...
 
DynamicMessageType< FocusManagerMetadata.PostFocusMessageArguments > FocusGainedMessage
 Kanzi sends this message to the node that received focus. More...
 
DynamicMessageType< FocusManagerMetadata.FocusLeftFocusScopeMessageArguments > FocusLeftFocusScopeMessage
 When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus. More...
 
DynamicMessageType< FocusManagerMetadata.PostFocusMessageArguments > FocusLostMessage
 Kanzi sends this message to the node that lost focus. More...
 
DynamicPropertyType< Integer > FocusOnPressProperty
 Sets where to set the focus when the user presses the node that has this property: More...
 
DynamicPropertyType< Integer > FocusOrderProperty
 Sets the focus chain order of the node within the focus scope. More...
 
DynamicPropertyType< Integer > FocusScopeTypeProperty
 Sets the type of the focus scope node: More...
 
DynamicMessageType< FocusManagerMetadata.InputOutsideOverlayMessageArguments > InputOutsideOverlayMessageMessage
 Kanzi sends this message to an overlay focus scope when the application area outside the boundaries of that overlay receives input. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.FocusManager")
 Metaclass for FocusManager.
 
DynamicMessageType< FocusManagerMetadata.MoveFocusMessageArguments > MoveScopeFocusBackwardMessage
 When a focus scope node receives this message, it moves the focus to the previous focusable node of the focus scope. More...
 
DynamicMessageType< FocusManagerMetadata.MoveFocusMessageArguments > MoveScopeFocusForwardMessage
 When a focus scope node receives this message, it moves the focus to the next focusable node of the focus scope. More...
 
DynamicMessageType< FocusManagerMetadata.OverlayBroughtToFrontMessageArguments > OverlayBroughtToFrontMessage
 Occurs when an overlay focus scope becomes the foremost overlay scope in the overlay focus scope stack. More...
 
DynamicMessageType< FocusManagerMetadata.OverlayGainedFocusMessageArguments > OverlayGainedFocusMessage
 When an overlay scope gains focus, Kanzi sends this message to the overlay scope node that contains the node that gains focus. More...
 
DynamicMessageType< FocusManagerMetadata.OverlayLostFocusMessageArguments > OverlayLostFocusMessage
 When an overlay scope loses focus, Kanzi sends this message to the overlay scope node that contains the node that loses focus. More...
 
DynamicMessageType< FocusManagerMetadata.OverlaySentToBackMessageArguments > OverlaySentToBackMessage
 Occurs when an overlay focus scope is no longer the foremost overlay scope in the overlay focus scope stack. More...
 
DynamicMessageType< FocusManagerMetadata.OverlayBroughtToFrontMessageArguments > ScopeBroughtToFrontMessage
 Occurs when an overlay focus scope is brought to front. More...
 
DynamicMessageType< FocusManagerMetadata.OverlaySentToBackMessageArguments > ScopeSentToBackMessage
 Occurs when a foremost overlay focus scope is sent to back. More...
 

Detailed Description

Metadata definitions for FocusManager.

Member Data Documentation

◆ AboutToGainFocusMessage

DynamicMessageType<FocusManagerMetadata.PreFocusMessageArguments> AboutToGainFocusMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AboutToGainFocus", FocusManagerMetadata.PreFocusMessageArguments.class)

Kanzi sends this message before a focusable node receives focus.

◆ AboutToLoseFocusMessage

DynamicMessageType<FocusManagerMetadata.PreFocusMessageArguments> AboutToLoseFocusMessage
Initial value:
=
new DynamicMessageType<>(
"Message.AboutToLoseFocus", FocusManagerMetadata.PreFocusMessageArguments.class)

Kanzi sends this message before the focused node loses focus.

◆ CyclicFocusNavigationProperty

DynamicPropertyType<Boolean> CyclicFocusNavigationProperty
Initial value:
=
new DynamicPropertyType<>("FocusManager.CyclicFocusNavigation", Boolean.class)

Sets whether the focus chain navigation within the focus scope is cyclic.

When you enable this property:

  • When the user navigates in the forward direction and the focus reaches the last focusable UI element of the focus scope, the focus navigation moves to the first focusable UI element.
  • When the user navigates in the backward direction and the focus reaches the first focusable UI element of the focus scope, the focus navigation moves to the last focusable UI element.

◆ FocusEnteredFocusScopeMessage

DynamicMessageType<FocusManagerMetadata.FocusEnteredFocusScopeMessageArguments> FocusEnteredFocusScopeMessage
Initial value:
= new DynamicMessageType<>("Message.FocusEnteredFocusScope",
FocusManagerMetadata.FocusEnteredFocusScopeMessageArguments.class)

When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus.

◆ FocusGainedMessage

DynamicMessageType<FocusManagerMetadata.PostFocusMessageArguments> FocusGainedMessage
Initial value:
=
new DynamicMessageType<>(
"Message.FocusGained", FocusManagerMetadata.PostFocusMessageArguments.class)

Kanzi sends this message to the node that received focus.

◆ FocusLeftFocusScopeMessage

DynamicMessageType<FocusManagerMetadata.FocusLeftFocusScopeMessageArguments> FocusLeftFocusScopeMessage
Initial value:
= new DynamicMessageType<>("Message.FocusLeftFocusScope",
FocusManagerMetadata.FocusLeftFocusScopeMessageArguments.class)

When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus.

◆ FocusLostMessage

DynamicMessageType<FocusManagerMetadata.PostFocusMessageArguments> FocusLostMessage
Initial value:
=
new DynamicMessageType<>(
"Message.FocusLost", FocusManagerMetadata.PostFocusMessageArguments.class)

Kanzi sends this message to the node that lost focus.

◆ FocusOnPressProperty

DynamicPropertyType<Integer> FocusOnPressProperty
Initial value:
=
new DynamicPropertyType<>("FocusManager.FocusOnPress", Integer.class)

Sets where to set the focus when the user presses the node that has this property:

  • None (0) keeps the focus where it was. This is the default.
  • Node (1) sets the focus to the node.
  • Node or ancestor (2) sets the focus to the node or, if that fails, to the closest focusable ancestor node.
  • Node or overlay (3) sets the focus to the node or, if that fails, to the closest ancestor overlay scope, which then forwards the focus according to its settings.

The descendants of the node where you set this property inherit value of the property.

◆ FocusOrderProperty

DynamicPropertyType<Integer> FocusOrderProperty
Initial value:
=
new DynamicPropertyType<>("FocusManager.FocusOrder", Integer.class)

Sets the focus chain order of the node within the focus scope.

◆ FocusScopeTypeProperty

DynamicPropertyType<Integer> FocusScopeTypeProperty
Initial value:
=
new DynamicPropertyType<>("FocusManager.FocusScopeType", Integer.class)

Sets the type of the focus scope node:

  • Group groups focusable nodes.
  • Fence keeps the focus chain navigation inside the scope and does not allow the focus chain navigation to enter or leave that scope.
  • Modal overlay blocks the key and touch input that originates outside of its boundaries and keeps the focus navigation within the scope boundaries.
  • Auto-Closing Modal overlay loses focus when key or touch input originates from a node that is outside of its node tree, and suppresses that input.
  • Modeless overlay propagates the key and touch input that originates outside of its boundaries to the nodes outside of its boundaries.
  • Auto-Closing Modeless overlay loses focus when key or touch input originates from a node that is outside of its boundaries, and propagates that input.

◆ InputOutsideOverlayMessageMessage

DynamicMessageType<FocusManagerMetadata.InputOutsideOverlayMessageArguments> InputOutsideOverlayMessageMessage
Initial value:
=
new DynamicMessageType<>("Message.InputOutsideOverlayMessage",
FocusManagerMetadata.InputOutsideOverlayMessageArguments.class)

Kanzi sends this message to an overlay focus scope when the application area outside the boundaries of that overlay receives input.

◆ MoveScopeFocusBackwardMessage

DynamicMessageType<FocusManagerMetadata.MoveFocusMessageArguments> MoveScopeFocusBackwardMessage
Initial value:
= new DynamicMessageType<>(
"Message.MoveScopeFocusBackward", FocusManagerMetadata.MoveFocusMessageArguments.class)

When a focus scope node receives this message, it moves the focus to the previous focusable node of the focus scope.

◆ MoveScopeFocusForwardMessage

DynamicMessageType<FocusManagerMetadata.MoveFocusMessageArguments> MoveScopeFocusForwardMessage
Initial value:
= new DynamicMessageType<>(
"Message.MoveScopeFocusForward", FocusManagerMetadata.MoveFocusMessageArguments.class)

When a focus scope node receives this message, it moves the focus to the next focusable node of the focus scope.

◆ OverlayBroughtToFrontMessage

DynamicMessageType<FocusManagerMetadata.OverlayBroughtToFrontMessageArguments> OverlayBroughtToFrontMessage
Initial value:
=
new DynamicMessageType<>("Message.FocusManager.OverlayBroughtToFront",
FocusManagerMetadata.OverlayBroughtToFrontMessageArguments.class)

Occurs when an overlay focus scope becomes the foremost overlay scope in the overlay focus scope stack.

◆ OverlayGainedFocusMessage

DynamicMessageType<FocusManagerMetadata.OverlayGainedFocusMessageArguments> OverlayGainedFocusMessage
Initial value:
= new DynamicMessageType<>("Message.OverlayGainedFocus",
FocusManagerMetadata.OverlayGainedFocusMessageArguments.class)

When an overlay scope gains focus, Kanzi sends this message to the overlay scope node that contains the node that gains focus.

◆ OverlayLostFocusMessage

DynamicMessageType<FocusManagerMetadata.OverlayLostFocusMessageArguments> OverlayLostFocusMessage
Initial value:
= new DynamicMessageType<>("Message.OverlayLostFocus",
FocusManagerMetadata.OverlayLostFocusMessageArguments.class)

When an overlay scope loses focus, Kanzi sends this message to the overlay scope node that contains the node that loses focus.

◆ OverlaySentToBackMessage

DynamicMessageType<FocusManagerMetadata.OverlaySentToBackMessageArguments> OverlaySentToBackMessage
Initial value:
=
new DynamicMessageType<>("Message.FocusManager.OverlaySentToBack",
FocusManagerMetadata.OverlaySentToBackMessageArguments.class)

Occurs when an overlay focus scope is no longer the foremost overlay scope in the overlay focus scope stack.

◆ ScopeBroughtToFrontMessage

DynamicMessageType<FocusManagerMetadata.OverlayBroughtToFrontMessageArguments> ScopeBroughtToFrontMessage
Initial value:
=
new DynamicMessageType<>("Message.FocusManager.ScopeBroughtToFront",
FocusManagerMetadata.OverlayBroughtToFrontMessageArguments.class)

Occurs when an overlay focus scope is brought to front.

Deprecated. Use Overlay Brought To Front instead.

◆ ScopeSentToBackMessage

DynamicMessageType<FocusManagerMetadata.OverlaySentToBackMessageArguments> ScopeSentToBackMessage
Initial value:
= new DynamicMessageType<>("Message.FocusManager.ScopeSentToBack",
FocusManagerMetadata.OverlaySentToBackMessageArguments.class)

Occurs when a foremost overlay focus scope is sent to back.

Deprecated. Use Overlay Sent to Back instead.