config.html

来自「维信SDK文档。源码要求为至少5个C或Java源码」· HTML 代码 · 共 511 行 · 第 1/2 页

isVisible</H3>
<PRE>
       boolean <B>isVisible</B>()</PRE>
<DL>
<DD>Checks if this config is visible.
 Being visible means that it has at least one visible parameter.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
       int <B>size</B>()</PRE>
<DL>
<DD>Returns the number of options.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isEditable(int)"><!-- --></A><H3>
isEditable</H3>
<PRE>
       boolean <B>isEditable</B>(int&nbsp;index)</PRE>
<DL>
<DD>Checks if option at specified index is editable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>true if it is editable, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="isVisible(int)"><!-- --></A><H3>
isVisible</H3>
<PRE>
       boolean <B>isVisible</B>(int&nbsp;index)</PRE>
<DL>
<DD>Checks if option at specified index is visible. Only visible
 options are shown in settings dialogs. Invisible options can still
 be accessed from script, and they can be changed if they are editable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>true if it is visible, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getName(int)"><!-- --></A><H3>
getName</H3>
<PRE>
       <A HREF="../../widsets/api/String.html" title="class in ">String</A> <B>getName</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the name of option at specified index.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>Name of option.</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription(int)"><!-- --></A><H3>
getDescription</H3>
<PRE>
       <A HREF="../../widsets/api/String.html" title="class in ">String</A> <B>getDescription</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the description of option at specified index. Description is 
 intended to be displayed on user interface instead of name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>Description of option.</DL>
</DD>
</DL>
<HR>

<A NAME="getType(int)"><!-- --></A><H3>
getType</H3>
<PRE>
       <A HREF="../../widsets/api/String.html" title="class in ">String</A> <B>getType</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the type of option at specified index. Possible types include:
 <ul>
 <li>string
 <li>url
 <li>email
 </ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>Type of option.</DL>
</DD>
</DL>
<HR>

<A NAME="getChoices(int)"><!-- --></A><H3>
getChoices</H3>
<PRE>
       <A HREF="../../widsets/api/Value.html" title="class in ">Value</A> <B>getChoices</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the list of choices available for option at specified index.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>Value list containing optionValue=&gt;optionDescription bindings.</DL>
</DD>
</DL>
<HR>

<A NAME="getValue(String)"><!-- --></A><H3>
getValue</H3>
<PRE>
       <A HREF="../../widsets/api/Value.html" title="class in ">Value</A> <B>getValue</B>(<A HREF="../../widsets/api/String.html" title="class in ">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns the value of specified option.
 Returned valued has been parsed and it will not contain
 <code>${..}</code> expressions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of option
<DT><B>Returns:</B><DD>Value of option, or <code>null</code> if it doesn't exist.</DL>
</DD>
</DL>
<HR>

<A NAME="getValue(int)"><!-- --></A><H3>
getValue</H3>
<PRE>
       <A HREF="../../widsets/api/Value.html" title="class in ">Value</A> <B>getValue</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the value of option at specified index.
 Returned valued has been parsed and it will not contain
 <code>${..}</code> expressions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.
<DT><B>Returns:</B><DD>Value of option.</DL>
</DD>
</DL>
<HR>

<A NAME="setValue(int, Value)"><!-- --></A><H3>
setValue</H3>
<PRE>
       void <B>setValue</B>(int&nbsp;index,
                     <A HREF="../../widsets/api/Value.html" title="class in ">Value</A>&nbsp;value)</PRE>
<DL>
<DD>Sets the value of option at specified index.
 Value must be on raw (unparsed) format.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of option, must be on range <code>0 .. size()-1</code>.<DD><CODE>value</CODE> - New option value,</DL>
</DD>
</DL>
<HR>

<A NAME="parse(String)"><!-- --></A><H3>
parse</H3>
<PRE>
       <A HREF="../../widsets/api/String.html" title="class in ">String</A> <B>parse</B>(<A HREF="../../widsets/api/String.html" title="class in ">String</A>&nbsp;value)</PRE>
<DL>
<DD>Parses embedded expressions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - Value to parse
<DT><B>Returns:</B><DD>Parsed value</DL>
</DD>
</DL>
<HR>

<A NAME="commit()"><!-- --></A><H3>
commit</H3>
<PRE>
       void <B>commit</B>()</PRE>
<DL>
<DD>Saves the changes made to this config.

 In case of widget config, the changed parameters are sent to server.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../widsets/api/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>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../widsets/api/Component.html" title="class in "><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../widsets/api/FailureCallback.html" title="interface in "><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html?widsets/api/Config.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Config.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>