📄 portalcontext.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>PortalContext</TITLE><META NAME="keywords" CONTENT="javax.portlet.PortalContext interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="PortalContext";}</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/PortalContext.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/MimeResponse.html" title="interface in javax.portlet"><B>PREV CLASS</B></A> <A HREF="../../javax/portlet/Portlet.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/PortalContext.html" target="_top"><B>FRAMES</B></A> <A HREF="PortalContext.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | 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 PortalContext</H2><HR><DL><DT><PRE>public interface <B>PortalContext</B></DL></PRE><P>The <CODE>PortalContext</CODE> interface gives the portlet the ability to retrieve information about the portal calling this portlet. <p> The portlet can only read the <CODE>PortalContext</CODE> data.<P><P><HR><P><!-- =========== FIELD SUMMARY =========== --><A NAME="field_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>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#MARKUP_HEAD_ELEMENT_SUPPORT">MARKUP_HEAD_ELEMENT_SUPPORT</A></B></CODE><BR> Property indicating if the portal application supports the <code>MimeResponse</code> property <code>MARKUP_HEAD_ELEMENT</code>.</TD></TR></TABLE> <!-- ========== 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.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getPortalInfo()">getPortalInfo</A></B>()</CODE><BR> Returns information about the portal like vendor, version, etc.</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/PortalContext.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String name)</CODE><BR> Returns the portal property with the given name, or a <code>null</code> if there is no property by that name.</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/PortalContext.html#getPropertyNames()">getPropertyNames</A></B>()</CODE><BR> Returns all portal property names, or an empty <code>Enumeration</code> if there are no property names.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A>></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getSupportedPortletModes()">getSupportedPortletModes</A></B>()</CODE><BR> Returns all supported portlet modes by the portal as an enumeration of <code>PortletMode</code> objects.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Enumeration<<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A>></CODE></FONT></TD><TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getSupportedWindowStates()">getSupportedWindowStates</A></B>()</CODE><BR> Returns all supported window states by the portal as an enumeration of <code>WindowState</code> objects.</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"><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Field Detail</B></FONT></TH></TR></TABLE><A NAME="MARKUP_HEAD_ELEMENT_SUPPORT"><!-- --></A><H3>MARKUP_HEAD_ELEMENT_SUPPORT</H3><PRE>static final java.lang.String <B>MARKUP_HEAD_ELEMENT_SUPPORT</B></PRE><DL><DD>Property indicating if the portal application supports the <code>MimeResponse</code> property <code>MARKUP_HEAD_ELEMENT</code>. <p> A non-null value indicates that the portal application supports the <code>MARKUP_HEAD_ELEMENT</code> property. <p> The value is <code>"javax.portlet.markup.head.element.support"</code>.<P><DL><DT><B>Since:</B></DT> <DD>2.0</DD><DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortalContext.MARKUP_HEAD_ELEMENT_SUPPORT">Constant Field Values</A></DL></DL><!-- ============ 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="getProperty(java.lang.String)"><!-- --></A><H3>getProperty</H3><PRE>java.lang.String <B>getProperty</B>(java.lang.String name)</PRE><DL><DD>Returns the portal property with the given name, or a <code>null</code> if there is no property by that name.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>name</CODE> - property name<DT><B>Returns:</B><DD>portal property with key <code>name</code><DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL></DD></DL><HR><A NAME="getPropertyNames()"><!-- --></A><H3>getPropertyNames</H3><PRE>java.util.Enumeration<java.lang.String> <B>getPropertyNames</B>()</PRE><DL><DD>Returns all portal property names, or an empty <code>Enumeration</code> if there are no property names.<P><DD><DL><DT><B>Returns:</B><DD>All portal property names as an <code>Enumeration</code> of <code>String</code> objects</DL></DD></DL><HR><A NAME="getSupportedPortletModes()"><!-- --></A><H3>getSupportedPortletModes</H3><PRE>java.util.Enumeration<<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A>> <B>getSupportedPortletModes</B>()</PRE><DL><DD>Returns all supported portlet modes by the portal as an enumeration of <code>PortletMode</code> objects. <p> The portlet modes must at least include the standard portlet modes <code>EDIT, HELP, VIEW</code>.<P><DD><DL><DT><B>Returns:</B><DD>All supported portal modes by the portal as an enumeration of <code>PortletMode</code> objects.</DL></DD></DL><HR><A NAME="getSupportedWindowStates()"><!-- --></A><H3>getSupportedWindowStates</H3><PRE>java.util.Enumeration<<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A>> <B>getSupportedWindowStates</B>()</PRE><DL><DD>Returns all supported window states by the portal as an enumeration of <code>WindowState</code> objects. <p> The window states must at least include the standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.<P><DD><DL><DT><B>Returns:</B><DD>All supported window states by the portal as an enumeration of <code>WindowState</code> objects.</DL></DD></DL><HR><A NAME="getPortalInfo()"><!-- --></A><H3>getPortalInfo</H3><PRE>java.lang.String <B>getPortalInfo</B>()</PRE><DL><DD>Returns information about the portal like vendor, version, etc. <p> The form of the returned string is <I>servername/versionnumber</I>. For example, the reference implementation Pluto may return the string <CODE>Pluto/1.0</CODE>. <p> The portlet container may return other optional information after the primary string in parentheses, for example, <CODE>Pluto/1.0 (JDK 1.3.1; Windows NT 4.0 x86)</CODE>.<P><DD><DL><DT><B>Returns:</B><DD>a <CODE>String</CODE> containing at least the portal name and version number</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="../../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/PortalContext.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/MimeResponse.html" title="interface in javax.portlet"><B>PREV CLASS</B></A> <A HREF="../../javax/portlet/Portlet.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/PortalContext.html" target="_top"><B>FRAMES</B></A> <A HREF="PortalContext.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= --><HR></BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -