|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface BlackBerryPIMList
Contains the functionality for the BlackBerry-specific implementation of the PIMList.
| Field Summary |
|---|
| Fields inherited from interface javax.microedition.pim.PIMList |
|---|
UNCATEGORIZED |
| Method Summary | ||
|---|---|---|
|
void |
addListener(PIMListListener listener)
Adds a PIM list listener to this PIM list. |
|
long |
getPIMListUID()
Returns the unique identifier for this PIM list. |
|
boolean |
isFieldLabelSettable(int field)
Determines whether or not a field label can be set. |
|
boolean |
isWirelessSyncCapable()
Returns whether or not the this PIMList is capable of wireless synchronization with a BlackBerry Enterprise Server. |
|
boolean |
isWirelessSyncEnabled()
Returns whether or not the user has enabled this PIMList for wireless synchronization with a BlackBerry Enterprise Server. |
|
void |
removeListener(PIMListListener listener)
Removes a PIM list listener from this PIM list. |
|
void |
setFieldLabel(int field,
String value)
Sets a label for a given field. |
|
int |
size()
Returns the number of items in this PIMList. |
| Methods inherited from interface javax.microedition.pim.PIMList |
|---|
addCategory, close, deleteCategory, getArrayElementLabel, getAttributeLabel, getCategories, getFieldDataType, getFieldLabel, getName, getSupportedArrayElements, getSupportedAttributes, getSupportedFields, isCategory, isSupportedArrayElement, isSupportedAttribute, isSupportedField, items, items, items, itemsByCategory, maxCategories, maxValues, renameCategory, stringArraySize |
| Method Detail |
|---|
void addListener(PIMListListener listener)
Note that the listener will remain associated with the native device
database even after the corresponding PIM list has been
deleted. To remove the listener use BlackBerryPIMList.removeListener(net.rim.blackberry.api.pdap.PIMListListener).
method.
Note that usage of PIMListListener3 is deprecated; however,
for backwards compatibility, when a PIMListListener3 is added
via this method it will be wrapped in a ListChangeListener and
will still receive notifications about the default PIM list changes.
listener - PIM list listener to add.
NullPointerException - if listener is null.void removeListener(PIMListListener listener)
listener - PIM list listener to remove; if null then this method
does nothing and returns without throwing any exceptions.
void setFieldLabel(int field,
String value)
This method silently fails if the field is invalid, or the field
label for the specified field is not settable. Use
BlackBerryPIMList.isFieldLabelSettable(int) method to determine if the field label is
settable for this field.
Currently only the BlackBerryContact.USER1 through
BlackBerryContact.USER4 fields have settable labels.
field - Field for which to set a label.value - String value representing the new label for the field.boolean isFieldLabelSettable(int field)
field - Field to check.
long getPIMListUID()
BlackBerryPIM.openPIMList(int, int, long).
int size()
The returned value should be used for presentation and optimization purposes only, such as a value to present to a user or an initial size for a Vector that will contain the items. For example, it should not be used as the number of elements that will be returned from the Enumeration returned from items() since items may be added to and/or removed from the list by other threads during the iteration, causing the size to be incorrect.
SecurityException - if the application is not given permission to read the PIM list or
the list is opened WRITE_ONLY.boolean isWirelessSyncCapable()
BlackBerryPIMList.isWirelessSyncEnabled() to determine if the user has
disabled it.
If this PIMList is closed or the underlying PIM database has been deleted then this method returns false.
boolean isWirelessSyncEnabled()
If this PIMList is closed or the underlying PIM database has been deleted then this method
returns false. Also, if the PIMList is not even capable of wireless synchronization, which
can be determined by BlackBerryPIMList.isWirelessSyncCapable(), then this method returns false.
|
|||||||||
| 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.