Nodify_Interactivity_IKeyboardNavigationLayerGroup

IKeyboardNavigationLayerGroup Interface

Namespace: Nodify.Interactivity

Assembly: Nodify

Implements: IReadOnlyCollection<IKeyboardNavigationLayer>

Derived: NodifyEditor

References: IKeyboardNavigationLayer, KeyboardNavigationLayerId

Represents a group of keyboard navigation layers that can be activated and navigated through.

public interface IKeyboardNavigationLayerGroup : IReadOnlyCollection<IKeyboardNavigationLayer>  

Properties

ActiveNavigationLayer

The current active keyboard navigation layer in the group, if any.

public virtual IKeyboardNavigationLayer ActiveNavigationLayer { get; set; }  

Property Value

IKeyboardNavigationLayer

Methods

ActivateNavigationLayer(KeyboardNavigationLayerId)

Activates the specified keyboard navigation layer, making it the active layer for focus management.

public virtual bool ActivateNavigationLayer(KeyboardNavigationLayerId layerId);  

Parameters

layerId KeyboardNavigationLayerId: The navigation layer id to activate.

Returns

Boolean: Returns true if the navigation layer was activated, false otherwise.

ActivateNextNavigationLayer()

Activates the next keyboard navigation layer in the group, allowing focus to be restored to the last focused element in that layer.

public virtual bool ActivateNextNavigationLayer();  

Returns

Boolean: Returns true if the navigation layer was activated, false otherwise.

ActivatePreviousNavigationLayer()

Activates the previous keyboard navigation layer in the group, allowing focus to be restored to the last focused element in that layer.

public virtual bool ActivatePreviousNavigationLayer();  

Returns

Boolean: Returns true if the navigation layer was activated, false otherwise.

RegisterNavigationLayer(IKeyboardNavigationLayer)

Registers a new keyboard navigation layer to the group, allowing it to handle focus movement and restoration.

public virtual bool RegisterNavigationLayer(IKeyboardNavigationLayer layer);  

Parameters

layer IKeyboardNavigationLayer: The navigation layer.

Returns

Boolean

RemoveNavigationLayer(KeyboardNavigationLayerId)

Removes the specified keyboard navigation layer from the group.

public virtual bool RemoveNavigationLayer(KeyboardNavigationLayerId layerId);  

Parameters

layerId KeyboardNavigationLayerId: The navigation layer id.

Returns

Boolean: Returns true if the layer was removed, false otherwise.

Events

ActiveNavigationLayerChanged

Event that is raised when the active keyboard navigation layer changes.

public virtual event Action<KeyboardNavigationLayerId> ActiveNavigationLayerChanged;  

Event Type

Action<KeyboardNavigationLayerId>