dynamicuictrl.html

门户开发

<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/ibm/portal/state/RedirectURLGenerator.html" title="interface in com.ibm.portal.state"><CODE>RedirectURLGenerator</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addPortlet(com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
addPortlet</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>addPortlet</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletDefinitionID,
                           <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindowID,
                           <A HREF="../../../../com/ibm/portal/Localized.html" title="interface in com.ibm.portal">Localized</A>&nbsp;localeInformation,
                           <A HREF="../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property">PropertyValue</A>[]&nbsp;properties)
                    throws <A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></PRE>
<DL>
<DD>Adds a new portlet.
 It is only possible to add a portlet to the (dynamic) page the calling portlet is located on. 
 When the portletWindowID parameter is set, it is checked whether the portlet window referenced by this object id does exist or not.  
 If yes, the portlet window id is just returned. Otherwise, a new portlet is added and its portlet window object id returned. This method can also be used to 
 initially add a portlet to a page by passing <code> null </code> for the portletWindowID parameter.
 <p> 
 
  Note: Passed properties are also delivered in the case where an existing portlet is reused.
 
 <p>
 Focus is not set to the newly generated portlet by default. If the portlet should get focus, the portlet should generate a url to the portlet using its object id
 and set it as an redirect on the response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletDefinitionID</CODE> - The object id of the portlet definition. It is not allowed to pass <code> null </code> for this parameter.<DD><CODE>portletWindowID</CODE> - The object id of the portletWindow that should be used in case that it does exist.<DD><CODE>localeInformation</CODE> - The titles and descriptions that should be set for the new portlet. For those locales that are supported by the portlet definition but that are not part of this set, 
 the titles and descriptions of the portlet definition are used. This parameter can be <code> null </code>. If <code> null </code> is passed, the values defined for the portlet defintion are used.<DD><CODE>properties</CODE> - The properties that should be delivered to the portlet. This parameter can be <code> null </code> .
<DT><B>Returns:</B><DD>ObjectID The object id of the portlet window of the added portlet.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/ResourceLookupException.html" title="class in com.ibm.portal.dynamicui">ResourceLookupException</A></CODE> - The portlet definiton referenced by the portletDefinitionID cannot be found.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/AddUIElementException.html" title="class in com.ibm.portal.dynamicui">AddUIElementException</A></CODE> - A problem occured and the portlet could not be added to the page.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/MissingAccessRightsException.html" title="class in com.ibm.portal.dynamicui">MissingAccessRightsException</A></CODE> - The user has not sufficient access rights for the portlet definition.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/ibm/portal/state/RedirectURLGenerator.html" title="interface in com.ibm.portal.state"><CODE>RedirectURLGenerator</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addSharedPortlet(com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
addSharedPortlet</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>addSharedPortlet</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletDefinitionID,
                                 <A HREF="../../../../com/ibm/portal/Localized.html" title="interface in com.ibm.portal">Localized</A>&nbsp;localeInformation,
                                 <A HREF="../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property">PropertyValue</A>[]&nbsp;properties)
                          throws <A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></PRE>
<DL>
<DD>Adds a shared portlet. 
 It is only possible to add a shared portlet to the (dynamic) page the calling portlet is located on.
 There can be exactly one shared portlet for a portlet definition on a page.
 Therfore, it is checked whether there exists a shared portlet for the according portlet definition. 
 If yes, its object id is returned. If not, a new shared portlet is created and its object id is returned.  
 <p>
  Note: Passed properties are also delivered in the case where an existing portlet is reused.
 <p>
 Focus is not set to the newly generated portlet by default. If the portlet should get focus, the portlet should generate a url to the portlet using its object id
 and set it as an redirect on the response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletDefinitionID</CODE> - The object id of the portlet definition. It is not allowed to pass <code> null </code> for this parameter.<DD><CODE>localeInformation</CODE> - The titles and descriptions that should be set for the new portlet. For those locales that are supported by the portlet definition but that are not part of this set, 
 the titles and descriptions of the portlet definition are used. This parameter can be <code> null </code>. If <code> null </code> is passed, the values defined for the portlet defintion are used.<DD><CODE>properties</CODE> - The properties that should be delivered to the portlet. This parameter can be <code> null </code> .
<DT><B>Returns:</B><DD>ObjectID The object id of the added portlet window.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/ResourceLookupException.html" title="class in com.ibm.portal.dynamicui">ResourceLookupException</A></CODE> - The portlet definiton referenced by the portletDefinitionID cannot be found.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/AddUIElementException.html" title="class in com.ibm.portal.dynamicui">AddUIElementException</A></CODE> - A problem occured and the portlet could not be added to the page.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/MissingAccessRightsException.html" title="class in com.ibm.portal.dynamicui">MissingAccessRightsException</A></CODE> - The user has not sufficient access rights for the portlet definition.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/ibm/portal/state/RedirectURLGenerator.html" title="interface in com.ibm.portal.state"><CODE>RedirectURLGenerator</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="removePortlet(com.ibm.portal.ObjectID)"><!-- --></A><H3>
removePortlet</H3>
<PRE>
public void <B>removePortlet</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindowID)
                   throws <A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></PRE>
<DL>
<DD>Removes a portlet.
 It is only possible to remove a portlet from the page the calling portlet is located on.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletWindowID</CODE> - The object id of the portlet window that should be removed. It is not allowed to pass <code> null </code> for this parameter.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/ResourceLookupException.html" title="class in com.ibm.portal.dynamicui">ResourceLookupException</A></CODE> - The ui element referenced by the object id cannot be found.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/RemoveUIElementException.html" title="class in com.ibm.portal.dynamicui">RemoveUIElementException</A></CODE> - An error occured and the element could not be removed.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="removePage(com.ibm.portal.ObjectID)"><!-- --></A><H3>
removePage</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>removePage</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageID)
                    throws <A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></PRE>
<DL>
<DD>Removes a page.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pageID</CODE> - The id of the page that should be removed. It is not allowed to pass <code> null </code> for this parameter.
<DT><B>Returns:</B><DD>ObjectID The object id of another available page, to which the user can be redirected.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/ResourceLookupException.html" title="class in com.ibm.portal.dynamicui">ResourceLookupException</A></CODE> - The page referenced by the object id cannot be found.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/RemoveUIElementException.html" title="class in com.ibm.portal.dynamicui">RemoveUIElementException</A></CODE> - An error occured and the element could not be removed.
<DD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIManagementException.html" title="class in com.ibm.portal.dynamicui">DynamicUIManagementException</A></CODE></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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIInfo.html" title="interface in com.ibm.portal.dynamicui"><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="DynamicUICtrl.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>