|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.ui.Field
net.rim.device.api.ui.ScrollView
net.rim.device.api.ui.Manager
net.rim.device.api.ui.Screen
net.rim.device.api.ui.container.PopupScreen
net.rim.device.api.lbs.picker.LocationPicker
public class LocationPicker
The LocationPicker API provides a central repository to group individual location pickers such as the GPSLocationPicker
, MapsLocationPicker
,
ContactsLocationPicker
, RecentLocationPicker
, SuggestedLocationPicker
, and EnterLocationPicker
.
Locations are described by a javax.microedition.location.Landmark
object.
Locations selected by the user are stored and available to the user during subsequent location selections. Stored locations are
accessible to any application using the RecentLocationPicker API
.
LocationPicker
. Registered location pickers can be accessed by any application
that uses the LocationPicker API.
If BlackBerry Maps is installed on the device, BlackBerry Maps is registered as a global LocationPicker
. Users may select favorite locations that they saved
in BlackBerry Maps.
The following code sample demonstrates how to add global LocationPickers
:
LocationPicker locationPicker = LocationPicker.getInstance();
Enumeration globalPickers = locationPicker.getGlobalLocationPickers();
while (globalPickers.hasMoreElements()) {
locationPicker.addLocationPicker((LocationPicker.Picker)globalPickers.nextElement());
}
Nested Class Summary | ||
---|---|---|
|
static interface |
LocationPicker.Listener
Interface for receiving events when a location is selected or when a location selection is canceled. |
|
static interface |
LocationPicker.Picker
Interface that defines an individual location picker. |
Field Summary |
---|
Fields inherited from class net.rim.device.api.ui.Screen |
---|
DEFAULT_CLOSE, DEFAULT_MENU, NO_SYSTEM_MENU_ITEMS |
Fields inherited from class net.rim.device.api.ui.Manager |
---|
BOTTOMMOST, DOWNWARD, HORIZONTAL_SCROLL, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_MASK, HORIZONTAL_SCROLL_MASK, LEAVE_BLANK_SPACE, LEFTMOST, LEFTWARD, NO_HORIZONTAL_SCROLL, NO_HORIZONTAL_SCROLLBAR, NO_SCROLL_RESET, NO_VERTICAL_SCROLL, NO_VERTICAL_SCROLLBAR, QUANTA_FONT, RIGHTMOST, RIGHTWARD, TOPMOST, UPWARD, VERTICAL_SCROLL, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_MASK, VERTICAL_SCROLL_MASK |
Method Summary | ||
---|---|---|
|
void |
addLocationPicker(LocationPicker.Picker locationPicker)
Adds an individual location picker to this instance. |
|
void |
cancel()
Cancels the location picker. |
|
Enumeration |
getGlobalLocationPickers()
Returns an enumeration of the available global location pickers. |
|
static LocationPicker |
getInstance()
Returns the default LocationPicker . |
|
static LocationPicker |
getInstance(LocationPicker.Picker[] locationPickers)
Returns the LocationPicker initialized with an array of individual pickers. |
|
void |
insertLocationPickerAt(LocationPicker.Picker locationPicker,
int index)
Inserts an individual location picker into this instance. |
|
static void |
registerGlobalLocationPicker(LocationPicker.Picker locationPicker)
Register a global location picker that is available to all applications. |
|
void |
removeLocationPicker(LocationPicker.Picker locationPicker)
Removes an individual location picker from this instance. |
|
void |
setFreeTextSearch(boolean useFreeTextSearch)
Specifies whether to use free text search (for example, 'Paris', '10 Downing St London UK', '90210 USA'). |
|
void |
setListener(LocationPicker.Listener listener)
Sets the listener for the location picker. |
|
void |
show()
Displays the location picker. |
|
static void |
unregisterGlobalLocationPicker(LocationPicker.Picker locationPicker)
Removes a registered global location picker. |
Methods inherited from class net.rim.device.api.ui.container.PopupScreen |
---|
paint, sublayout |
Methods inherited from class net.rim.device.api.ui.Manager |
---|
addAll, deleteAll, getHorizontalScroll, getPreferredHeightOfChild, getPreferredWidthOfChild, getVerticalScroll, getVirtualHeight, getVirtualWidth, insertAll, invalidateFieldRange, isDownArrowShown, isUpArrowShown, isValidLayout, layout, layoutChild, moveFocus, moveFocus, nextFocus, nextFocus, paintChild, setFocus, setPositionChild, setScrollingInertial, setVirtualExtent, subpaint |
Methods inherited from class net.rim.device.api.ui.ScrollView |
---|
configurationChanged, getHorizontalAdjustment, getVerticalAdjustment, getVisibleHeight, getVisibleWidth, setCurrentLocation, setExtent, setHorizontalAdjustment, setHorizontalScroll, setHorizontalScroll, setScrollListener, setVerticalAdjustment, setVerticalScroll, setVerticalScroll, valueChanged, waitForScrolling |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static LocationPicker getInstance()
LocationPicker
.
LocationPicker
.public static LocationPicker getInstance(LocationPicker.Picker[] locationPickers) throws IllegalStateException
LocationPicker
initialized with an array of individual pickers.
locationPickers
- An array of individual location pickers.
LocationPicker
.
IllegalStateException
- if no location pickers were specified.public static void registerGlobalLocationPicker(LocationPicker.Picker locationPicker)
locationPicker
- A location picker that is available to any application.
ControlledAccessException
- if the application does not have
PERMISSION_CROSS_APPLICATION_COMMUNICATION
permission.public static void unregisterGlobalLocationPicker(LocationPicker.Picker locationPicker)
locationPicker
- A location picker that is available to any application.public void addLocationPicker(LocationPicker.Picker locationPicker)
locationPicker
- The location picker to add to this instance.public void insertLocationPickerAt(LocationPicker.Picker locationPicker, int index)
locationPicker
- The location picker to insert into this instance.index
- The position to insert the locationPicker
.
ArrayIndexOutOfBoundsException
public void removeLocationPicker(LocationPicker.Picker locationPicker)
locationPicker
- The location picker to remove from this instance.public Enumeration getGlobalLocationPickers()
ControlledAccessException
- if the application does not have
PERMISSION_CROSS_APPLICATION_COMMUNICATION
permission.public void setFreeTextSearch(boolean useFreeTextSearch)
useFreeTextSearch
- true
to use free text search, false
otherwise.
ControlledAccessException
- if the application does not have
PERMISSION_CROSS_APPLICATION_COMMUNICATION
permission.public void setListener(LocationPicker.Listener listener)
listener
- The location picker listener. If null
, the current listener is erased.public void show() throws IllegalStateException
IllegalStateException
- if no location pickers were set.
IllegalStateException
- if one or more location picker is null
.public void cancel()
Cancels any active picker including any geocode requests. Any open picker screens are closed. If no picker is active or displayed, this method does nothing.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.