pimlist.html

J2ME手机编程规范JSR-75文档

public boolean <B>isSupportedAttribute</B>(int&nbsp;field,
                                    int&nbsp;attribute)</PRE>
<DL>
<DD>Indicates whether or not the given attribute is supported in this PIM list
 for the indicated field.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field against which the attribute is checked.<DD><CODE>attribute</CODE> - The single attribute to check
<DT><B>Returns:</B><DD>true if supported, false otherwise. Invalid fields and invalid
           attributes return false.</DL>
</DD>
</DL>
<HR>

<A NAME="getSupportedAttributes(int)"><!-- --></A><H3>
getSupportedAttributes</H3>
<PRE>
public int[] <B>getSupportedAttributes</B>(int&nbsp;field)</PRE>
<DL>
<DD>Returns an integer array containing all of the supported attributes
 for the given field.  All attributes supported by this list, including
 both standard and extended, are returned in this array. The attributes are
 provided one attribute per entry in the returned integer array.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - the field to check
<DT><B>Returns:</B><DD>an int array of the supported attributes, one
           attribute per entry in the array.  If there are no
          supported fields, a zero-length array is returned.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not a valid
           field (i.e. not a standard field and not an extended field).
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided field.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the field is not supported in
           the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="isSupportedArrayElement(int, int)"><!-- --></A><H3>
isSupportedArrayElement</H3>
<PRE>
public boolean <B>isSupportedArrayElement</B>(int&nbsp;stringArrayField,
                                       int&nbsp;arrayElement)</PRE>
<DL>
<DD>Indicates whether or not the given element in a array is supported for the
 indicated field in this PIM list.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stringArrayField</CODE> - The field which has a STRING_ARRAY data type,
           as defined by classes implementing the PIMItem interface.<DD><CODE>arrayElement</CODE> - The element in the array to check, as defined in
           the classes implementing the PIMItem interface.
<DT><B>Returns:</B><DD>true if supported in this list, false otherwise.  Invalid fields
           and invalid array elements return false.</DL>
</DD>
</DL>
<HR>

<A NAME="getSupportedArrayElements(int)"><!-- --></A><H3>
getSupportedArrayElements</H3>
<PRE>
public int[] <B>getSupportedArrayElements</B>(int&nbsp;stringArrayField)</PRE>
<DL>
<DD>Returns an integer array containing all of the supported elements of a
 string array for the given field.  The array elements are provided one
 element per entry in the returned integer array.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stringArrayField</CODE> - the field to check
<DT><B>Returns:</B><DD>an int array representing the supported array elements, one
           array element per entry in the array. If there are no
          supported array elements, a zero-length array is returned.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not a valid
           field (i.e. not a standard field and not an extended field).
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided field.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the field is not supported in
           the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldDataType(int)"><!-- --></A><H3>
getFieldDataType</H3>
<PRE>
public int <B>getFieldDataType</B>(int&nbsp;field)</PRE>
<DL>
<DD>Returns an int representing the data type of the data associated with
 the given field.  This method is useful for platform extended fields.
 <A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedField(int)"><CODE>isSupportedField(int)</CODE></A> should be used to verify the field
 validity for this item prior to invoking this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field for which the data type is being queried.
<DT><B>Returns:</B><DD>int representing the type of the data associated with the
           field.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the field is not valid
           for the implementing class.
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided field.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the field is not supported in
           the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldLabel(int)"><!-- --></A><H3>
getFieldLabel</H3>
<PRE>
public java.lang.String <B>getFieldLabel</B>(int&nbsp;field)</PRE>
<DL>
<DD>Returns a String label associated with the given field.  Field labels are
 provided by the platform and are not changeable by the application.</P><P>
 <A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedField(int)"><CODE>isSupportedField(int)</CODE></A> should be used to verify the field
 validity for this item prior to invoking this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field for which the label is being
           queried.
<DT><B>Returns:</B><DD>String label for the field. The label is locale specific
           (see the microedition.locale system property).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the field is not valid
           for the implementing class.
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided field.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the field is not supported in
           the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="getAttributeLabel(int)"><!-- --></A><H3>
getAttributeLabel</H3>
<PRE>
public java.lang.String <B>getAttributeLabel</B>(int&nbsp;attribute)</PRE>
<DL>
<DD>Returns a String label associated with the given attribute.  Attribute
 labels are provided by the platform and are not changeable by the
 application.   </P><P>
 <A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedAttribute(int, int)"><CODE>isSupportedAttribute(int, int)</CODE></A> should be used to verify the
 attribute's validity for this item prior to invoking this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - The attribute for which the label is being queried.
<DT><B>Returns:</B><DD>String label for the attribute. The label is locale specific
           (see the microedition.locale system property).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the attribute is not valid
           for the implementing class.
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided field.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the attribute is not supported in
           the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="getArrayElementLabel(int, int)"><!-- --></A><H3>
getArrayElementLabel</H3>
<PRE>
public java.lang.String <B>getArrayElementLabel</B>(int&nbsp;stringArrayField,
                                             int&nbsp;arrayElement)</PRE>
<DL>
<DD>Returns a String label associated with the given array element.  Array
 element labels are provided by the platform and are not changeable by the
 application.   </P><P>
 <A HREF="../../../javax/microedition/pim/PIMList.html#isSupportedArrayElement(int, int)"><CODE>isSupportedArrayElement(int, int)</CODE></A> should be used to verify the
 array elements's validity for this item prior to invoking this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stringArrayField</CODE> - The field which has a STRING_ARRAY data type,
           as defined by classes implementing the PIMItem interface.<DD><CODE>arrayElement</CODE> - The element in the array, as defined in
           the classes implementing the PIMItem interface.
<DT><B>Returns:</B><DD>String label for the array element. The label is locale specific
           (see the microedition.locale system property).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the array element or the field is
           not valid for the implementing class.
           IllegalArgumentException takes precedence over
           UnsupportedFieldException when checking the provided prameters.
<DD><CODE><A HREF="../../../javax/microedition/pim/UnsupportedFieldException.html">UnsupportedFieldException</A></CODE> - if the field or array element is not
           supported in the implementing instance of the class.</DL>
</DD>
</DL>
<HR>

<A NAME="maxValues(int)"><!-- --></A><H3>
maxValues</H3>
<PRE>
public int <B>maxValues</B>(int&nbsp;field)</PRE>
<DL>
<DD>Indicates the total number of data values that a particular field
 supports in this list.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field to check for multiple value support.
<DT><B>Returns:</B><DD>int indicating the number of values that can be stored in the
          field.  Additionally, -1 indicates this field
          supports having an unlimited number of added values in it, and
          0 indicates the field is not supported by this list.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the field is not valid
          for the implementing class.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Proposed Final Draft<br>Rev. 0.24</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/microedition/pim/PIMItem.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<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>  &nbsp;
&nbsp;<A HREF="PIMList.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size=-1>Copyright &copy; 2002-2003 PalmSource, Inc.  All Rights Reserved.<br>Java is a trademark of Sun Microsystems, Inc.</font>
</BODY>
</HTML>