📄 portletconfig.html.svn-base
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.5.0) on Wed Feb 06 17:53:06 CET 2008 --><TITLE>PortletConfig</TITLE><META NAME="keywords" CONTENT="javax.portlet.PortletConfig interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="PortletConfig";}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" 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_top_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> </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="class-use/PortletConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><B>PREV CLASS</B></A> <A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../index.html?javax/portlet/PortletConfig.html" target="_top"><B>FRAMES</B></A> <A HREF="PortletConfig.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">javax.portlet</FONT><BR>Interface PortletConfig</H2><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../javax/portlet/GenericPortlet.html" title="class in javax.portlet">GenericPortlet</A></DD></DL><HR><DL><DT><PRE>public interface <B>PortletConfig</B></DL></PRE><P>The <CODE>PortletConfig</CODE> interface provides the portlet with its configuration. The configuration holds information about the portlet that is valid for all users. The configuration is retrieved from the portlet definition in the deployment descriptor. The portlet can only read the configuration data. <p> The configuration information contains the portlet name, the portlet initialization parameters, the portlet resource bundle and the portlet application context.<P><P><DL><DT><B>See Also:</B><DD><A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet"><CODE>Portlet</CODE></A></DL><HR><P><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Map<java.lang.String,java.lang.String[]></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">getContainerRuntimeOptions</A></B>()</CODE><BR> Returns the container runtime options and values for this portlet.</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/portlet/PortletConfig.html#getDefaultNamespace()">getDefaultNamespace</A></B>()</CODE><BR> Returns the default namespace for events and public render parameters.</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/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE><BR> Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE><BR> Returns the names of the portlet initialization parameters as an <code>Enumeration</code> of String objects, or an empty <code>Enumeration</code> if the portlet has no initialization parameters.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</A></B>()</CODE><BR> Returns the <code>PortletContext</code> of the portlet application the portlet is in.</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/portlet/PortletConfig.html#getPortletName()">getPortletName</A></B>()</CODE><BR> Returns the name of the portlet.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<javax.xml.namespace.QName></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">getProcessingEventQNames</A></B>()</CODE><BR> Returns the QNames of the processing events supported by the portlet as an <code>Enumeration</code> of <code>QName</code> objects, or an empty <code>Enumeration</code> if the portlet has not defined any processing events.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPublicRenderParameterNames()">getPublicRenderParameterNames</A></B>()</CODE><BR> Returns the names of the public render parameters supported by the portlet as an <code>Enumeration</code> of <code>String</code> objects, or an empty <code>Enumeration</code> if the portlet has not defined public render parameters.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<javax.xml.namespace.QName></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">getPublishingEventQNames</A></B>()</CODE><BR> Returns the QNames of the publishing events supported by the portlet as an <code>Enumeration</code> of <code>QName</code> objects, or an empty <code>Enumeration</code> if the portlet has not defined any publishing events.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.ResourceBundle</CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></B>(java.util.Locale locale)</CODE><BR> Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with <code>resource-bundle</code> tag or the inlined resources defined in the deployment descriptor.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<java.util.Locale></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortletConfig.html#getSupportedLocales()">getSupportedLocales</A></B>()</CODE><BR> Returns the locales supported by the portlet as an <code>Enumeration</code> of <code>Locale</code> objects, or an empty <code>Enumeration</code> if the portlet has not defined any supported locales.</TD></TR></TABLE> <P><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Method Detail</B></FONT></TH></TR></TABLE><A NAME="getPortletName()"><!-- --></A><H3>getPortletName</H3><PRE>java.lang.String <B>getPortletName</B>()</PRE><DL><DD>Returns the name of the portlet. <P> The name may be provided via server administration, assigned in the portlet application deployment descriptor with the <code>portlet-name</code> tag.<P><DD><DL><DT><B>Returns:</B><DD>the portlet name</DL></DD></DL><HR><A NAME="getPortletContext()"><!-- --></A><H3>getPortletContext</H3><PRE><A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A> <B>getPortletContext</B>()</PRE><DL><DD>Returns the <code>PortletContext</code> of the portlet application the portlet is in.<P><DD><DL><DT><B>Returns:</B><DD>a <code>PortletContext</code> object, used by the caller to interact with its portlet container<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><CODE>PortletContext</CODE></A></DL></DD></DL><HR><A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3>getResourceBundle</H3><PRE>java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale locale)</PRE><DL><DD>Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with <code>resource-bundle</code> tag or the inlined resources defined in the deployment descriptor.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -