Component Overview
The PortletBrowser javascript component is a Fluid-based uPortal component designed to assist users in browsing their portlet registry. Examples of this component's use within uPortal include both the "add portlet" interface in the main user layout and the portlet listing table presented as the first screen in the Portlet Administration portlet.
Component Options
Subcomponents
The PortletBrowser delegates functionality to a number of uPortal-specific subcomponents. These subcomponents include the PortletRegistry, as well as three view components. These three views create the user-visible interface associated with the component; the top-level component has no associated markup and its configuration does not include any selectors. The markup for all three views is expected to be contained within the container provided during the top-level component initialization.
CategoryListView
PortletListView
SearchView
State
The PortletBrowser maintains a "state" property map capable of tracking information about the user's browsing and searching operations. These properties are visible to subcomponents and may be accessed by them, but should not be directly updated by the subcomponents themselves. Write operations to the state map are generally expected to be performed via configured event listeners.
State property |
Description |
|---|---|
currentCategory |
Currently-browsed category. May be left null or set to a blank string to match all portlets (including those not in categories). |
portletRegex |
Javascript RegExp representing the current search request, if any. May be left null to match all portlets within the currently defined category |
Listeners
Event |
Description |
Default action |
|---|---|---|
onCategorySelect |
Indicates a new category has been selected |
Update the component state with the newly selected category, then refresh the category and portlet views. |
onPortletSearch |
Indicates the portlet search term has changed |
Update the component state portlet search regex with the new search term, then refresh the portlet view. |
onPortletSelect |
Indicates a new portlet has been selected |
Update the component state with the newly selected portlet, then refresh the portlet view. |