Portlet Page Editor Tags for Adaptive Layout


This library contains the Portlet Page Editor tags for the Adaptive Layout Framework. These tags are only available on the Portlet Selection Adaptive Layout, which applies to the DHTML flyout for adding portlets to a page.

Tag Library Information
Nameportletpageeditor
Version1.0
 

Tag Summary
addportletsflyoutdataURL to add Portlet Flyout Editor on MyPages or Community pages. (The flyout editor allows users to add and remove portlets from the current page.)
collapseexpandjsAdds all javascript required to collapse or expand a portlet through Ajax.
currsortpropidSets a data value with the current portlet selection sort by property.
flyoutjsAdds all javascript required to create a flyout effect on a div.
objectrenamehelperProvides a rename div around the requested object name.
browsebreadcrumbsdataThis tag stores the breadcrumb path to the current folder in memory. Each breadcrumb data object will have the following variables: name for the breadcrumbs folder name, id for the folder ID, and url for the URL to access the folder. The current folder will not contain the URL, instead it will have the constant 'EMPTY_STRING'. This tag requires the portletbrowsemode to be displayed on the page before it.These tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.
portletbrowsemodeDisplays the javaScript required to switch to browse mode. The current community's folder can be opened directly by using -1 as the id argument.These tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.
browsesubfoldersdataStores a list of subfolders of the current folder in memory. Each subfolder data object will have the following variables: name - the name of the subfolder, description - the subfolder description, id - the subfolder ID, and url - the URL to access the folder. This list will only be populated if the page is in browse mode. This tag requires the portletbrowsemode to be displayed on the page before it.These tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.
portletdataThese tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.Generates the data required to show a list of portlets for the page editor and stores it in memory using the variable name specified by the id attribute. Each result is a DataObject with the following variables:
  • name - The name of the portlet.
  • description - The description of the portlet.
  • id - The portlet ID.
  • isonpage - True if the portlet is on the current page.
  • type - The portlet type (narrow, wide, or bundle), used as the div style class suffix and passed in to the preview javascript function.
  • previewenabled - True if preview is enabled for this portlet.
  • invitationid - The ID to be used in the invitation javascript function. Invitation is disabled if this is -1.
  • lastmodified - The last modified date of the portlet.
  • mandatory - True if the portlet is mandatory for the current page.
Use tags from the Logic library to iterate over the list and display the results.
NOTE: This tag and the sortpropertiesdata tag must be displayed before other portletpageeditor tags so the page can be initialized properly.
portletjsGenerates the javascript functions required for portlet preview and invitation. These tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.
paginationdataGenerates the data for the pagination links for the search results and stores it in memory using the variable name specified by the id attribute. The main data is stored as a DataObject with the following variables:
  • total - The total number of results.
  • numperpage - The number of results to display per page.
  • start - The first result displayed on the current page.
  • end - The last result displayed on the current page.
  • lastpage - The index of the last page.
  • previousurl - The URL to the previous page.
  • nexturl - The URL to the next page.
  • firstpageurl - The URL to the first page.
  • lastpageurl - The URL to the last page.

Additionally, the list of page links to display is stored in memory using the variable name specified by the pageslist attribute. Each result is a DataObject with the following variables:
  • number - The index of the page.
  • start - The first result displayed on the page.
  • end - The last result displayed on the page.
  • url - The URL to the page; will not be present if the page is the current page.
Use tags from the Logic tags library to iterate over the list and display the results.
portletsearchformGenerates the form and hidden inputs necessary to search for portlets. It does not generate the text input or search button. The text input must be named in_tx_query. These tags are only available on the Portlet Selection layout, which applies to the DHTML flyout for adding portlets to a page.
sortpropertiesdataSets a collection of properties used to specify sort order. Default properties include object name and last modified date in ascending and descending order. Additional order by properties are defined by adding sortpropertyentry tags in the body. NOTE: This tag and the portletdata tag must be displayed before the other portletpageeditor tags so the page can be initialized properly.
sortpropertyentrySpecifies a sort property entry for the sortpropertiesdata tag. This tag is only usable with the sortpropertiesdata tag. The order of the entries is preserved in the resulting data collection.
 


Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.