property.html

门户开发

<A NAME="getDefaultValue()"><!-- --></A><H3>
getDefaultValue</H3>
<PRE>
public java.lang.String <B>getDefaultValue</B>()</PRE>
<DL>
<DD>Returns a default value for the property. If no default value was
 specified, will return null.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a default value for the property.</DL>
</DD>
</DL>
<HR>

<A NAME="getOwnerId()"><!-- --></A><H3>
getOwnerId</H3>
<PRE>
public java.lang.Object <B>getOwnerId</B>()</PRE>
<DL>
<DD>Returns an <code>Object</code> whose hashcode and equals method may be used
 to identify the portlet that registered this property.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Object</code> identifying the portlet which registered this property</DL>
</DD>
</DL>
<HR>

<A NAME="isImplementedBy(org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
isImplementedBy</H3>
<PRE>
public boolean <B>isImplementedBy</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;caller)</PRE>
<DL>
<DD>Returns true if the property was registered by the calling portlet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>caller</CODE> - the <code>PortletSettings</code> object 
 representing the calling portlet.
<DT><B>Returns:</B><DD>true if the calling portlet registered this property</DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the name of the property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getName()"><CODE>getName()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setType(java.lang.String)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(java.lang.String&nbsp;type)</PRE>
<DL>
<DD>Sets the type of the property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type<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="setNamespace(java.lang.String)"><!-- --></A><H3>
setNamespace</H3>
<PRE>
public void <B>setNamespace</B>(java.lang.String&nbsp;namespace)</PRE>
<DL>
<DD>Sets the namespace of the property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespace</CODE> - the namespace<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getNamespace()"><CODE>getNamespace()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setClassname(java.lang.String)"><!-- --></A><H3>
setClassname</H3>
<PRE>
public void <B>setClassname</B>(java.lang.String&nbsp;classname)</PRE>
<DL>
<DD>Sets the name of the java class encapsulating the property value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>classname</CODE> - the name of the java class for the property value<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getClassname()"><CODE>getClassname()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDirection(int)"><!-- --></A><H3>
setDirection</H3>
<PRE>
public void <B>setDirection</B>(int&nbsp;direction)
                  throws <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Sets the direction of this property, i.e, whether it is produced or consumed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>direction</CODE> - the value of the direction attribute.
 The value must be one of <code>IN</code> or <code>OUT</code> constants defined in this class
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - is thrown if the direction specifies an invalid value.<DT><B>See Also:</B><DD><code>IN</code>, <code>OUT</code>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getDirection()"><CODE>getDirection()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
setTitle</H3>
<PRE>
public void <B>setTitle</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setTitleKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - the key for the title<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#setTitleKey(java.lang.String)"><CODE>setTitleKey(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitleKey(java.lang.String)"><!-- --></A><H3>
setTitleKey</H3>
<PRE>
public void <B>setTitleKey</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD>Sets the key used for retrieving the localized title. Used in conjunction with
 <code>setLocalizationInfo</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - the key for the title<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])"><CODE>setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setDescriptionKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - the key for the description<DT><B>See Also:</B><DD><CODE>#setDescriptionKey()</CODE>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getDescription(java.util.Locale)"><CODE>getDescription(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDescriptionKey(java.lang.String)"><!-- --></A><H3>
setDescriptionKey</H3>
<PRE>
public void <B>setDescriptionKey</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD>Sets the key used for retrieving the localized description. Used in conjunction with
 <code>setLocalizationInfo</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - the key for the description<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])"><CODE>setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])"><!-- --></A><H3>
setLocalizationInfo</H3>
<PRE>
public void <B>setLocalizationInfo</B>(java.lang.String&nbsp;nlsFileName,
                                <A HREF="../../../../../org/apache/jetspeed/portlet/PortletContext.html" title="interface in org.apache.jetspeed.portlet">PortletContext</A>&nbsp;context,
                                java.util.Locale[]&nbsp;locales)</PRE>
<DL>
<DD>This data is used to retrieve internationalized
 versions of the title and description. If the <code>Property</code> is set
 as a result of registering an <code>Action</code>, 
 the localization info for the <code>Action</code>
 will be used. This method only needs to be invoked if the <code>Property</code>
 is registered standalone, i.e, not associated with an <code>Action</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nlsFileName</CODE> - the base name of the NLS resource file(s) 
 containing the translated strings<DD><CODE>context</CODE> - the <code>PortletContext</code> 
 for the portlet this property is associated with<DD><CODE>locales</CODE> - the locales supported by this portlet<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getDescription(java.util.Locale)"><CODE>getDescription(Locale)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>
setDefaultValue</H3>
<PRE>
public void <B>setDefaultValue</B>(java.lang.String&nbsp;defaultValue)</PRE>
<DL>
<DD>Sets a default value for this property. At present, a default value may be provided
 only if the java class of the property value is <code>java.lang.String</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the default value of the property<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html#getDefaultValue()"><CODE>getDefaultValue()</CODE></A></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=3 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="../../../../../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;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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="../../../../../com/ibm/wps/pb/property/Parameter.html" title="interface in com.ibm.wps.pb.property"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property"><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="Property.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;<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>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>