Table of Contents

Class KeyListener

Namespace
Android.Text.Method
Assembly
MASES.Netdroid.dll
public class KeyListener : JVMBridgeListener, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition, IKeyListener
Inheritance
KeyListener
Implements
Derived
Extension Methods

Constructors

KeyListener(IJVMBridgeBaseInitializer)

Initializer used internally by JCOBridge. Do not use directly.

[Obsolete("This public initializer is needed for JCOBridge internal use, other uses can produce unidentifiable behaviors.")]
public KeyListener(IJVMBridgeBaseInitializer initializer)

Parameters

initializer IJVMBridgeBaseInitializer

KeyListener(params object[])

Generic constructor used by JCOBridge when a derived class needs to forward arguments to the base JVMBridgeBase class.

public KeyListener(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnClearMetaKeyState

public Action<View, Editable, int> OnClearMetaKeyState { get; set; }

Property Value

Action<View, Editable, int>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

OnGetInputType

public Func<int> OnGetInputType { get; set; }

Property Value

Func<int>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

OnGetInputTypeDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<int> OnGetInputTypeDispose { get; set; }

Property Value

Action<int>

Remarks

Set OnGetInputTypeDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnOnKeyDown

public Func<View, Editable, int, KeyEvent, bool> OnOnKeyDown { get; set; }

Property Value

Func<View, Editable, int, KeyEvent, bool>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

OnOnKeyDownDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<bool> OnOnKeyDownDispose { get; set; }

Property Value

Action<bool>

Remarks

Set OnOnKeyDownDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnOnKeyOther

public Func<View, Editable, KeyEvent, bool> OnOnKeyOther { get; set; }

Property Value

Func<View, Editable, KeyEvent, bool>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

OnOnKeyOtherDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<bool> OnOnKeyOtherDispose { get; set; }

Property Value

Action<bool>

Remarks

Set OnOnKeyOtherDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnOnKeyUp

public Func<View, Editable, int, KeyEvent, bool> OnOnKeyUp { get; set; }

Property Value

Func<View, Editable, int, KeyEvent, bool>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

OnOnKeyUpDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<bool> OnOnKeyUpDispose { get; set; }

Property Value

Action<bool>

Remarks

Set OnOnKeyUpDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

Methods

ClearMetaKeyState(View, Editable, int)

public virtual void ClearMetaKeyState(View arg0, Editable arg1, int arg2)

Parameters

arg0 View

View

arg1 Editable

Editable

arg2 int

int

GetInputType()

public virtual int GetInputType()

Returns

int

int

InitializeHandlers(Type)

Handlers initializer for KeyListener

protected virtual void InitializeHandlers(Type listenerRuntimeType)

Parameters

listenerRuntimeType Type

ListenerShallManageEvent(int)

Invoked from the JVMBridgeListener on each received event to notify the user which can decide to abort the execution for the specific event returning false

protected override bool ListenerShallManageEvent(int eventIndex)

Parameters

eventIndex int

The index of the event triggered as returned from AddEventHandler(string, EventHandler) or AddEventHandler<TDataClass>(string, EventHandler<CLRListenerEventArgs<TDataClass>>)

Returns

bool

Returns true to continue event evaluation, false to return the control to the JVM

Remarks

By default every event continues the execution and reads the data from JVM; this implies an extra cost which can be limited using ListenerShallManageEvent(int) or the ListenerShallManageEventIndex/ListenerShallManageEventName handlers. Returning false the control is immediately returned to the JVM, anyway the user has received the notification. It can be useful in scenarios where the user is interested in few events and the other are simply discarded to optimize the execution speed. By default, this function invokes ListenerShallManageEventIndex, then try ListenerShallManageEventName if they are set or return true

ListenerShallManageEventHandlers(int)

protected virtual bool ListenerShallManageEventHandlers(int eventIndex)

Parameters

eventIndex int

Returns

bool

OnKeyDown(View, Editable, int, KeyEvent)

public virtual bool OnKeyDown(View arg0, Editable arg1, int arg2, KeyEvent arg3)

Parameters

arg0 View

View

arg1 Editable

Editable

arg2 int

int

arg3 KeyEvent

KeyEvent

Returns

bool

bool

OnKeyOther(View, Editable, KeyEvent)

public virtual bool OnKeyOther(View arg0, Editable arg1, KeyEvent arg2)

Parameters

arg0 View

View

arg1 Editable

Editable

arg2 KeyEvent

KeyEvent

Returns

bool

bool

OnKeyUp(View, Editable, int, KeyEvent)

public virtual bool OnKeyUp(View arg0, Editable arg1, int arg2, KeyEvent arg3)

Parameters

arg0 View

View

arg1 Editable

Editable

arg2 int

int

arg3 KeyEvent

KeyEvent

Returns

bool

bool