📄 pimlist.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>PIMList (PIM Optional Package 1.0 Spec, Final Release) </TITLE>
<!-- Generated by javadoc on Wed Oct 29 13:13:41 PST 2003 -->
<META NAME="keywords" CONTENT="javax.microedition.pim.PIMList,PIMList interface">
<LINK REL="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT>
function asd()
{
parent.document.title="PIMList (PIM Optional Package 1.0 Spec, Final Release)";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN="3" BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#ffffff" CLASS="NavBarCell1Rev">
<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#eeeeff" CLASS="NavBarCell1">
<A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN="3"><EM> PIM Optional Package 1.0<br>
Final Release</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../javax/microedition/pim/PIMItem.html"><B>PREV
CLASS</B></A> <A HREF="../../../javax/microedition/pim/ToDo.html"><B>NEXT
CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html" TARGET="_top">
<B>FRAMES</B></A> <A HREF="PIMList.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--></SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT>
</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">javax.microedition.pim</FONT>
<BR>
Interface PIMList</H2>
<DL>
<DT><B>All Known Subinterfaces:</B>
<DD>
<A HREF="../../../javax/microedition/pim/ContactList.html">ContactList</A>, <A HREF="../../../javax/microedition/pim/EventList.html">
EventList</A>, <A HREF="../../../javax/microedition/pim/ToDoList.html">ToDoList</A></DD>
</DL>
<HR>
<DL>
<DT>public interface <B>PIMList</B></DT></DL>
<P>
Represents the common functionality of a PIM list. PIMLists contain zero or
more PIMItems (represented by the class <A HREF="../../../javax/microedition/pim/PIMItem.html">
<CODE>PIMItem</CODE></A>
. A PIMList allows retrieval of all or some of the PIMItems contained in the
list.
<P>
PIMList maintain categories and fields. Categories are logical groupings for
the PIMItems contained in the list. Each PIMList can support zero or more
categories. Categories are represented by unique String names.
</P>
<P>
Each PIMList also defines what fields are included in the items that get stored
in the list. While the definition of all possible fields reside in PIMItem,
each PIMList dictates which fields are supported for storage and retrieval in
the list's items at runtime.
<P>
<P>
<DL>
<DT><B>Since:</B>
<DD>
PIM 1.0</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff" CLASS="TableHeadingColor">
<TD COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#UNCATEGORIZED">UNCATEGORIZED</A></B></CODE>
<BR>
Constant for the <A HREF="../../../javax/microedition/pim/PIMList.html#itemsByCategory(java.lang.String)">
<CODE>itemsByCategory(java.lang.String)</CODE></A> method to indicate to
search for uncategorized items.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff" CLASS="TableHeadingColor">
<TD COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#addCategory(java.lang.String)">addCategory</A></B>(java.lang.String category)</CODE>
<BR>
Adds the provided
category to the PIM list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#close()">close</A></B>()</CODE>
<BR>
Closes the list,
releasing any resources for this list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#deleteCategory(java.lang.String, boolean)">deleteCategory</A></B>(java.lang.String category,
boolean deleteUnassignedItems)</CODE>
<BR>
Deletes the
indicated category from the PIM list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getArrayElementLabel(int, int)">getArrayElementLabel</A></B>(int stringArrayField,
int arrayElement)</CODE>
<BR>
Returns a String
label associated with the given array element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getAttributeLabel(int)">getAttributeLabel</A></B>(int attribute)</CODE>
<BR>
Returns a String
label associated with the given attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getCategories()">getCategories</A></B>()</CODE>
<BR>
Returns the
categories defined for the PIM list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getFieldDataType(int)">getFieldDataType</A></B>(int field)</CODE>
<BR>
Returns an int
representing the data type of the data associated with the given field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getFieldLabel(int)">getFieldLabel</A></B>(int field)</CODE>
<BR>
Returns a String
label associated with the given field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getName()">getName</A></B>()</CODE>
<BR>
Provides the name
of the list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getSupportedArrayElements(int)">getSupportedArrayElements</A></B>(int stringArrayField)</CODE>
<BR>
Returns an integer
array containing all of the supported elements of a string array for the given
field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getSupportedAttributes(int)">getSupportedAttributes</A></B>(int field)</CODE>
<BR>
Returns an integer
array containing all of the supported attributes for the given field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#getSupportedFields()">getSupportedFields</A></B>()</CODE>
<BR>
Gets all fields
that are supported in this list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#isCategory(java.lang.String)">isCategory</A></B>(java.lang.String category)</CODE>
<BR>
Returns indication
of whether the given category is a valid existing category for this list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedArrayElement(int, int)">isSupportedArrayElement</A></B>(int stringArrayField,
int arrayElement)</CODE>
<BR>
Indicates whether
or not the given element in a array is supported for the indicated field in
this PIM list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedAttribute(int, int)">isSupportedAttribute</A></B>(int field,
int attribute)</CODE>
<BR>
Indicates whether
or not the given attribute is supported in this PIM list for the indicated
field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedField(int)">isSupportedField</A></B>(int field)</CODE>
<BR>
Indicates whether
or not the given field is supported in this PIM list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Enumeration</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#items()">items</A></B>()</CODE>
<BR>
Return an
Enumeration of all items in the list.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Enumeration</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#items(javax.microedition.pim.PIMItem)">items</A></B>(<A HREF="../../../javax/microedition/pim/PIMItem.html">PIMItem</A> matchingItem)</CODE>
<BR>
Return an
Enumeration of all items in the list that contain fields that match all of
those fields specified in the given matching item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Enumeration</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/microedition/pim/PIMList.html#items(java.lang.String)">items</A></B>(java.lang.String matchingValue)</CODE>
<BR>
Return an
Enumeration of all items in the list that contain at least one String field
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -