SHOW Signed
 

net.rim.blackberry.api.pdap
Interface BlackBerryPIMList

All Superinterfaces:
PIMList
All Known Subinterfaces:
BlackBerryContactList, BlackBerryEventList, BlackBerryMemoList, BlackBerryToDoList

public interface BlackBerryPIMList
extends PIMList

Contains the functionality for the BlackBerry-specific implementation of the PIMList.

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:
JDE 4.0.0

Field Summary
 
Fields inherited from interface javax.microedition.pim.PIMList
UNCATEGORIZED
 
Method Summary
 Category: Signed  void addListener(PIMListListener listener)
          Adds a PIM list listener to this PIM list.
 Category: Signed  boolean isFieldLabelSettable(int field)
          Determines whether or not a field label can be set.
 Category: Signed  void removeListener(PIMListListener listener)
          Removes a PIM list listener from this PIM list.
 Category: Signed  void setFieldLabel(int field, String value)
          Sets a label for a given field.
 
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

addListener

public void addListener(PIMListListener listener)
Adds a PIM list listener to this PIM list.

Note that the listener will remain associated with the native device database even after the correspoding PIM list has been deleted. To remove the listener use 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.

Parameters:
listener - PIM list listener to add.
Throws:
NullPointerException - if listener is null.
Since:
JDE 4.0.0
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.

isFieldLabelSettable

public boolean isFieldLabelSettable(int field)
Determines whether or not a field label can be set.
Parameters:
field - Field to check.
Returns:
True if the label for the provided field can be set; otherwise, false.
Since:
JDE 4.0.0
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.

removeListener

public void removeListener(PIMListListener listener)
Removes a PIM list listener from this PIM list.
Parameters:
listener - PIM list listener to remove; if null then this method does nothing and returns without throwing any exceptions.
Since:
JDE 4.0.0
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.

setFieldLabel

public void setFieldLabel(int field,
                          String value)
Sets a label for a given field.

This method silently fails if the field is invalid, or the field label for the specified field is not settable. Use 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.

Parameters:
field - Field for which to set a label.
value - String value representing the new label for the field.
Since:
JDE 4.0.0
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.



Copyright 1999-2009 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.