Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PortletListView

SearchView

Component 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

...

Supported Events

Event

Description

ParametersDefault

actionParameter Description

onCategorySelect

Indicates a new category has been selected

Update Fired whenever the user selects a category (or selects the null category). In the default event listener, the component state is updated with the newly selected category, then refresh after which the category and portlet views are refreshed.

that, category

that is the overall component that
category is the JSON representation of the selected category

onPortletSearch

Indicates Fired whenever the user updates the portlet search term has changed Update or submits a search request. In the default event listener, the component state portlet search regex is updated with the new portlet search term, then refresh after which the portlet view is refreshed.

that, searchTerm, submitted

that is the overall component that

onPortletSelect

Indicates a new portlet has been selected

Update the component state with the newly selected portlet, then refresh the portlet view. searchTerm is the new String-based portlet search term
submitted indicates whether this event represents a form submission (true) or simply an input field update (false)

onPortletSelect

Fired whenever the user selects a portlet. This event has no default listeners.

that, portlet

that is the overall component that
portlet is the JSON representation of the selected portlet