Extending Categories Administration

The Categories Administration application supports adding Custom Screens to provide additional options for editing a category. To demonstrate adding a new Screen Navigation Entry and Category, you’ll add one to Categories Administration.

  1. Create a new Java class in the asset-categories-admin-web module named CategoryCustomScreenNavigationEntry that implements ScreenNavigationCategory and ScreenNavigationEntry.

  2. Add the following Component annotation above the class declaration:

        property = {
        	 service = {ScreenNavigationCategory.class, ScreenNavigationEntry.class}

    The screen.navigation.category.order and screen.navigation.entry.order determine where in the navigation the items appear. Higher is first in the navigation.

    In the service declaration, declare it as defining a ScreenNavigationCategory, ScreenNavigationEntry, or both.

  3. For the class body, insert this code:

    public String getCategoryKey() {
        return "custom-screen";
    public String getEntryKey() {
        return "custom-screen";
    public String getLabel(Locale locale) {
        return LanguageUtil.get(locale, "custom-screen");
    public String getScreenNavigationKey() {
        return AssetCategoriesConstants.CATEGORY_KEY_GENERAL;
    public void render(HttpServletRequest request, HttpServletResponse response)
        throws IOException {
             _jspRenderer.renderJSP(request, response, "/category/custom-screen.jsp");
    private JSPRenderer _jspRenderer;
  4. Create a custom-screen.jsp in the /resources/META-INF/resources/category/ folder.

  5. At the top of your JSP class, insert the following scriptlet to use the Screen Navigation UI:

    String redirect = ParamUtil.getString(request, "redirect", assetCategoriesDisplayContext.getEditCategoryRedirect());
    long categoryId = ParamUtil.getLong(request, "categoryId");
    AssetCategory category = AssetCategoryLocalServiceUtil.fetchCategory(categoryId);
    long parentCategoryId = BeanParamUtil.getLong(category, request, "parentCategoryId");
    long vocabularyId = ParamUtil.getLong(request, "vocabularyId");
    renderResponse.setTitle(((category == null) ? LanguageUtil.get(request, "add-new-category") : category.getTitle(locale)));
  6. Below that, insert the following tag:

    <liferay-frontend:screen-navigation key=
    "<%= AssetCategoriesConstants.CATEGORY_KEY_GENERAL %>"
    modelBean="<%= category %>"
    portletURL="<%= portletURL %>"
  7. For the rest of the JSP, create your custom screen.

Now you can use that pattern to create additional screens for whatever you need.

« Using Screen Navigation for Your ApplicationDeveloping a Fragment Renderer »
Was this article helpful?
0 out of 0 found this helpful