📄 property.html
字号:
<BR> Sets a default value for this property.</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="../../../../../com/ibm/wps/pb/property/Property.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String descriptionKey)</CODE><BR> <B>Deprecated.</B> <I></I> </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="../../../../../com/ibm/wps/pb/property/Property.html#setDescriptionKey(java.lang.String)">setDescriptionKey</A></B>(java.lang.String descriptionKey)</CODE><BR> Sets the key used for retrieving the localized description.</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="../../../../../com/ibm/wps/pb/property/Property.html#setDirection(int)">setDirection</A></B>(int direction)</CODE><BR> Sets the direction of this property, i.e, whether it is produced or consumed.</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="../../../../../com/ibm/wps/pb/property/Property.html#setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])">setLocalizationInfo</A></B>(java.lang.String nlsFileName, <A HREF="../../../../../org/apache/jetspeed/portlet/PortletContext.html" title="interface in org.apache.jetspeed.portlet">PortletContext</A> context, java.util.Locale[] locales)</CODE><BR> This data is used to retrieve internationalized versions of the title and description.</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="../../../../../com/ibm/wps/pb/property/Property.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE><BR> Sets the name of the property.</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="../../../../../com/ibm/wps/pb/property/Property.html#setNamespace(java.lang.String)">setNamespace</A></B>(java.lang.String namespace)</CODE><BR> Sets the namespace of the property.</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="../../../../../com/ibm/wps/pb/property/Property.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String titleKey)</CODE><BR> <B>Deprecated.</B> <I></I> </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="../../../../../com/ibm/wps/pb/property/Property.html#setTitleKey(java.lang.String)">setTitleKey</A></B>(java.lang.String titleKey)</CODE><BR> Sets the key used for retrieving the localized title.</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="../../../../../com/ibm/wps/pb/property/Property.html#setType(java.lang.String)">setType</A></B>(java.lang.String type)</CODE><BR> Sets the type of the property.</TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><A NAME="field_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD></TR></TABLE><A NAME="IN"><!-- --></A><H3>IN</H3><PRE>public static final int <B>IN</B></PRE><DL><DD>IN indicates that the portlet produces the property.<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Property.IN">Constant Field Values</A></DL></DL><HR><A NAME="OUT"><!-- --></A><H3>OUT</H3><PRE>public static final int <B>OUT</B></PRE><DL><DD>OUT indicates that the portlet consumes the property.<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Property.OUT">Constant Field Values</A></DL></DL><!-- ========= CONSTRUCTOR DETAIL ======== --><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><A NAME="getName()"><!-- --></A><H3>getName</H3><PRE>public java.lang.String <B>getName</B>()</PRE><DL><DD>Returns the name of the <code>Property</code>. Property names must be unique within a portlet instance. The name is a required field (i.e. must not be null).<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the name of the property.</DL></DD></DL><HR><A NAME="getType()"><!-- --></A><H3>getType</H3><PRE>public java.lang.String <B>getType</B>()</PRE><DL><DD>Returns a string containing the property type. This should identify the semantics of the property e.g. PhoneNo, orderID etc. This field is required. This field is used in conjunction with the namespace and attribute to determine type matches.<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the property type.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getNamespace()"><CODE>getNamespace()</CODE></A>, <A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getClassname()"><CODE>getClassname()</CODE></A></DL></DD></DL><HR><A NAME="getNamespace()"><!-- --></A><H3>getNamespace</H3><PRE>public java.lang.String <B>getNamespace</B>()</PRE><DL><DD>Returns a string containing the type namespace. A namespace may be used to group related types in a domain of types. This is optional. No namespace is indicated by the empty string. If specified, it will be used in conjunction with type to restrict matches.<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the type namespace.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getType()"><CODE>getType()</CODE></A></DL></DD></DL><HR><A NAME="getClassname()"><!-- --></A><H3>getClassname</H3><PRE>public java.lang.String <B>getClassname</B>()</PRE><DL><DD>Returns the fully qualified java class name for the property object. An instance of this will be used to encapsulate the value of the property.<P><DD><DL><DT><B>Returns:</B><DD>the fully qualified java class name for the property object.</DL></DD></DL><HR><A NAME="getDirection()"><!-- --></A><H3>getDirection</H3><PRE>public int <B>getDirection</B>()</PRE><DL><DD>Returns whether the property is produced or consumed.<P><DD><DL><DT><B>Returns:</B><DD>an <code>int</code> indicating the direction (<code>IN, OUT</code> constants defined in this class).<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#IN"><CODE>IN</CODE></A>, <A HREF="../../../../../com/ibm/wps/pb/property/Property.html#OUT"><CODE>OUT</CODE></A></DL></DD></DL><HR><A NAME="getTitle()"><!-- --></A><H3>getTitle</H3><PRE>public java.lang.String <B>getTitle</B>()</PRE><DL><DD><B>Deprecated.</B> <I></I> <P><DD>This method is deprecated. Use the locale-specific version.<P><DD><DL><DT><B>Returns:</B><DD>a short description for this property. Used by tools.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL></DD></DL><HR><A NAME="getTitle(java.util.Locale)"><!-- --></A><H3>getTitle</H3><PRE>public java.lang.String <B>getTitle</B>(java.util.Locale locale)</PRE><DL><DD>Returns a short description for this property for the provided locale. Displayed by tools as an aid to the user.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale<DT><B>Returns:</B><DD>a short description for this property for the provided locale.</DL></DD></DL><HR><A NAME="getDescription()"><!-- --></A><H3>getDescription</H3><PRE>public java.lang.String <B>getDescription</B>()</PRE><DL><DD><B>Deprecated.</B> <I></I> <P><DD>This method is deprecated. Use the locale-specific version.<P><DD><DL><DT><B>Returns:</B><DD>a text description for this property. Used by tools/help text.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getDescription(java.util.Locale)"><CODE>getDescription(Locale)</CODE></A></DL></DD></DL><HR><A NAME="getDescription(java.util.Locale)"><!-- --></A><H3>getDescription</H3><PRE>public java.lang.String <B>getDescription</B>(java.util.Locale locale)</PRE><DL><DD>Returns a text description for this property for the provided locale. Displayed by tools or help text as an aid to the user.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>locale</CODE> - the current locale<DT><B>Returns:</B><DD>a text description for this property for the provided locale.</DL></DD></DL><HR>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -