net.rim.blackberry.api.options
Interface ExtendedOptionsProvider

All Superinterfaces:

OptionsProvider

public interface ExtendedOptionsProvider
extends OptionsProvider

Option providers can add entries into the device's Options screen. The ExtendedOptionsProvider interface, allows providers to integrate with the search, menu, and clean up provided by Options.

You must implement this interface to add items to the Options screen. You register as a provider with the OptionsManager by invoking OptionsManager.registerOptionsProvider().

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 7.0.0

Method Summary
	void	dispose() Signals that the option provider should free any resources.
	String	getDescription() Provide a brief description of the option provider.
	EncodedImage	getIcon() Returns an icon that represents this option provider.
	String[]	getKeyWords() Returns a set of keywords associated with this option provider.

Methods inherited from interface net.rim.blackberry.api.options.OptionsProvider

getTitle, populateMainScreen, save

Method Detail

getDescription

String getDescription()

Provide a brief description of the option provider.

The Options application does not provide a default description of option providers. If null or the empty string is returned, there will be whitespace where the description text should be. If both getDescription() and getIcon() return null, only the title will be displayed (both icon and description fields will be ignored).

Returns:

A brief descriptive string or null.

See Also:

OptionsProvider.getTitle(), ExtendedOptionsProvider.getKeyWords(), ExtendedOptionsProvider.getIcon()

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 7.0.0

getKeyWords

String[] getKeyWords()

Returns a set of keywords associated with this option provider.

The keywords, represented by a set of strings, are used in the Universal search application to find the option provider. The provider should return a null if it does not have any keywords.

Returns:

An array of keyword strings or null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 7.0.0

getIcon

EncodedImage getIcon()

Returns an icon that represents this option provider.

Returning null will cause the icon to be ignored. If the icon size does not match the icons displayed in the Options list, it will be resized to fit.

Returns:

An icon or null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 7.0.0

dispose

void dispose()

Signals that the option provider should free any resources.

This is typically called when the provider's MainScreen object from OptionsProvider.populateMainScreen(net.rim.device.api.ui.container.MainScreen) is released by the UI. Thus, populateMainScreen may be considered the complimentary function to dispose.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 7.0.0