net.rim.device.api.ui.component
Interface ActiveFieldCookie


public interface ActiveFieldCookie

Describes functionality provided by cookies that get added to active fields.

See Also:
ActiveRichTextField, ActiveAutoTextEditField
Since:
BlackBerry API 4.0.0

Method Summary
 MenuItem getFocusVerbs(CookieProvider provider, Object context, Vector items)
          Retrieves set of menu items appropriate for this cookie, given context.
 boolean invokeApplicationKeyVerb()
          Invoked when an application key-press event is invoked on an active field with this cookie in focus.
 



Method Detail

getFocusVerbs

MenuItem getFocusVerbs(CookieProvider provider,
                       Object context,
                       Vector items)
Retrieves set of menu items appropriate for this cookie, given context.

Parameters:
provider - The cookie-provider, typically an active field instance of some sort.
context - Information about the current active field.
items - An empty vector to contain the retrieved menu items.
Returns:
Default menu item (verb) for the retrieved list.
Since:
BlackBerry API 4.0.0

invokeApplicationKeyVerb

boolean invokeApplicationKeyVerb()
Invoked when an application key-press event is invoked on an active field with this cookie in focus.

Returns:
True if this cookie consumed the event; otherwise, false.
Since:
BlackBerry API 4.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.