net.rim.blackberry.api.options
Interface OptionsProvider

All Known Subinterfaces:

ExtendedOptionsProvider

public interface OptionsProvider

Option providers may add entries into the system's Options screen.

An application must implement this interface to add items to the Options screen; register as a provider with the OptionsManager by invoking 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 3.6.0, 3.6

Method Summary
	String	getTitle() Retrieves the title to place in the Options screen.
	void	populateMainScreen(MainScreen mainScreen) Creates the main screen for this option item.
	void	save() Saves data for this option item.

Method Detail

getTitle

String getTitle()

Retrieves the title to place in the Options screen.

Sub-classes that implement this method must provide the string the system should place in the Options screen.

Returns:

Title for this options item.

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 3.6.0

populateMainScreen

void populateMainScreen(MainScreen mainScreen)

Creates the main screen for this option item.

This screen appears when a user selects your item in the Options screen. In your implementation of this method, add one or more fields to the screen to display options. Any static or class level fields in MainScreen must be removed or a new instance of the field must be instantiated each time this method is called.

Parameters:

mainScreen - Main screen for this option item.

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 3.6.0

save

void save()

Saves data for this option item.

In your implementation of this method, you should commit the selected values for fields on your option screen to a persistent object.

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 3.6.0