dynamicuictrl.html

门户开发

<TD><CODE><B><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUICtrl.html#addSharedPortlet(com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])">addSharedPortlet</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a shared portlet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUICtrl.html#removePage(com.ibm.portal.ObjectID)">removePage</A></B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageID)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a page.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUICtrl.html#removePortlet(com.ibm.portal.ObjectID)">removePortlet</A></B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindowID)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a portlet.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.ibm.portal.dynamicui.DynamicUIInfo"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.ibm.portal.dynamicui.<A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIInfo.html" title="interface in com.ibm.portal.dynamicui">DynamicUIInfo</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIInfo.html#isPageClosable(com.ibm.portal.ObjectID)">isPageClosable</A>, <A HREF="../../../../com/ibm/portal/dynamicui/DynamicUIInfo.html#isPortletClosable(com.ibm.portal.ObjectID)">isPortletClosable</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= 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="addPage(com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
addPage</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>addPage</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageDefinitionID,
                        <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 page that is a copy of the page definition. The layout and content of the page is defined by the page definition.
 Changes to the page definition will not influence the new page.
 <p>
 The new page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page using its object id
 and set it as an redirect on the response.
 <p>
 Note: If properties should be passed, the user must be redirected to that page at the end of this action phase. Otherwise the properties are not delivered.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pageDefinitionID</CODE> - The object id of the page 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 page. For those locales that are supported by the base page but that are not part of this set, 
 the titles and descriptions of the base page are used. This parameter can be <code> null </code>. If <code> null </code> is passed, the values defined for the page defintion are used.<DD><CODE>properties</CODE> - The properties that should be delivered to all portlets on the page. This parameter can be <code> null </code> .
<DT><B>Returns:</B><DD>ObjectID The object id of the launched page.
<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 pageDefinitionID 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 page could not be added.
<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 page 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="addPage(com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
addPage</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>addPage</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageDefinitionID,
                        <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageID,
                        <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 page that is a copy of the page definition. The layout and content of the page is defined by the page definition.
 Changes to the page definition will not influence the new page.
 <p>
 When the pageID parameter is set, it is checked whether the page referenced by this object id does exist or not.  
 If yes, the page id is just returned. Otherwise, a new page is added and its object id returned. This method can also be used to 
 initially create a page by passing <code> null </code> for the pageID parameter.
 <p> 
 Note: Passed properties are also delivered in the case where an existing page is reused.
 <p>
 Note: If properties should be passed, the user must be redirected to that page at the end of this action phase. Otherwise the properties are not delivered.
 <p>
 The new page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page 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>pageDefinitionID</CODE> - The object id of the page definition. It is not allowed to pass <code> null </code> for this parameter.<DD><CODE>pageID</CODE> - The object id of the page that should be used in case that it does exist or <code> null </code> if a new page should be added.<DD><CODE>localeInformation</CODE> - The titles and descriptions that should be set for the new page. For those locales that are supported by the base page but that are not part of this set, 
 the titles and descriptions of the base page are used. This parameter can be <code> null </code>. If <code> null </code> is passed, the values defined for the page defintion are used.<DD><CODE>properties</CODE> - The properties that should be delivered to all portlets on the launched page. This parameter can be <code> null </code> .
<DT><B>Returns:</B><DD>ObjectID The object id of the launched page.
<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 pageDefinitionID 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 page could not be added.
<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 page 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="addSharedPage(com.ibm.portal.ObjectID, com.ibm.portal.Localized, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
addSharedPage</H3>
<PRE>
public <A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A> <B>addSharedPage</B>(<A HREF="../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;pageDefinitionID,
                              <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 page that is a copy of the page definition. Within a dynamic ui management
 configuration there can be exactly one shared page for a given page definition. When there already
 exists a shared page for the passed pageDefinitionID the object id of that page is is returned. If not, a new shared page is created and its object id is returned.
 The layout and content of the page is defined by the page definition.
 Changes to the page definition will not influence the new page.
 <p> 
 Note: Passed properties are also delivered in the case where an existing page is reused.
 <p>
 Note: If properties should be passed, the user must be redirected to that page at the end of this action phase. Otherwise the properties are not delivered.
 <p>
 The new page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page 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>pageDefinitionID</CODE> - The object id of the page 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 page. For those locales that are supported by the base page but that are not part of this set, 
 the titles and descriptions of the base page are used. This parameter can be <code> null </code>. If <code> null </code> is passed, the values defined for the page defintion are used.<DD><CODE>properties</CODE> - The properties that should be delivered to all portlets on the launched page. This parameter can be <code> null </code> .
<DT><B>Returns:</B><DD>ObjectID The object id of the shared page.
<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 pageDefinitionID 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 page could not be added.
<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 page 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="addPortlet(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/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 portlet.
 It is only possible to add a portlet to the (dynamic) page the calling portlet is located on.   
 Focus is not set to the newly generated portlet by default. If the new 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 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 launched 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.